Commit Graph

53 Commits

Author SHA1 Message Date
Kefu Chai
0cb56e0f13 doc: use plantweb as fallback of sphinx-ditaa
RTD does not support installing system packages, the only ways to install
dependencies are setuptools and pip. while ditaa is a tool written in
Java. so we need to find a native python tool allowing us to render ditaa
images. plantweb is able to the web service for rendering the ditaa
diagram. so let's use it as a fallback if "ditaa" is not around.

also start a new line after the directive, otherwise planweb server will
return 500 at seeing the diagram.

Signed-off-by: Kefu Chai <kchai@redhat.com>
2020-04-10 08:38:06 +08:00
Michael Prokop
d98b3e36a9 doc: fix typos
s/amount of times/number of times/
s/assosciated/associated/
s/availabe/available/
s/Commiting/Committing/
s/Containter/Container/
s/dependant/dependent/
s/developement/development/
s/filesytem/filesystem/
s/guarenteed/guaranteed/
s/hiearchy/hierarchy/
s/intance/instance/
s/Interger/Integer/
s/mutiple/multiple/
s/nubmer/number/
s/occured/occurred/
s/overriden/overridden/
s/reseted/reset/
s/sytem/system/
s/unkown/unknown/

Signed-off-by: Michael Prokop <mika@grml.org>
2019-09-26 09:17:07 +02:00
Sebastian Wagner
315bc1a9ee doc/rados/api/python: Add documentation for mon_command
Co-authored-by: Nathan Cutler <ncutler@suse.com>
Signed-off-by: Sebastian Wagner <sebastian.wagner@suse.com>
2019-03-18 11:55:56 +01:00
Jason Dillaman
3322798a36 doc/librados: explicitly mention that the C++ API is not stable
Signed-off-by: Jason Dillaman <dillaman@redhat.com>
2019-02-21 08:28:43 -05:00
Sage Weil
1cbca88f83 pybind/rados: drop auid arg to pool_create
Signed-off-by: Sage Weil <sage@redhat.com>
2018-08-31 09:27:36 -05:00
Bryan Stillwell
791b00daa1 doc: Multiple spelling fixes
I ran a lot of the docs through aspell and found a number of spelling problems.

Signed-off-by: Bryan Stillwell <bstillwell@godaddy.com>
2018-08-09 14:51:25 -06:00
Patrick Donnelly
a276c7097e
doc: init flags to 0 in rados example
Signed-off-by: Patrick Donnelly <pdonnell@redhat.com>
2018-03-01 07:02:00 -08:00
songweibin
dd826a4daf rbd: add missing right parenthesis and fix typo
Signed-off-by: songweibin <song.weibin@zte.com.cn>
2017-12-24 09:21:09 +08:00
Nathan Cutler
aea9fa01ae doc: globally change CRUSH ruleset to CRUSH rule
Since kraken, Ceph enforces a 1:1 correspondence between CRUSH ruleset and
CRUSH rule, so effectively ruleset and rule are the same thing, although
the term "ruleset" still survives - notably in the CRUSH rule itself, where it
effectively denotes the number of the rule.

This commit updates the documentation to more faithfully reflect the current
state of the code.

Fixes: http://tracker.ceph.com/issues/20559
Signed-off-by: Nathan Cutler <ncutler@suse.com>
2017-12-11 17:15:23 +01:00
Yao Zongyou
9eb9b8f3da doc: fix typo e.g,. => e.g.,
Signed-off-by: Yao Zongyou <yaozongyou@vip.qq.com>
2017-10-28 09:06:24 +08:00
songweibin
2897ad46c6 pybind/rados: add support open_ioctx2 API
Signed-off-by: songweibin <song.weibin@zte.com.cn>
2017-09-21 12:49:18 +08:00
Kefu Chai
5720c9854b doc/rados: fix the method names
otherwise, sphinx fails to run with py3

