summaryrefslogtreecommitdiff
path: root/README-hacking
diff options
context:
space:
mode:
authorDmitry V. Levin <ldv@altlinux.org>2012-05-03 01:44:49 +0000
committerDmitry V. Levin <ldv@altlinux.org>2012-05-03 01:44:49 +0000
commit5700f68471ef83aae4757bb84280e3fcc6e20692 (patch)
tree2f207e9a237966ae2e91a1a7ddd604eaaac04826 /README-hacking
parent503faaae3a6b6e05022c26b76f5c867e5623f1a7 (diff)
downloadstrace-5700f68471ef83aae4757bb84280e3fcc6e20692.tar.gz
strace-5700f68471ef83aae4757bb84280e3fcc6e20692.tar.bz2
strace-5700f68471ef83aae4757bb84280e3fcc6e20692.tar.xz
doc: describe documentation policy
* README-hacking: Describe documentation policy.
Diffstat (limited to 'README-hacking')
-rw-r--r--README-hacking7
1 files changed, 7 insertions, 0 deletions
diff --git a/README-hacking b/README-hacking
index becff13..d2dfdd3 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.