From: Jim Meyering Date: Tue, 14 Jul 2009 18:42:29 +0000 (+0200) Subject: doc: point to Guile's ChangeLog-writing guidelines X-Git-Tag: v7.5~57 X-Git-Url: http://git.ipfire.org/?a=commitdiff_plain;h=4612670f467d122e0a4efedcf0ce04951b4f43d8;p=thirdparty%2Fcoreutils.git doc: point to Guile's ChangeLog-writing guidelines * 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. --- diff --git a/HACKING b/HACKING index 9c9f2506ad..cfcd05d595 100644 --- 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: