tools/clang/traffic_annotation_extractor/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/clang/traffic_annotation_extractor/README.md

Issue 2448133006: Tool added to extract network traffic annotations. (Closed)

Patch Set: Comments addressed. 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:

OLD	NEW
(Empty)
	1 # Traffic Annotation Extrator

	2 This is a clang tool to extract network traffic annotations. The tool is run by

	3 `tools/traffic_annotation/auditor/traffic_annotaion_auditor.py`. Refer to it for

	4 help on how to use.

	5

	6 ## Build on Linux

	7 `tools/clang/scripts/update.py --bootstrap --force-local-build

	8 --without-android --extra-tools traffic_annotation_extractor`

	9

	10 ## Build on Window

	11 1. Either open a `VS2015 x64 Native Tools Command Prompt`, or open a normal

	12 command prompt and run `depot_tools\win_toolchain\vs_files\

	13 $long_autocompleted_hash\win_sdk\bin\setenv.cmd /x64`

	14 2. Run `python tools/clang/scripts/update.py --bootstrap --force-local-build

	15 --without-android --extra-tools traffic_annotation_extractor`

	16

	17 ## Usage

	18 Run `traffic_annotation_extractor --help` for parameters help.

	19 The executable extracts network traffic annotations from given file paths based

	20 on build parameters in build path, and writes them to llvm::outs.

	21 Each output will have the following format:

	22 - Line 1: File path.

	23 - Line 2: Name of the function in which annotation is defined.

	24 - Line 3: Line number of annotation.

	25 - Line 4: Unique id of annotation.

	26 - Line 5-: Serialized protobuf of the annotation.

OLD	NEW