tools/traffic_annotation/auditor/README.md - Issue 2448133006: Tool added to extract network traffic annotations.

Side by Side Diff

Use n/p to move between diff chunks; N/P to move between comments. Draft comments are only viewable by you.

Keyboard Shortcuts

	File
u :	up to issue
j / k :	jump to file after / before current file
J / K :	jump to next file with a comment after / before current file
	Side-by-side diff
i :	toggle intra-line diffs
e :	expand all comments
c :	collapse all comments
s :	toggle showing all comments
n / p :	next / previous diff chunk or comment
N / P :	next / previous comment
<Up> / <Down> :	next / previous line

	Issue
u :	up to list of issues
j / k :	jump to patch after / before current patch
o / <Enter> :	open current patch in side-by-side view
i :	open current patch in unified diff view

	Issue List
j / k :	jump to issue after / before current issue
o / <Enter> :	open current issue

Side by Side Diff: tools/traffic_annotation/auditor/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 unified diff | Download patch

« tools/clang/traffic_annotation_extractor/traffic_annotation_extractor.cpp ('K') | « tools/traffic_annotation/auditor/DEPS ('k') | tools/traffic_annotation/auditor/traffic_annotation_auditor.cc » ('j') | tools/traffic_annotation/auditor/traffic_annotation_auditor.cc » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

OLD	NEW
(Empty)
	1 # Network Traffic Annotation Auditor

	2 This tool runs the clang tool for extraction of Network Traffic Annotations

	3 from chromium source code and collects and summarizes its outputs.

	4

	5 ## Building

	6 ninja -C [build directory] traffic_annotation_auditor
	battre 2017/04/07 08:42:28 `...` `...` Ramin Halavati 2017/04/07 11:33:32 On 2017/04/07 08:42:28, battre wrote: > `...` Show quoted text On 2017/04/07 08:42:28, battre wrote: > `...`
	7

	8 ## Usage

	9 traffic_annotation_auditor [OPTION]... [path_filter]...
	battre 2017/04/07 08:42:28 `...` `...` Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:28, battre wrote: > `...` Done.
	10 Extracts network traffic annotations from source files. If path filter(s) are

	11 specified, only those directories of the source will be analyzed.

	12

	13 Options:
	battre 2017/04/07 08:42:28 did you check how the following lines are rendered did you check how the following lines are rendered by markdown? should all of this go into ``` ```? Ramin Halavati 2017/04/07 11:33:32 Replaced them with a reference to --help as it was Show quoted text On 2017/04/07 08:42:28, battre wrote: > did you check how the following lines are rendered by markdown? > > should all of this go into ``` ```? Replaced them with a reference to --help as it was redundant.
	14 -h, --help Shows help.

	15 --build-dir Path to the build directory from which the

	16 annotations will be extracted.

	17 --extractor-output-dir Path to the directory that extracted

	18 partial files will be written to. Will

	19 be automatically generated and deleted

	20 if not specified.

	21 --extracted-input-dir Path to a directory where extracted

	22 partial annotations are already stored.

	23 If specified, build directory will be

	24 ignored.

	25 --summary-file Path to an output file with summary of

	26 extracted annotations.

	27 Example:

	28 traffic_annotation_auditor --build-dir=out/Debug --summary-file=report.txt

	29

	30

	31 ## Running on Windows

	32 Before running the program as above, you should build COMPLETE chromium with

	33 clang with keeprsp switch as follows:

	34 1. gn args [build_dir, e.g. out\Debug]
	battre 2017/04/07 08:42:28 here and in the following ` ` here and in the following ` ` Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:28, battre wrote: > here and in the following ` ` Done.
	35 2. add is_clang=true to the opened text file and save and close it.

	36 3. ninja -C [build_dir] -d keeprsp -k 1000

OLD	NEW