Chromium Code Reviews
chromiumcodereview-hr@appspot.gserviceaccount.com (chromiumcodereview-hr) | Please choose your nickname with Settings | Help | Chromium Project | Gerrit Changes | Sign out
(1026)

Unified Diff: tools/clang/traffic_annotation_extractor/README.md

Issue 2448133006: Tool added to extract network traffic annotations. (Closed)
Patch Set: nits Created 3 years, 8 months ago
Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.
Jump to:
View side-by-side diff with in-line comments
Download patch
Index: tools/clang/traffic_annotation_extractor/README.md
diff --git a/tools/clang/traffic_annotation_extractor/README.md b/tools/clang/traffic_annotation_extractor/README.md
new file mode 100644
index 0000000000000000000000000000000000000000..d2c8253db685f186cc4c389e47db7f07aa2bb761
--- /dev/null
+++ b/tools/clang/traffic_annotation_extractor/README.md
@@ -0,0 +1,27 @@
+# Traffic Annotation Extrator
+This is a clang tool to extract network traffic annotations. The tool is run by
+`tools/traffic_annotation/traffic_annotaion_auditor`. Refer to it for help on
battre 2017/04/07 08:42:27 `tools/clang/...` but please check the entire path
Ramin Halavati 2017/04/07 11:33:32 Done.
+how to use.
+
+# Build on Linux
battre 2017/04/07 08:42:27 ##
Ramin Halavati 2017/04/07 11:33:31 Done.
+`tools/clang/scripts/update.py --bootstrap --force-local-build
+ --without-android --extra-tools traffic_annotation_extractor`
battre 2017/04/07 08:42:27 Are you sure that ` ` can contain wrapped lines? D
Ramin Halavati 2017/04/07 11:33:31 Markdown viewer shows it correctly. Should it be c
+
+# Build on Window
battre 2017/04/07 08:42:27 ##
Ramin Halavati 2017/04/07 11:33:32 Done.
+1. Either open a `VS2015 x64 Native Tools Command Prompt`, or open a normal
+ command prompt and run `depot_tools\win_toolchain\vs_files\
+ $long_autocompleted_hash\win_sdk\bin\setenv.cmd /x64`
+2. Run python `tools/clang/scripts/update.py --bootstrap --force-local-build
+ --without-android --extra-tools traffic_annotation_extractor`
+
+## Usage
+Run `traffic_annotation_extractor -help` for parameters help.
battre 2017/04/07 08:42:27 isn't this --help?
Ramin Halavati 2017/04/07 11:33:32 Done.
+Extracts network traffic annotations from given file paths based on build
battre 2017/04/07 08:42:27 The executable extracts ...
Ramin Halavati 2017/04/07 11:33:32 Done.
+ parameters in build path, and writes them as separate files in output
battre 2017/04/07 08:42:27 into an output directory
Ramin Halavati 2017/04/07 11:33:32 Done.
+ directory.
+Each output file will have the following format:
+ - Line 1: File path.
+ - Line 2: Name of the function in which annotation is defined.
+ - Line 3: Line number of annotation.
+ - Line 4: Unique id of annotation.
+ - Line 5-: Serialized protobuf of the annotation.

Powered by Google App Engine
This is Rietveld 408576698