summaryrefslogtreecommitdiff
path: root/doc
diff options
context:
space:
mode:
authorNick Mathewson <nickm@torproject.org>2017-09-21 16:39:49 -0400
committerNick Mathewson <nickm@torproject.org>2017-09-21 16:39:49 -0400
commit2032d7ca6f0d082c3774c922944feb7d73c8a851 (patch)
treed5ea621716e90b839d101711417caf3c7cbff0d5 /doc
parentc3f126f7533930c848d7ab291662bb20d04cfb0a (diff)
downloadtor-2032d7ca6f0d082c3774c922944feb7d73c8a851.tar.gz
tor-2032d7ca6f0d082c3774c922944feb7d73c8a851.zip
Update CodingStandards.md for changes-file stuff
'check-changes' is now part of "make check", and must pass.
Diffstat (limited to 'doc')
-rw-r--r--doc/HACKING/CodingStandards.md9
1 files changed, 3 insertions, 6 deletions
diff --git a/doc/HACKING/CodingStandards.md b/doc/HACKING/CodingStandards.md
index 1012a4c9c9..2980b775fb 100644
--- a/doc/HACKING/CodingStandards.md
+++ b/doc/HACKING/CodingStandards.md
@@ -96,17 +96,14 @@ 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. To verify the format of the changes file,
-you can use `make check-changes`.
+you can use `make check-changes`. This is run automatically as part of
+`make check` -- if it fails, we must fix it before we release. These
+checks are implemented in `scripts/maint/lintChanges.py`.
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
then edit the draft changelog into a nice readable format.
-To make sure that stuff is in the right format, we use
-scripts/maint/lintChanges.py to check the changes files for
-(superficial) validity. You can run this script on your own changes
-files!
-
What needs a changes file?
* A not-exhaustive list: Anything that might change user-visible