Signed-off-by: Kefu Chai <kchai@redhat.com>
2017-09-11 23:05:26 +08:00
Alfredo Deza
e7a3bb94fb doc/rados/api comment out '...' on ini blocks
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 11:06:49 -04:00
Alfredo Deza
c7973cb449 doc/rados/api/python document required_state manually
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:20:00 -04:00
Alfredo Deza
e32f9be219 doc/rados/api remove '*' in automethod call
Signed-off-by: Alfredo Deza <adeza@redhat.com>
2017-08-16 08:19:59 -04:00
John Wilkins
6640837da3 doc/rados: Removed contractions to improve readabilty for ESL speakers.
Signed-off-by: John Wilkins <jowilkin@redhat.com>
2017-07-27 09:46:53 -07:00
Neha Ojha
b7215b025a objclass-sdk: create SDK for Ceph object classes
Creates an installable version of "src/include/rados/objclass.h" that allows
object classes to be built outside of the Ceph tree. cls_sdk is an example
of such an object class.

Signed-off-by: Neha Ojha <nojha@redhat.com>
2017-04-27 13:05:53 -07:00
Brad Hubbard
ccdb61b349 docs: Fix problems with example code
Current code generates warnings and, in some cases, doesn't compile.

Signed-off-by: Brad Hubbard <bhubbard@redhat.com>
2017-03-17 16:12:41 +10:00
Sage Weil
93bbc1e4bd Merge pull request #9396 from songbaisen/doc2
doc: fix the librados c api can not compile problem

Reviewed-by: Sage Weil <sage@redhat.com>
2017-02-03 16:24:59 -06:00
Uday Mullangi
b0ab0f9d98 doc: Fix broken link for caps
http://tracker.ceph.com/issues/17587
Signed-off-by: Uday udaymjl@gmail.com
2016-10-19 11:39:04 +05:30
Uday Mullangi
6b78568980 Fixes: #17587
doc: Fixing the broken link which was refactored for authentication as part of other PR
Signed-off-by: uday udaymjl@gmail.com
2016-10-17 16:34:25 +05:30
Alexey Sheplyakov
5c291855ac doc: fix librados example programs
basically s/rados_wait_for_(safe|complete)/rados_aio_wait_for_\1/g

Signed-off-by: Alexey Sheplyakov <asheplyakov@mirantis.com>
2016-10-04 09:39:51 +03:00
Kefu Chai
5de4a9cef6 Merge pull request #8086 from jaemyoun/wip-doc-rados-java-api
doc: adding JAVA Example in Step 4: Closing Sessions

Reviewed-by: Kefu Chai <kchai@redhat.com>
2016-06-28 12:18:41 +08:00
Jaemyoun
319d3c8ac9 doc: add closing session in Java 2016-06-28 13:02:48 +09:00
songbaisen
750705aca6 doc: fix the librados c api can not compile problem
Signed-off-by:song baisen <song.baisen@zte.com.cn>
2016-05-30 19:32:57 +08:00
xie xingguo
01db964f4e doc: fix typo
Signed-off-by: xie xingguo <xie.xingguo@zte.com.cn>
2016-03-15 14:38:05 +08:00
Mehdi Abaakouk
67f95c8f66 Update the documentation
Signed-off-by: Mehdi Abaakouk <sileht@redhat.com>
2016-02-17 15:16:56 +01:00
x11507
d8395cfc76 modified librados-intro.rst
Signed-off-by: x11507 <xu.donghai@h3c.com>
2015-07-28 20:19:46 +08:00
Loic Dachary
90b2ccabc0 Merge pull request #5098 from PierreChaumont/master
doc: homogenize Librados (Python) documentation's code samples

Reviewed-by: Loic Dachary <ldachary@redhat.com>
2015-06-28 13:36:37 +02:00
PierreChaumont
8a221c3509 doc: homogenize Librados (Python) documentation's code samples
I put in doc/rados/api/python.rst line numbers on every code samples in
order to make them look all the same.

Fixes: #12174

Signed off: Pierre Chaumont pierre.chaumont31@gmail.com
2015-06-27 16:00:35 +02:00
JordanDorne
350139b3a7 doc: Replace requries with requires in python API doc
Fixes: #12076
Signed-off-by: Jordan DORNE <jordan.dorne@gmail.com>
2015-06-18 17:39:40 +02:00
Kefu Chai
cd69ded7af doc: Switch doxygen integration back to breathe
* asphyxiate needs more toolings, see
  https://github.com/ceph/asphyxiate/issues/1
