summaryrefslogtreecommitdiffstats
path: root/admin/manpage-howto.txt
diff options
context:
space:
mode:
authorDan Mick <dan.mick@inktank.com>2012-09-27 23:32:28 +0200
committerDan Mick <dan.mick@inktank.com>2012-09-27 23:33:04 +0200
commit3c1e2e19286f62cf792129aaab929bf0468ab60d (patch)
tree0c517bdd5ceb8a2a9dab9283f3a034b97a7da505 /admin/manpage-howto.txt
parentAdd howto for changing man pages (diff)
downloadceph-3c1e2e19286f62cf792129aaab929bf0468ab60d.tar.xz
ceph-3c1e2e19286f62cf792129aaab929bf0468ab60d.zip
manpage-howto.txt: note that man/Makefile.am may need update too
Signed-off-by: Dan Mick <dan.mick@inktank.com>
Diffstat (limited to 'admin/manpage-howto.txt')
-rw-r--r--admin/manpage-howto.txt9
1 files changed, 5 insertions, 4 deletions
diff --git a/admin/manpage-howto.txt b/admin/manpage-howto.txt
index c3bdea54ad8..db6d9ebbcb2 100644
--- a/admin/manpage-howto.txt
+++ b/admin/manpage-howto.txt
@@ -1,7 +1,8 @@
Updating the manpages is a semi-manual process:
(all paths below relative to top of git tree):
-1) make changes to the .rst files in doc/man
-2) use admin/build-doc to build the doc tree into build-doc/output
-3) copy changed manpage files from build-doc/output/man to man/
-4) commit both doc/man .rst changes and man/ changes
+1) make changes to the .rst files in doc/man.
+2) if adding or removing pages, update man/Makefile.am
+3) use admin/build-doc to build the doc tree into build-doc/output
+4) copy changed manpage files from build-doc/output/man to man/
+5) commit both doc/man .rst changes and man/ changes