Commit Graph

22 Commits

Author SHA1 Message Date
Mykola Golub
0d1e770391 mon: osd create: add optional 'id' parameter
Signed-off-by: Mykola Golub <mgolub@mirantis.com>
2015-04-12 14:25:45 +03: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
David Zafman
eb890b1bdc doc: Break ceph osd pool get into sections based on pool type
Signed-off-by: David Zafman <dzafman@redhat.com>
2015-03-22 15:28:17 -07:00
David Zafman
f4bc48d954 doc: Fix ceph command manpage to match ceph -h (hammer)
Include rebuilt man/ceph.8

Fixes: #10678

Signed-off-by: David Zafman <dzafman@redhat.com>
2015-03-13 17:00:10 -07:00
David Zafman
9495de4726 doc: Fix ceph command manpage to match ceph -h (firefly)
Improve synopsis section
Fixes: #10676

Signed-off-by: David Zafman <dzafman@redhat.com>
(cherry picked from commit 9ac488c1eb)

Conflicts:

	doc/man/8/ceph.rst
	man/ceph.8
2015-03-13 16:59:39 -07:00
David Zafman
416cbff0b4 doc: Fix typo in ceph pg dump_stuck usage in man page
Cause by 9db596974c

Signed-off-by: David Zafman <dzafman@redhat.com>
2015-03-12 14:33:52 -07:00
Kefu Chai
fffa5e201a osd,mon: add norebalance osdmap flag
Fixes: #10559

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-02-05 13:52:17 +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
xinxin shu
9db596974c fix command 'ceph pg dump_stuck degraded'
undersized not valid:  undersized not in inactive|unclean|stale
undersized not valid:  undersized doesn't represent an int
Invalid command:  unused arguments: ['undersized']
pg dump_stuck {inactive|unclean|stale [inactive|unclean|stale...]} {<int>} :  show information about stuck pgs

Signed-off-by: xinxin shu <xinxin.shu@intel.com>
2015-01-16 01:33:07 +08:00
Nilamdyuti Goswami
8b79617306 doc: Changes format style in ceph to improve readability as html.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-18 17:11:22 +05:30
Nilamdyuti Goswami
76da87a64c doc: Adds man page for ceph.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2014-12-13 02:24:41 +05:30
Loic Dachary
8d60cd1ac2 man: Ceph is also an object store
Replace

   Ceph distributed file system

with

   Ceph distributed storage system

to help reduce the idea that Ceph is just a file system.

Signed-off-by: Loic Dachary <loic@dachary.org>
2013-12-10 18:33:05 +01:00
John Wilkins
8bf858f2f2 doc: Removed mkcephfs reference.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-09 15:29:56 -07:00
Josh Durgin
97b789247a doc: update ceph man page link
It's not the wiki anymore, and the man page needed to be regenerated.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-28 16:52:48 -08:00
John Wilkins
f2c7a60c90 doc: Fixed many hyperlinks, a few typos, and some minor clarifications.
fixes: #3564

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2012-12-03 12:22:37 -08:00
Sage Weil
5a0461af57 ceph tool: update url in man page
Signed-off-by: Sage Weil <sage@inktank.com>
2012-09-28 17:38:02 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Tommi Virtanen
d745ff8d89 doc: "ceph -w" clarification.
Stop saying "watch cluster state" so many times.

Don't say stdout, that's the assumption.

Don't call showing things on terminal "printing".

Don't show -C option here.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-12-14 11:19:00 -08:00
Tommi Virtanen
60aea05423 doc: Convert manpages to doc/man/.
Includes various content cleanups: layout of synopsis, layout
of comments in examples, typos.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-09 16:26:40 -07:00
Tommi Virtanen
f1d8964499 First draft of the documentation overhaul.
To build the docs, run ./admin/build-doc. To browse them, either get
them on any static website, or just run ./admin/serve-doc to serve
them quickly off of port 8080.

build-doc sets up a virtualenv to avoid needing Sphinx installed
system-wide. serve-doc needs thttpd installed.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-08-29 17:27:14 -07:00