diff options
Diffstat (limited to 'doc')
| -rw-r--r-- | doc/HACKING | 13 | ||||
| -rw-r--r-- | doc/Makefile.am | 20 | ||||
| -rw-r--r-- | doc/spec/control-spec.txt | 2 | ||||
| -rw-r--r-- | doc/spec/rend-spec.txt | 2 |
4 files changed, 20 insertions, 17 deletions
diff --git a/doc/HACKING b/doc/HACKING index ac68a35a08..d8538b1f2c 100644 --- a/doc/HACKING +++ b/doc/HACKING @@ -50,15 +50,16 @@ When you do a commit that needs a ChangeLog entry, add a new file to the "changes" toplevel subdirectory. It should have the format of a one-entry changelog section from the current ChangeLog file, as in - o Major bugfixes: - - Fix a potential buffer overflow. Fixes bug 9999. Bugfix on - Tor 0.3.1.4-beta. + o Major bugfixes: + - Fix a potential buffer overflow. Fixes bug 9999; bugfix on + 0.3.1.4-beta. To write a changes file, first categorize the change. Some common categories are: Minor bugfixes, Major bugfixes, Minor features, Major features, Code -simplifications and refactoring. Then say what the change does. Then, if -it's a bugfix, then mention what bug it fixes and when the bug was -introduced. +simplifications and refactoring. Then say what the change does. If +it's a bugfix, mention what bug it fixes and when the bug was +introduced. To find out which Git tag the change was introduced in, +you can use "git describe --contains <sha1 of commit>". If at all possible, try to create this file in the same commit where you are making the change. Please give it a distinctive name that no diff --git a/doc/Makefile.am b/doc/Makefile.am index 2e70fd7474..68747c8d2d 100644 --- a/doc/Makefile.am +++ b/doc/Makefile.am @@ -15,25 +15,27 @@ if USE_ASCIIDOC asciidoc_files = tor tor-gencert tor-resolve torify +html_in = $(asciidoc_files:=.html.in) +man_in = $(asciidoc_files:=.1.in) +txt_in = $(asciidoc_files:=.1.txt) +nodist_man_MANS = $(asciidoc_files:=.1) +doc_DATA = $(asciidoc_files:=.html) else asciidoc_files = +html_in = +man_in = +txt_in = +nodist_man_MANS = +doc_DATA = endif -html_in = ${asciidoc_files:=.html.in} - -man_in = ${asciidoc_files:=.1.in} - EXTRA_DIST = HACKING asciidoc-helper.sh \ - $(html_in) $(man_in) ${asciidoc_files:=.1.txt} \ + $(html_in) $(man_in) $(txt_in) \ tor-osx-dmg-creation.txt tor-rpm-creation.txt \ tor-win32-mingw-creation.txt -nodist_man_MANS = ${asciidoc_files:=.1} - docdir = @docdir@ -doc_DATA = ${asciidoc_files:=.html} - asciidoc_product = $(nodist_man_MANS) $(doc_DATA) SUBDIRS = spec diff --git a/doc/spec/control-spec.txt b/doc/spec/control-spec.txt index 5a68864b29..333b1a36a2 100644 --- a/doc/spec/control-spec.txt +++ b/doc/spec/control-spec.txt @@ -92,7 +92,7 @@ 2.4. General-use tokens - ; CRLF means, "the ASCII Carriage Return character (decimal value value 13) + ; CRLF means, "the ASCII Carriage Return character (decimal value 13) ; followed by the ASCII Linefeed character (decimal value 10)." CRLF = CR LF diff --git a/doc/spec/rend-spec.txt b/doc/spec/rend-spec.txt index d440c8a811..12e20df659 100644 --- a/doc/spec/rend-spec.txt +++ b/doc/spec/rend-spec.txt @@ -9,7 +9,7 @@ RFC 2119. Read - https://www.torproject.org/doc/design-paper/tor-design.html#sec:rendezvous + https://svn.torproject.org/svn/projects/design-paper/tor-design.html#sec:rendezvous before you read this specification. It will make more sense. Rendezvous points provide location-hidden services (server |