blob: d2dfdd362b353605befb1170fb0a3cb1c71ebd82 [file] [log] [blame]
Dmitry V. Levin08f922a2009-07-09 00:47:41 +00001Requirements
2============
Dmitry V. Levin82f4cc62009-07-07 22:33:41 +00003If you use the GIT version of strace there will be some files missing
Roland McGrath6d2b3492002-12-30 00:51:30 +00004that you need to build strace. These files are generated by tools from
5the GNU Autoconf and Automake packages. You need recent versions, which
6provide the `autoreconf -i' command that will do everything you need.
Dmitry V. Levin08f922a2009-07-09 00:47:41 +00007
8
9No more ChangeLog file
10======================
11Do not create or modify the ChangeLog files. Starting at 2009-07-09, the
12policy changed. Before, we would insert the exact same text (or worse,
13sometimes slightly differing) into both the ChangeLog file and the commit
14log. Now we put that information only in the commit log, and generate
15the top-level ChangeLog file from logs at "make dist" time. As such,
16there are strict requirements on the form of the commit log messages.
17
18
19Commit log requirements
20=======================
21Each commit log should always start with a one-line summary, the second
22line should be blank, and the remaining lines are usually ChangeLog-style
23entries for all affected files, except the leading TABs which should
24be omitted.
Dmitry V. Levin5700f682012-05-03 01:44:49 +000025
26
27Documentation
28=============
29All noteworthy changes should be mentioned in NEWS. All changes in strace
30command interface should be reflected in the man page. New options should
31be documented both in -h output and in the man page.