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

Side by Side Diff: tools/traffic_annotation/README.txt

Issue 2448133006: Tool added to extract network traffic annotations. (Closed)
Patch Set: nits Created 4 years 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 unified diff | Download patch
OLDNEW
(Empty)
1 This tool runs the clang tool for extraction of Network Traffic Annotations
2 from chromium source code and collects and summarizes its outputs.
3
4 Build:
5 ninja -C [build directory] traffic_annotation_auditor
6
7 Build on Windows:
8 Before the above command, you should open "out\[build directory]\obj\tools\
9 traffic_annotation\traffic_annotation_auditor.ninja" and remove the following
10 from it: ./protobuf_lite.dll.lib
11
12 Usage:
13 traffic_annotation_auditor [OPTION]... [path_filter]...
14 Extracts network traffic annotations from source files. If path filter(s) are
15 specified, only those directories of the source will be analyzed.
16
17 Options:
18 -h, --help Shows help.
19 --build_dir Path to the build directory from which the
20 annotations will be extracted.
21 --extractor_output_dir Path to the directory that extracted
22 partial files will be written to. Will
23 be automatically generated and deleted
24 if not specified.
25 --extracted_input_dir Path to a directory where extracted
26 partial annotations are already stored.
27 If specified, build directory will be
28 ignored.
29 --summary_file Path to an output file with summary of
30 extracted annotations.
31 Example:
32 traffic_annotation_auditor --build_dir=out/Debug
33 --summary_file=report.txt
34
35
36 To run on Windows:
37 Before running the program as above, you should build COMPLETE chromium with
38 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.
39 1. gn args [build_dir, e.g. out\Debug]
40 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.
41 3. ninja -C [build_dir] -d keeprsp -k 1000
42
43 TODO:
44 Resolve the Windows build manual step after finalizing the way full protobuf is
45 used.
Peter Kasting 2016/11/23 17:01:52 Please address this.
46
OLDNEW

Powered by Google App Engine
This is Rietveld 408576698