| 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..800db060abdeb4caeb08610b92d0a4e6869acf93
|
| --- /dev/null
|
| +++ b/tools/traffic_annotation/auditor/README.md
|
| @@ -0,0 +1,23 @@
|
| +# 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.
|
| +Run `traffic_annotation_auditor --help` for options.
|
| +
|
| +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`
|
|
|