granicus.if.org Git - linux-pam/blob - README-hacking

   1 No more ChangeLog file
   2 ======================
   3 Do not create or modify the ChangeLog files.  Starting at 2011-10-26, the
   4 policy changed.  Before, we would insert the exact same text (or worse,
   5 sometimes slightly differing) into both the ChangeLog file and the commit
   6 log.  Now we put that information only in the commit log, and generate
   7 the ChangeLog file from logs at "make dist" time.  As such, there are
   8 strict requirements on the form of the commit log messages.
   9
  10
  11 Commit log requirements
  12 =======================
  13 Each commit log should always start with a one-line summary, the second
  14 line should be blank, and the remaining lines are usually ChangeLog-style
  15 entries for all affected files, except the leading TABs which should
  16 be omitted.  It's OK to write a few lines of prose describing the change,
  17 when the summary and ChangeLog entries don't give enough of the big picture.