aboutsummaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorcypherpunks <cypherpunks@torproject.org>2015-03-06 11:56:57 +0100
committerNick Mathewson <nickm@torproject.org>2015-03-09 09:00:12 -0400
commit9dc90a5b7bf02bc9a034b57bdbc1588745d00447 (patch)
tree7f5f546f02b280f40bb1a4c0adc4974787d38227 /doc
parent4ced3b59aad0fffd653869d486bb0f4b1c26b19f (diff)
downloadtor-9dc90a5b7bf02bc9a034b57bdbc1588745d00447.tar.gz
tor-9dc90a5b7bf02bc9a034b57bdbc1588745d00447.zip
Add `check-changes` rule for checking formatting of changes files.
Additional fixes to make the change work; - fix Python 2 vs 3 issues - fix some PEP 8 warnings - handle paths with numbers correctly - mention the make rule in doc/HACKING.
Diffstat (limited to 'doc')
-rw-r--r--doc/HACKING7
1 files changed, 4 insertions, 3 deletions
diff --git a/doc/HACKING b/doc/HACKING
index 5c71b74bd1..f006bb6164 100644
--- a/doc/HACKING
+++ b/doc/HACKING
@@ -61,9 +61,10 @@ 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
-other branch will use for the lifetime of your change.
+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 other branch will
+use for the lifetime of your change. To verify the format of the changes file,
+you can use "make check-changes".
When we go to make a release, we will concatenate all the entries
in changes to make a draft changelog, and clear the directory. We'll