Commit Graph

29 Commits

Author SHA1 Message Date
Abhishek Lekshmanan
f6db58093a doc: man: document stat, stat2 for rados cli
Signed-off-by: Abhishek Lekshmanan <abhishek@suse.com>
2017-08-31 14:14:10 +02:00
Nathan Cutler
c02d41dcdb doc: document "rados cleanup" in rados manpage
Fixes: http://tracker.ceph.com/issues/20894
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-08-03 11:08:48 +02:00
John Wilkins
ff2eebf88a doc/man: Removed contractions for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:57:23 -07:00
Jianpeng Ma
82a5e82f73 doc/rados.8: add offset option for put command.
Signed-off-by: Jianpeng Ma <jianpeng.ma@intel.com>
2017-07-06 21:55:11 +08:00
Andreas Gerstmayr
5ededbef91 doc: add rados xattr commands to manpage
Signed-off-by: Andreas Gerstmayr <andreas.gerstmayr@catalysts.cc>
2017-05-30 16:02:09 +02:00
Kefu Chai
2203a134d0 doc: update rados.8 with list-inconsistent-* commands
Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-01-06 17:34:27 +08:00
Jason Dillaman
286ceb1e03 rados: optionally support reading omap key from file
Fixes: http://tracker.ceph.com/issues/18123
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2016-12-07 09:57:16 -05:00
John Wilkins
f7a761ac22 Merge pull request #11352 from dachary/wip-17526-rados-bench
doc: document hostname constraints for rados bench

reviewed-by: John Wilkins <jowilkin@redhat.com>
2016-10-25 12:26:31 -07:00
Loic Dachary
1d7e8188b9 doc: document hostname constraints for rados bench
Fixes: http://tracker.ceph.com/issues/17526

Signed-off-by: Loic Dachary <loic@dachary.org>
2016-10-06 19:39:20 +02:00
Tomy Cheru
cb919cae34 tools/rados: Added append functionality to rados tool.
Signed-off-by: Tomy Cheru <tomy.cheru@sandisk.com>
2016-09-28 09:23:37 +05:30
Kefu Chai
4a2351eb89 doc: amend the rados.8
explain the run-name in more details.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2016-01-16 00:48:44 +08:00
Kefu Chai
3daf908ba0 Merge pull request #5900 from ritz303/wip-doc-12899
doc: Updated the rados command man page to include the --run-name opt…

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-01-16 00:45:48 +08:00
Kefu Chai
c2e391301e man: document listwatchers cmd in "rados" manpage
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-12-23 11:23:49 +08:00
ritz303
f3f4141774 doc: Updated the rados command man page to include the --run-name option under the bench sub-command
Fixes: #12899

Signed-off-by: ritz303 <ritz_303@yahoo.com>
2015-09-11 15:40:03 -05:00
Sebastien Ponce
49ab5bb3c4 rados: Added --striper option to the command line
Fixes: #10759
the new --striper option allows to use the striping API provided by libradosstriper.

Signed-off-by: Sebastien Ponce <sebastien.ponce@cern.ch>
2015-06-23 13:04:21 +02:00
Dmitry Yatsushkevich
70585a6f7b rados cli: fix documentation for -b option
Fix focumentation for block size option for rados cli

Signed-off-by: Dmitry Yatsushkevich <dyatsushkevich@mirantis.com>
2015-05-06 10:24:35 -07: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
Kevin Dalley
ab59a100ad doc: Improve man page for bench
Add information about seq and rand for bench. Also mention
--no-cleanup option.

Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-05-29 14:28:47 -07: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
Sage Weil
c693ba5732 rados: add whole-object 'clonedata' command
Clone the data stream from one object to another.

Signed-off-by: Sage Weil <sage@inktank.com>
2013-05-06 16:45:12 -07:00
Josh Durgin
91a0bc891a ceph, rados: update pool delete docs and usage
Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2013-01-28 16:52:33 -08:00
Sage Weil
1d552a4ba0 rados: fix man page
Default bench IO size if 4MB.

Fixes: 3230
Signed-off-by: Sage Weil <sage@inktank.com>
2012-09-27 14:10:51 -07:00
Sage Weil
d9e902f9c5 ceph.newdream.net -> ceph.com
wiki url -> docs url
2012-06-16 14:50:29 -07:00
Josh Durgin
a5026303f4 rados: add commands to interact with object maps
The input values are stored as-is, and any values read are dumped in
hex. Rename listomap to listomapkeys to distinguish from
listomapvalues. Also add it to the man page.

Signed-off-by: Josh Durgin <josh.durgin@inktank.com>
2012-06-09 17:24:50 -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
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