Commit Graph

14 Commits

Author SHA1 Message Date
Kefu Chai
251ae614ba doc: ref 9/ceph-mon using relative path
sphinx complains when it failed to find the referenced file using the
absolute path whose root is the $(top_srcdir)/doc/man when rendering
man pages. but it is able to find it when rendering the html, because
build-doc specifies $(top_srcdir)/doc/ as the source directory.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-04-07 23:26:50 +08: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
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
Tommi Virtanen
3671a37e5d doc: Explicitly state mount.ceph two first arguments are fixed.
I've hurt myself too many times with this.

Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-08-02 16:03:19 -07:00
Tommi Virtanen
17ad4e18d0 doc: mount.ceph is also needed for cephx.
Signed-off-by: Tommi Virtanen <tv@inktank.com>
2012-08-02 16:03:09 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Josh Durgin
739fd9fee4 man: clarify mount.ceph auth options
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-12-15 14:03:00 -08:00
Josh Durgin
4eb836546d authx -> cephx everywhere it's used
The term authx was in the mount.ceph man page, and got accidentally
copied into rbd help.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
2011-12-15 13:43:43 -08:00
Tommi Virtanen
65d2c49943 doc: Leftovers of the c* -> ceph-* rename.
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-23 15:55:00 -07:00
Sage Weil
6f8f140350 c* -> ceph-*
Hopefully I didn't miss too much...

Signed-off-by: Sage Weil <sage@newdream.net>
2011-09-22 15:08:25 -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