net/docs/README.txt - Issue 1859793002: Include class relationship diagrams in network stack documentation.

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

Unified Diff: net/docs/README.txt

Issue 1859793002: Include class relationship diagrams in network stack documentation. (Closed) Base URL: https://chromium.googlesource.com/chromium/src.git@master

Patch Set: Initial response to comments. Created 4 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: net/docs/README.txt

diff --git a/net/docs/README.txt b/net/docs/README.txt

new file mode 100644

index 0000000000000000000000000000000000000000..16b99a9ae297b7f8a84488a7afd1ebbe2e97eaa4

--- /dev/null

+++ b/net/docs/README.txt

@@ -0,0 +1,20 @@

+To generate the output HTML from an input markdown file on Unix

+machines, execute the command:

+ PYTHONPATH=../../third_party python -m markdown -f <output>.html <input>.md

+On Windows machines, execute:

+ set PYTHONPATH=..\..\third_party

+ python -m markdown -f <output>.html <input>.md

+(This command line assumes that the net/docs directory is the current

+directory; if that's not the case, adjust the path to src/third_party

+to be accurate from whatever directory the command is executed from.)

+The diagrams included in the network stack documentation were

+generated with Graphviz, and both source (.dot) and output (.svg) are

+included in the repository. If graphviz is installed, the output may

+be regenerated from the source via:

+ dot dot -Tsvg <name>.dot > <name>.svg

eroman 2016/04/06 17:41:17 nit: this is indented more than the other command

Randy Smith (Not in Mondays) 2016/04/06 20:57:54 Done.

« no previous file with comments | « build/gn_migration.gypi ('k') | net/docs/life-of-a-url-request.md » ('j') | net/docs/life-of-a-url-request.md » ('J')