RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-08 04:01:48 +00:00
Code Issues Packages Projects Releases Wiki Activity
265730aa5a
ceph/admin/manpage-howto.txt

9 lines
384 B
Plaintext
Raw Normal View History

Add howto for changing man pages Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-09-27 21:20:04 +00:00
Updating the manpages is a semi-manual process:
(all paths below relative to top of git tree):
manpage-howto.txt: note that man/Makefile.am may need update too Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-09-27 21:32:28 +00:00
1) make changes to the .rst files in doc/man.
remove autotools Signed-off-by: Sage Weil <sage@redhat.com>
2016-09-07 15:50:14 +00:00
2) if adding or removing pages, update man/CMakeLists.txt
manpage-howto.txt: note that man/Makefile.am may need update too Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-09-27 21:32:28 +00:00
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
Reference in New Issue Copy Permalink