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

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