Commit Graph

19 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
Nilamdyuti Goswami
e62ff4dbf6 doc: Updates radosgw-admin man page.
Signed-off-by: Nilamdyuti Goswami <ngoswami@redhat.com>
2015-03-23 16:39:18 +05:30
Loic Dachary
1798803292 Merge pull request #3455 from bveuille/wip-documentation
doc: Change Availability text in all of the man pages

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-01-26 12:42:32 +01:00
Yuan Zhou
9ad9ba8d10 doc: Fix a typo in radosgw-admin doc
Signed-off-by: Yuan Zhou <yuan.zhou@intel.com>
2015-01-22 13:31:47 +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
Dan Mick
96e365be85 radosgw-admin manpage: Fix broken quotes
Signed-off-by: Dan Mick <dan.mick@inktank.com>
2012-10-15 18:18:49 -07:00
caleb miles
b15d639264 radosgw-admin.rst: Misc doccumentation update.
Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-09 13:27:28 -07:00
caleb miles
45f7f0602c rgw_admin.cc: Allow removal of a user's buckets during user removal.
Allow the buckets, and any child objects, of a user to be deleted when the
user is deleted through radosgw-admin. In reference to feature request
2499: http://tracker.newdream.net/issues/2499.

Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-09 13:27:21 -07:00
caleb miles
cc8eac2427 rgw_admin.cc: Allow for deletion of objects through radosgw-admin.
Allow objects to be deleted through radosgw-admin with an optional flag
to delete the tail of that object during the processing of the intent log.

Signed-off-by: caleb miles <caleb.miles@inktank.com>
2012-08-09 09:55:27 -07:00
Florian Haas
88e31546bb radosgw-admin: improve man page
* remove "OpenStack user" information (deprecated, should no
  longer be used. No reason to keep mentioning it)
* fix description of --uid
* mention subusers
* add key management commands

Signed-off-by: Florian Haas <florian@hastexo.com>
2012-06-26 08:39:22 +02:00
Yehuda Sadeh
58db045a2c docs: clarify example in radosgw-admin
Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-06-21 11:35:13 -07:00
Yehuda Sadeh
62a4ad66d1 docs: update usage logging info
added some text under radosgw, examples under radosgw-admin

Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-06-21 10:47:44 -07:00
Yehuda Sadeh
b84e1ed5f2 doc: document usage log
Modify radosgw, radosgw-admin man page

Signed-off-by: Yehuda Sadeh <yehuda@inktank.com>
2012-06-19 15:17:53 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Florian Haas
753207c3f2 doc: update examples in radosgw-admin man page
* "user gen" is gone and is now "user create"
* --uid option is mandatory for "user create"

Mailing list thread: http://www.spinics.net/lists/ceph-devel/msg06744.html

Signed-off-by: Florian Haas <florian@hastexo.com>
2012-06-11 23:49:11 +02:00
Sage Weil
6103ee9e88 more radosgw_admin -> radosgw-admin
Signed-off-by: Sage Weil <sage@newdream.net>
2011-10-03 11:25:44 -07:00