]> git.ipfire.org Git - thirdparty/coreutils.git/commitdiff
doc: point to Guile's ChangeLog-writing guidelines
authorJim Meyering <meyering@redhat.com>
Tue, 14 Jul 2009 18:42:29 +0000 (20:42 +0200)
committerJim Meyering <meyering@redhat.com>
Tue, 14 Jul 2009 18:43:49 +0000 (20:43 +0200)
* HACKING (Commit log requirements): Point to Guile's
http://www.gnu.org/software/guile/changelogs/guile-changelogs_3.html.
Mention that a bit of prose can be welcome.

HACKING

diff --git a/HACKING b/HACKING
index 9c9f2506addbdf6b80663456bffc8d16ab6d8442..cfcd05d5959cc98a170c6a0b350d728a4c5cfd9a 100644 (file)
--- a/HACKING
+++ b/HACKING
@@ -213,10 +213,15 @@ Commit log requirements
 =======================
 Your commit log should always start with a one-line summary, the second
 line should be blank, and the remaining lines are usually ChangeLog-style
-entries for all affected files.  Omit the leading TABs that you're used
-to seeing in a "real" ChangeLog file, but keep the maximum line length
-at 72 or smaller, so that the generated ChangeLog lines, each with its
-leading TAB, will not exceed 80 columns.
+entries for all affected files.  However, it's fine -- even recommended --
+to write a few lines of prose describing the change, when the summary
+and ChangeLog entries don't give enough of the big picture.  Omit the
+leading TABs that you're used to seeing in a "real" ChangeLog file, but
+keep the maximum line length at 72 or smaller, so that the generated
+ChangeLog lines, each with its leading TAB, will not exceed 80 columns.
+As for the ChangeLog-style content, please follow these guidelines:
+
+  http://www.gnu.org/software/guile/changelogs/guile-changelogs_3.html
 
 Try to make the summary line fit one of the following forms: