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..5777bc305e8c3b455c3fb63fe025c44e3b03eec6 |
| --- /dev/null |
| +++ b/tools/traffic_annotation/README.txt |
| @@ -0,0 +1,46 @@ |
| +This tool runs the clang tool for extraction of Network Traffic Annotations |
| +from chromium source code and collects and summarizes its outputs. |
| + |
| +Build: |
| +ninja -C [build directory] traffic_annotation_auditor |
| + |
| +Build on Windows: |
| +Before the above command, you should open "out\[build directory]\obj\tools\ |
| +traffic_annotation\traffic_annotation_auditor.ninja" and remove the following |
| +from it: ./protobuf_lite.dll.lib |
| + |
| +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 |
| + |
| + |
| +To run on Windows: |
| +Before running the program as above, you should build COMPLETE chromium with |
| +clang with keeprsp switch as follows: |
|
Peter Kasting
2016/11/23 17:01:52
Explain why these steps are necessary and what thi
Peter Kasting
2016/11/26 05:44:17
Still relevant.
|
| +1. gn args [build_dir, e.g. out\Debug] |
| +2. add is_clang=true to the opened text file and save and close it. |
|
Peter Kasting
2016/11/23 17:01:52
This will switch the developer's compiler to clang
Peter Kasting
2016/11/26 05:44:17
Still relevant.
|
| +3. ninja -C [build_dir] -d keeprsp -k 1000 |
| + |
| +TODO: |
| +Resolve the Windows build manual step after finalizing the way full protobuf is |
| +used. |
|
Peter Kasting
2016/11/23 17:01:52
Please address this.
|
| + |