granicus.if.org Git - strace/blob - README-hacking

   1 Requirements
   2 ============
   3 If you use the GIT version of strace, please refer to INSTALL-git.md file.
   4
   5
   6 No more ChangeLog file
   7 ======================
   8 Do not create or modify the ChangeLog files.  Starting at 2009-07-09, the
   9 policy changed.  Before, we would insert the exact same text (or worse,
  10 sometimes slightly differing) into both the ChangeLog file and the commit
  11 log.  Now we put that information only in the commit log, and generate
  12 the top-level ChangeLog file from logs at "make dist" time.  As such,
  13 there are strict requirements on the form of the commit log messages.
  14
  15
  16 Commit log requirements
  17 =======================
  18 Each commit log should always start with a one-line summary, the second
  19 line should be blank, and the remaining lines are usually ChangeLog-style
  20 entries for all affected files, except the leading TABs which should
  21 be omitted.
  22
  23
  24 Documentation
  25 =============
  26 All noteworthy changes should be mentioned in NEWS.  All changes in strace
  27 command interface should be reflected in the man page.  New options should
  28 be documented both in -h output and in the man page.