]> granicus.if.org Git - strace/commitdiff
doc: describe documentation policy
authorDmitry V. Levin <ldv@altlinux.org>
Thu, 3 May 2012 01:44:49 +0000 (01:44 +0000)
committerDmitry V. Levin <ldv@altlinux.org>
Thu, 3 May 2012 01:44:49 +0000 (01:44 +0000)
* README-hacking: Describe documentation policy.

README-hacking

index becff1323e919c785e41b2f2aad1f94dc4ab8b1b..d2dfdd362b353605befb1170fb0a3cb1c71ebd82 100644 (file)
@@ -22,3 +22,10 @@ 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.