forked from strace/strace
-
Notifications
You must be signed in to change notification settings - Fork 0
/
README-hacking
28 lines (22 loc) · 1.06 KB
/
README-hacking
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
Requirements
============
If you use the GIT version of strace, please refer to INSTALL-git.md file.
No more ChangeLog file
======================
Do not create or modify the ChangeLog files. Starting at 2009-07-09, the
policy changed. Before, we would insert the exact same text (or worse,
sometimes slightly differing) into both the ChangeLog file and the commit
log. Now we put that information only in the commit log, and generate
the top-level ChangeLog file from logs at "make dist" time. As such,
there are strict requirements on the form of the commit log messages.
Commit log requirements
=======================
Each 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, except the leading TABs which should
be omitted.
Documentation
=============
All noteworthy changes should be mentioned in NEWS. All changes in strace
command interface should be reflected in the man page. New options should
be documented both in -h output and in the man page.