Chromium Code Reviews| Index: tools/traffic_annotation/auditor/README.txt |
| diff --git a/tools/traffic_annotation/auditor/README.txt b/tools/traffic_annotation/auditor/README.txt |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..a434a07570d38e504c0a3f713afa8701ccb5367f |
| --- /dev/null |
| +++ b/tools/traffic_annotation/auditor/README.txt |
| @@ -0,0 +1,36 @@ |
| +This tool runs the clang tool for extraction of Network Traffic Annotations |
|
msramek
2017/02/21 15:57:53
The official guidance is to use markdown (README.m
Ramin Halavati
2017/02/23 12:09:49
Done.
|
| +from chromium source code and collects and summarizes its outputs. |
| + |
| +Build: |
| +ninja -C [build directory] traffic_annotation_auditor |
| + |
| +Usage: |
| +traffic_annotation_auditor [OPTION]... [path_filter]... |
| +Extracts network traffic annotations from source files. If path filter(s) are |
| +specified, only those directories of the source will be analyzed. |
| + |
| +Options: |
| + -h, --help Shows help. |
| + --build_dir Path to the build directory from which the |
| + annotations will be extracted. |
| + --extractor_output_dir Path to the directory that extracted |
| + partial files will be written to. Will |
| + be automatically generated and deleted |
| + if not specified. |
| + --extracted_input_dir Path to a directory where extracted |
| + partial annotations are already stored. |
| + If specified, build directory will be |
| + ignored. |
| + --summary_file Path to an output file with summary of |
| + extracted annotations. |
| +Example: |
| + traffic_annotation_auditor --build_dir=out/Debug |
| + --summary_file=report.txt |
|
msramek
2017/02/21 15:57:53
nit: Fits on the above line.
Ramin Halavati
2017/02/23 12:09:49
Done.
|
| + |
| + |
| +To run on Windows: |
| +Before running the program as above, you should build COMPLETE chromium with |
| +clang with keeprsp switch as follows: |
| +1. gn args [build_dir, e.g. out\Debug] |
| +2. add is_clang=true to the opened text file and save and close it. |
| +3. ninja -C [build_dir] -d keeprsp -k 1000 |