| Index: tools/traffic_annotation/auditor/README.md
|
| diff --git a/tools/traffic_annotation/auditor/README.md b/tools/traffic_annotation/auditor/README.md
|
| new file mode 100644
|
| index 0000000000000000000000000000000000000000..20605e1b51c4c0d50e916398aa45e261f7659f31
|
| --- /dev/null
|
| +++ b/tools/traffic_annotation/auditor/README.md
|
| @@ -0,0 +1,37 @@
|
| +# Network Traffic Annotation Auditor
|
| +This tool runs the clang tool for extraction of Network Traffic Annotations
|
| +from chromium source code and collects and summarizes its outputs.
|
| +
|
| +## Building
|
| +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
|
| +
|
| +
|
| +## Running 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
|
|
|