Преглед изворни кода

Merge remote-tracking branch 'origin/maint-0.2.2'

Nick Mathewson пре 15 година
родитељ
комит
c48d6da24c
2 измењених фајлова са 40 додато и 4 уклоњено
  1. 37 0
      doc/HACKING
  2. 3 4
      src/or/config.c

+ 37 - 0
doc/HACKING

@@ -414,10 +414,47 @@ Here are the steps Roger takes when putting out a new Tor release:
 and as a directory authority. See if it has any obvious bugs, and
 and as a directory authority. See if it has any obvious bugs, and
 resolve those.
 resolve those.
 
 
+1.5) As applicable, merge the maint-X branch into the release-X branch.
+
 2) Gather the changes/* files into a changelog entry, rewriting many
 2) Gather the changes/* files into a changelog entry, rewriting many
 of them and reordering to focus on what users and funders would find
 of them and reordering to focus on what users and funders would find
 interesting and understandable.
 interesting and understandable.
 
 
+   2.1) Make sure that everything that wants a bug number has one.
+   2.2) Concatenate them.
+   2.3) Sort them by section.  Within each section, try to make the
+      first entry or two and the last entry most interesting: they're
+      the ones that skimmers tend to read.
+
+   2.4) Clean them up
+
+   Standard idioms:
+     "Fixes bug 9999; Bugfix on 0.3.3.3-alpha."
+
+   One period after a space.
+
+   Make stuff very terse
+
+   Describe the user-visible problem right away
+
+   Mention relevant config options by name.  If they're rare or unusual,
+   remind people what they're for
+
+   Avoid starting lines with open-paren
+
+   Present and imperative tense: not past.
+
+   If a given changes stanza showed up in a different release (e.g.
+   maint-0.2.1), be sure to make the stanzas identical (so people can
+   distinguish if these are the same change).
+
+   2.5) Merge them in.
+
+   2.6) Clean everything one last time.
+
+   2.7) Run it through fmt to make it pretty.
+
+
 3) Compose a short release blurb to highlight the user-facing
 3) Compose a short release blurb to highlight the user-facing
 changes. Insert said release blurb into the ChangeLog stanza. If it's
 changes. Insert said release blurb into the ChangeLog stanza. If it's
 a stable release, add it to the ReleaseNotes file too. If we're adding
 a stable release, add it to the ReleaseNotes file too. If we're adding

+ 3 - 4
src/or/config.c

@@ -3560,10 +3560,9 @@ options_validate(or_options_t *old_options, or_options_t *options,
   }
   }
 
 
   if (options->CookieAuthFileGroupReadable && !options->CookieAuthFile) {
   if (options->CookieAuthFileGroupReadable && !options->CookieAuthFile) {
-    log_warn(LD_CONFIG, "You set the CookieAuthFileGroupReadable but did "
-             "not configure a the path for the cookie file via "
-             "CookieAuthFile. This means your cookie will not be group "
-             "readable.");
+    log_warn(LD_CONFIG, "CookieAuthFileGroupReadable is set, but will have "
+             "no effect: you must specify an explicit CookieAuthFile to "
+             "have it group-readable.");
   }
   }
 
 
   if (options->UseEntryGuards && ! options->NumEntryGuards)
   if (options->UseEntryGuards && ! options->NumEntryGuards)