[tor-commits] [tor/maint-0.2.4] Fix the biggest errors in doc/HACKING
nickm at torproject.org
nickm at torproject.org
Thu Jun 13 01:28:03 UTC 2013
Author: Nick Mathewson <nickm at torproject.org>
Date: Wed Jun 12 21:27:30 2013 -0400
Fix the biggest errors in doc/HACKING
We can wait for 0.2.5 for a full rewrite. #8964
doc/HACKING | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/doc/HACKING b/doc/HACKING
index c06a682..b7cd895 100644
@@ -12,7 +12,7 @@ https://gitweb.torproject.org/torspec.git/blob_plain/HEAD:/proposals/001-process
For the latest version of the code, get a copy of git, and
- git clone git://git.torproject.org/git/tor .
+ git clone https://git.torproject.org/git/tor
We talk about Tor on the tor-talk mailing list. Design proposals and
discussion belong on the tor-dev mailing list. We hang around on
@@ -38,9 +38,9 @@ release. Occasionally, we'll merge an urgent bugfix into the release branch
before it gets merged into maint, but that's rare.
If you're working on a bugfix for a bug that occurs in a particular version,
-base your bugfix branch on the "maint" branch for the first _actively
-developed_ series that has that bug. (Right now, that's 0.2.1.) If you're
-working on a new feature, base it on the master branch.
+base your bugfix branch on the "maint" branch for the first supported series
+that has that bug. (As of June 2013, we're supporting 0.2.3 and later.) If
+you're working on a new feature, base it on the master branch.
How we log changes
@@ -51,7 +51,7 @@ 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
+ - Fix a potential buffer overflow. Fixes bug 99999; bugfix on
To write a changes file, first categorize the change. Some common categories
@@ -90,10 +90,10 @@ Useful tools
These aren't strictly necessary for hacking on Tor, but they can help track
@@ -182,6 +182,8 @@ Did you remember...
- To build your code while configured with --enable-gcc-warnings?
- To run "make check-spaces" on your code?
+ - To run "make check-docs" to see whether all new options are on
+ the manpage?
- To write unit tests, as possible?
- To base your code on the appropriate branch?
- To include a file in the "changes" directory as appropriate?
@@ -312,7 +314,7 @@ do your own profiling to determine otherwise.
No error or warning messages should be expected during normal OR or OP
More information about the tor-commits