Commit Graph

18 Commits

Author SHA1 Message Date
Sage Weil
8dcaacbb05 man/8/ceph-disk: fix formatting issue
ERROR: /srv/autobuild-ceph/gitbuilder.git/build/doc/man/8/ceph-disk.rst:39: Unexpected indentation.
WARNING: /srv/autobuild-ceph/gitbuilder.git/build/doc/man/8/ceph-disk.rst:40: Block quote ends without a blank line; unexpected unindent.

Signed-off-by: Sage Weil <sage@redhat.com>
2016-03-09 12:30:23 -05:00
Loic Dachary
d355a383d1 doc: update ceph-disk to refer to ceph-disk --help
The ceph-disk page is often obsolete, mostly because maintaining
it requires a significant amount of copy/paste and re-formatting.
Now that the --help of ceph-disk has been updated to include a more
verbose explanation of each subcommand, simplify the man page to
give an overview of the subcommands and suggest the --help is used
to get more information.

Signed-off-by: Loic Dachary <loic@dachary.org>
2016-03-04 09:13:35 +07:00
Mike Shuey
4e3ce25697 Add better documentation of --setuser and --setgroup options for ceph-disk.
Signed-off-by: Mike Shuey <shuey@purdue.edu>
2016-02-10 09:36:40 -05:00
Mike Shuey
17fe9d229c Add --setuser and --setgroup options to ceph-disk(8).
Signed-off-by: Mike Shuey <shuey@purdue.edu>
2016-02-10 09:30:08 -05:00
Vicente Cheng
1633d3e17a doc: Update ceph-disk manual page to remove some option description.
- remove `--mark-init` and `--activate-key` from options because
    they are not options that are common to all subcommands.

Signed-off-by: Vicente Cheng <freeze.bilsted@gmail.com>
2015-11-19 09:34:51 +08:00
Vicente Cheng
d3d139b496 doc: Update ceph-disk manual page with new feature deactivate/destroy.
- Update the ceph-disk manual page

Signed-off-by: Vicente Cheng <freeze.bilsted@gmail.com>
2015-11-19 09:33:21 +08:00
Kazhord
3cb8c4e8ef doc: Replaced "disk or drive" by "disk" in ceph-disk.rs
Fixes: #12062
Signed-off-by: Gabriel SENTUCQ <perso@kazhord.fr>
2015-06-18 15:47:26 +02:00
Loic Dachary
8ee5a82832 ceph-disk: implement activate --no-start-daemon
And improve the --mark-init documentation as well.

Signed-off-by: Loic Dachary <ldachary@redhat.com>
2015-05-06 01:54:36 +02:00
Kefu Chai
a0bdf6932b doc: add ":orphan:" field to avoid sphinx warnings
when building man pages from rst files, sphinx complains if any
rst file is not referenced by a doctree.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:50 +08:00
Kefu Chai
0e07ccc197 man: move man/8/*.rst back to doc/man/8
sphinx requires that a document tree to be in a single directory,
and the man pages are references by our document. so a simple solution
would be to put all the rst file under a single directory.

Fixes: #11320
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:49 +08:00
Kefu Chai
301fe6cbf2 doc: generate man pages in man/Makefile
* move rst files from doc/man/8 into man/8
* extract man_pages setting for sphinx from doc/conf.py to man/conf.py
* generate all man pages in `make install`
* add python-sphinx to Build-Depends
* check for sphinx-build in `configure`
* run changed rst files through sphinx-build in `make check`

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-24 12:36:41 +08:00
Baptiste Veuillez
008698b37c doc: Change Availability text in all of the man pages
http://tracker.ceph.com/issues/5834 fixes:#5834
signed-off-by: Baptiste Veuillez--Mainard <baptiste.veuillez--mainard@telecom-bretagne.eu>
2015-01-22 03:16:35 +01:00
Nilamdyuti Goswami
62b3fcdd24 doc: Updates man page for ceph-disk with suggested changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 16:48:50 +05:30
Nilamdyuti Goswami
3f6be22f64 doc: Updates man page for ceph-disk.
Changes format style to improve readability as html.

Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 16:31:35 +05:30
Nilamdyuti Goswami
8a48847cd4 doc: Updates the man page for ceph-disk utility with some changes.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-26 22:19:01 +05:30
Nilamdyuti Goswami
242dd1c0bb doc: Removes ceph-deploy usage instances from ceph-disk man page.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-25 21:16:16 +05:30
Nilamdyuti Goswami
7dcc85042b doc: Updates man page for ceph-disk utility.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-25 02:06:39 +05:30
Nilamdyuti Goswami
a450cab2b8 doc: Adds man page for ceph-disk utility.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-11-24 22:05:11 +05:30