From: Dmitry V. Levin <ldv@altlinux.org>
Date: Thu, 3 May 2012 01:44:49 +0000 (+0000)
Subject: doc: describe documentation policy
X-Git-Tag: v4.8~235
X-Git-Url: https://granicus.if.org/sourcecode?a=commitdiff_plain;h=5700f68471ef83aae4757bb84280e3fcc6e20692;p=strace

doc: describe documentation policy

* README-hacking: Describe documentation policy.
---

diff --git a/README-hacking b/README-hacking
index becff132..d2dfdd36 100644
--- a/README-hacking
+++ b/README-hacking
@@ -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.