summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorDan Mick <dan.mick@inktank.com>2012-09-27 14:20:04 -0700
committerDan Mick <dan.mick@inktank.com>2012-09-27 14:20:04 -0700
commiteb27f9addb2279387ada67d95bd4726b18f8c935 (patch)
tree3b9fdd2dd569bd5397d509c819ba946485d45268
parentd37ca798bed5d8458000737c442ec45cdac91988 (diff)
downloadceph-eb27f9addb2279387ada67d95bd4726b18f8c935.tar.gz
Add howto for changing man pages
Signed-off-by: Dan Mick <dan.mick@inktank.com>
-rw-r--r--admin/manpage-howto.txt7
1 files changed, 7 insertions, 0 deletions
diff --git a/admin/manpage-howto.txt b/admin/manpage-howto.txt
new file mode 100644
index 00000000000..c3bdea54ad8
--- /dev/null
+++ b/admin/manpage-howto.txt
@@ -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