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

Side by Side 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:

« third_party/protobuf/BUILD.gn ('K') | « tools/clang/traffic_annotation_extractor/CMakeLists.txt ('k') | tools/clang/traffic_annotation_extractor/tests/expected_outputs/______components_autofill_core_browser_autofill_download_manager_cc(36).txt » ('j') | tools/clang/traffic_annotation_extractor/tests/inputs/autofill_download_manager.cc » ('J')
Toggle Intra-line Diffs ('i') | Expand Comments ('e') | Collapse Comments ('c') | Hide Comments ('s')

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/traffic_annotaion_auditor`. Refer to it for help on
	battre 2017/04/07 08:42:27 `tools/clang/...` but please check the entire path `tools/clang/...` but please check the entire path. Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:27, battre wrote: > `tools/clang/...` but please check the entire path. Done.
	4 how to use.

	5

	6 # Build on Linux
	battre 2017/04/07 08:42:27 ## ## Ramin Halavati 2017/04/07 11:33:31 Done. Show quoted text On 2017/04/07 08:42:27, battre wrote: > ## Done.
	7 `tools/clang/scripts/update.py --bootstrap --force-local-build

	8 --without-android --extra-tools traffic_annotation_extractor`
	battre 2017/04/07 08:42:27 Are you sure that ` ` can contain wrapped lines? D Are you sure that ` ` can contain wrapped lines? Do you need ```...```? add a \ at the end of the line wrapping for bash compliance? Ramin Halavati 2017/04/07 11:33:31 Markdown viewer shows it correctly. Should it be c Show quoted text On 2017/04/07 08:42:27, battre wrote: > Are you sure that ` ` can contain wrapped lines? Do you need ```...```? > > add a \ at the end of the line wrapping for bash compliance? Markdown viewer shows it correctly. Should it be changed?
	9

	10 # Build on Window
	battre 2017/04/07 08:42:27 ## ## Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:27, battre wrote: > ## Done.
	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.
	battre 2017/04/07 08:42:27 isn't this --help? isn't this --help? Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:27, battre wrote: > isn't this --help? Done.
	19 Extracts network traffic annotations from given file paths based on build
	battre 2017/04/07 08:42:27 The executable extracts ... The executable extracts ... Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:27, battre wrote: > The executable extracts ... Done.
	20 parameters in build path, and writes them as separate files in output
	battre 2017/04/07 08:42:27 into an output directory into an output directory Ramin Halavati 2017/04/07 11:33:32 Done. Show quoted text On 2017/04/07 08:42:27, battre wrote: > into an output directory Done.
	21 directory.

	22 Each output file will have the following format:

	23 - Line 1: File path.

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

	25 - Line 3: Line number of annotation.

	26 - Line 4: Unique id of annotation.

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

OLD	NEW