Chromium Code Reviews| Index: tools/traffic_annotation/README.txt |
| diff --git a/tools/traffic_annotation/README.txt b/tools/traffic_annotation/README.txt |
| new file mode 100644 |
| index 0000000000000000000000000000000000000000..43a4d875415c08279ebb9b06c007013d2f1b5e43 |
| --- /dev/null |
| +++ b/tools/traffic_annotation/README.txt |
| @@ -0,0 +1,28 @@ |
| +This tool runs the clang tool for extraction of Network Traffic Annotations |
| +from chromium source code and collects and summarizes it's outputs. |
|
battre
2016/10/27 11:49:06
s/it's/its/
Ramin Halavati
2016/10/27 12:51:20
Done.
|
| + |
| +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 this. |
| + --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 ouput file with summary of |
| + extracted annotations. |
| +Example: |
| + traffic_annotation_auditor --build_dir=out/Debug |
| + --summery_file=report.txt |
|
battre
2016/10/27 11:49:06
--summary_file
Ramin Halavati
2016/10/27 12:51:20
Done, also done in program's help text.
|