* this commit basically reverts c96064
* use `autodoxygen` directive to doxygen referenced source files
* do not call `doxygen` explicitly in `build-doc`, `autodoxygen`
  will take care of it.

Fixes: #6115
Fixes: #6115
Signed-off-by: Kefu Chai <kchai@redhat.com>
2015-03-20 17:17:16 +08:00
Boris Ranto
46b45e3fc2 doc: fix python-ceph refs in docs
Signed-off-by: Boris Ranto <branto@redhat.com>
2015-02-24 18:30:18 -08:00
Boris Ranto
c341c52984 ceph.spec: split ceph-devel to appropriate *-devel packages
ceph-devel contains various header files/bindings for several
libraries, this patch creates *-devel packages for all the libraries
separately and provides the compatibility layer for the split.

http://tracker.ceph.com/issues/10884 Refs: #10884

Signed-off-by: Boris Ranto <branto@redhat.com>

Amended by Ken Dreyer <kdreyer@redhat.com> to add version numbers to the
Obsoletes, add Obsoletes to the libradosstriper1-devel and
libcephfs_jni1-devel subpackages, adjust the librados documentation, and
add the Redmine issue number to this commit log.

Signed-off-by: Ken Dreyer <kdreyer@redhat.com>
2015-02-16 16:21:42 -07:00
Wido den Hollander
d5e8ef5092 doc: Fix PHP librados documentation 2015-01-10 14:21:27 +01:00
Wido den Hollander
cf432fa670 doc: Add Librados PHP documentation 2015-01-09 14:16:08 +01:00
David Zafman
a03f85a8e7 osd, osdc, librados, tools, rgw: Implement pgls of all namespaces
Add release note
New librados interface
New pg_nls_response_t over the wire protocol
Ignore internal namespace (.ceph_internal)
Enhance ObjListCtx to keep independent IoCtxImpl so nspace won't change out from under listing code
Add ListObject with private implementation ListObjectImpl to return from iterator
Add EINVAL error for old librados interface when LIBRADOS_ALL_NSPACES set
Add throw to old librados c++ interface when all_nspaces set

Fixes: #9031

Signed-off-by: David Zafman <dzafman@redhat.com>
2014-10-20 10:47:50 -07:00
Kevin Dalley
0ca43d834c doc: Use write_full for C++ example
Latest version of librados uses write_full when writing entire object.

Should the documentation mention that the method "write" used to serve
this function.

Signed-off-by: Kevin Dalley <kevin@kelphead.org>
2014-06-05 16:48:21 -07:00
John Wilkins
4ef7fa9f30 Merge pull request #1731 from dynamike67/patch-2
doc: Changed the java code example
2014-05-09 10:33:33 -07:00
Michael Riederer
27ec495a00 Added Java Example 2014-04-28 09:07:54 +02:00
dynamike67
8f64b5c100 Update librados-intro.rst 2014-04-27 15:42:26 +02:00
dynamike67
998b365c3c Changed the java code example 2014-04-27 14:15:58 +02:00
John Wilkins
2682b64c51 doc: Incorporated feed back from Loic and Dan.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-02-11 13:28:33 -08:00
John Wilkins
8cb3dad548 doc: Added Python doc.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-02-07 15:49:00 -08:00
John Wilkins
22afd6ca1f doc: Added inline literal tag.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-02-07 15:48:45 -08:00
John Wilkins
aaa2799f83 doc: Adds Python to index and sets maxdepth to 2.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-02-07 15:47:40 -08:00
Dan Mick
0aa25b178d Some suggested changes, both errors and rewordings
Python and C code examples tweaked a bit

Signed-off-by: Dan Mick <dan.mick@inktank.com>
2014-02-06 16:54:47 -08:00
John Wilkins
9615645372 doc: Added python example of handle, and closing session examples.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-13 12:40:47 -08:00
John Wilkins
54e588c84b doc: Modified doc examples to use rados_create2.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-13 11:20:24 -08:00
John Wilkins
7d5674cf78 doc: Added librados introduction doc. Still wip.
Signed-off-by: John Wilkins <john.wilkins@inktank.com>
2014-01-07 17:11:29 -08:00