Commit Graph

15 Commits

Author SHA1 Message Date
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
Vartika Rai
8471f927c8 doc: Fixes spelling and grammatical errors
Signed-off-by: Vartika Rai <vartikarai17@gmail.com>
2015-03-24 02:11:34 +05:30
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
Dmitry Smirnov
f22e2e9a02 spelling corrections 2014-04-17 12:43:30 +10:00
Loic Dachary
efbdd16380 doc: update the crushtool manual page
* add information about CEPH_ARGS
* rework the --build documentation and example
* add an Author section
* replace vi with emacs for no good reason
* cleanup whitespace

Signed-off-by: Loic Dachary <loic@dachary.org>
2014-01-12 18:06:06 +01:00
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
Loic Dachary
472f495e40 crush: document the --test mode of operations
Signed-off-by: Loic Dachary <loic@dachary.org>
2013-12-09 21:10:23 +01:00
John Wilkins
874186bacc doc: Updated the usage scenario and made a few syntax edits.
fixes: #6308

Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-09-16 18:38:55 -07: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
John Wilkins
3dd9574bbf doc: Usage requires --num_osds.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2013-04-22 21:03:15 -07:00
caleb miles
5ac52de003 crushtool: Miscellaneous cleanup.
Clean up the output messages; add some function documentation and some
unit tests.

Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-31 13:20:30 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07: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