]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
Add howto for changing man pages
authorDan Mick <dan.mick@inktank.com>
Thu, 27 Sep 2012 21:20:04 +0000 (14:20 -0700)
committerDan Mick <dan.mick@inktank.com>
Thu, 27 Sep 2012 21:20:04 +0000 (14:20 -0700)
Signed-off-by: Dan Mick <dan.mick@inktank.com>
admin/manpage-howto.txt [new file with mode: 0644]

diff --git a/admin/manpage-howto.txt b/admin/manpage-howto.txt
new file mode 100644 (file)
index 0000000..c3bdea5
--- /dev/null
@@ -0,0 +1,7 @@
+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