RepoMirrors/ceph
1
0
Fork 0
mirror of https://github.com/ceph/ceph synced 2025-01-03 09:32:43 +00:00
Code Issues Packages Projects Releases Wiki Activity
20,365 Commits 212 Branches 394 Tags 1.6 GiB
8a89d40e6b
Commit Graph

318 Commits

Author SHA1 Message Date
Sage Weil
a6c7f999d0 ceph-dencoder: man page 
Signed-off-by: Sage Weil <sage@newdream.net>
 2012-02-21 15:44:55 -08:00
Josh Durgin
c1db9009c2 Merge branch 'next' 2012-02-17 14:31:44 -08:00
Josh Durgin
304389ca0e man: move man page fixes to rst 
83cf1b62fd and
e5f49104ab updated the nroff output
but not the rst source.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-02-17 14:27:06 -08:00
Florian Haas
a446f32394 doc: fix snapshot creation/deletion syntax in rbd man page (trivial) 
Creating a snapshot requires using "rbd snap create",
as opposed to just "rbd create". Also for purposes of
clarification, add note that removing a snapshot similarly
requires "rbd snap rm".

Thanks to Josh Durgin for the explanation on IRC.

Signed-off-by: Florian Haas <florian@hastexo.com>
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-02-17 14:27:00 -08:00
Tommi Virtanen
e32668f8b8 doc: Balance backticks. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2012-02-14 15:52:55 -08:00
Greg Farnum
06ea2f7faa doc: add the ceph mds stop command. 
Signed-off-by: Greg Farnum <gregory.farnum@dreamhost.com>
 2012-02-03 13:27:26 -08:00
Greg Farnum
bd8e32d9ec doc: update control file for setting pg num on pool create 
Signed-off-by: Greg Farnum <gregory.farnum@dreamhost.com>
 2012-01-17 13:00:22 -08:00
Josh Durgin
9490b36e07 doc: add librados C aio example 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:10:11 -08:00
Josh Durgin
dd31ff2e5c doc: add short section on documenting code 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:10:10 -08:00
Tommi Virtanen
c960641666 doc: Switch doxygen integration from breathe to asphyxiate. 
TODO: path of librados.h is now just the basename

TODO: no enum support for now

TODO: no @bug support for now

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2012-01-09 19:03:56 -08:00
Josh Durgin
b5759df82c doc: add configuration and connecting to librados C api example 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:03:56 -08:00
Josh Durgin
43952a3bcf doc: add librados C api docs 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-09 19:03:56 -08:00
Sage Weil
b501efdab9 mon: document quorum_status, mon_status 
Fixes: #1824
Signed-off-by: Sage Weil <sage@newdream.net>
 2012-01-06 12:23:00 -08:00
Josh Durgin
b6c43d2aff rbd: add a command to delete all snapshots of an image 
This makes deleting images with many snapshots easier.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2012-01-05 10:19:17 -08:00
Sage Weil
2710bd8520 mon: update man page to document --mkfs stuff 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-19 14:02:10 -08:00
Sage Weil
98a4809ad2 Merge branch 'wip-osd-fsid' 2011-12-19 13:24:46 -08:00
Sage Weil
3af5fff5e1 doc: fix typo 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-19 13:24:31 -08:00
Sage Weil
dc977901c6 osd: --get-journal-fsid 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-19 08:15:08 -08:00
Sage Weil
cd909acaa4 doc: fix mon cluster expansion docs 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-19 08:04:53 -08:00
Sage Weil
3f3913c9e7 doc: fix filename in mon addition process 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-16 10:39:33 -08: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
e5a5ae12d7 man: update rule definition for ceph-rbdnamer 
This is the rule we install since 891025e539a92b5d75011e2e75c475fc0c272042.

Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2011-12-15 13:49:10 -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
1430c8abaa doc: Make overview.rst valid reStructuredText, so I can stop seeing warnings. 
It's still wrong, but now it won't clutter the output.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:38:08 -08:00
Tommi Virtanen
53f7323cdf doc: reStructuredText syntax fix. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:33:15 -08:00
Tommi Virtanen
d745ff8d89 doc: "ceph -w" clarification. 
Stop saying "watch cluster state" so many times.

Don't say stdout, that's the assumption.

Don't call showing things on terminal "printing".

Don't show -C option here.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
bc16ac3b16 doc: Fix sentence that ended too abruptly. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
f5cfdbb7a3 doc: Split intro to talk about the DFS separately. Mention petabytes. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
034dd58f77 doc: Add more missing commands to control. 
This is too unstructured, that will have to be fixed later.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
81feae12e1 doc: Add misc explanations of Ceph internals from email. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
75fd16a543 doc: Use todo directive, rescue list of missing commands from wiki. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
196d427342 doc: Link to manpage when command is mentioned. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Tommi Virtanen
b7a5a6a605 doc: More consistency on formatting placeholder names. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-14 11:19:00 -08:00
Andre Noll
fb8fd186aa doc: Clarify documentation of reweight command. 
This caused some discussions on the mailing list, so let's try to be clear
about the meaning of an OSD weight.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
 2011-12-12 14:31:10 -08:00
Andre Noll
db30716b27 doc: Add missing documentation for osd pool get. 
"osd pool set" was already documented, but the corresponding "get"
command was not. This patch adds the list of valid fields for this
command, together with short descriptions.

Thanks to Gregory Farnum for pointing out a flaw in the description
of lpl_num and lpgp_num in an earlier version of the patch.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
 2011-12-12 14:31:10 -08:00
Andre Noll
7dce3e6fe2 doc: Update the list of fields for the pool set command. 
This list was lacking a few fields: crash_replay_interval, pg_num,
pgp_num and crush_ruleset. Include these fields and add add short
descriptions.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
 2011-12-12 14:31:10 -08:00
Andre Noll
1867a74584 doc: Document pause and unpause osd commands. 
These two commands were undocumented so far. This patch adds a short
description.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
 2011-12-12 14:31:10 -08:00
Andre Noll
9aadd41b20 doc: Add documentation of missing osd commands. 
The set of OSD commands which added by the previous commit is
incomplete. This patch adds documentation for the following
OSD commands which were previously missing: dump, tree, crush,
cluster_snap, lost, create, rm.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
 2011-12-12 14:31:10 -08:00
Andre Noll
78b7a25598 doc: Import the list of ceph subcommands from wiki. 
This adds the content of the wiki page at

http://ceph.newdream.net/wiki/Monitor_commands

to doc/control.rst in order to make it available at the new official
location for the ceph documentation. This first patch is just the
result of a cut-and-paste operation. There are no changes in content,
but the text was converted to rst format.

Signed-Off-By: Andre Noll <maan@systemlinux.org>
 2011-12-12 14:31:10 -08:00
Tommi Virtanen
200d7c89a6 doc: Switch diagram tools from dia to ditaa. 
Now you can create diagrams easily with the ".. ditaa::"
directive in the Sphinx documents.

admin/build-doc now checks for debs required for building
the documentation, or just lists commands missing for hosts
not using dpkg.

For more on Ditaa, see http://ditaa.sourceforge.net/

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-12-06 12:07:59 -08:00
Sage Weil
20b7af79c6 doc: fix typo 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-06 10:50:01 -08:00
Sage Weil
9512aed5f5 doc: fix rst syntax 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-05 16:16:35 -08:00
Sage Weil
7178f1caa8 doc: document monitor cluster expansion/contraction 
Pretty sure my rst syntax is wrong.

Signed-off-by: Sage Weil <sage@newdream.net>
 2011-12-05 14:07:44 -08:00
Mark Kampe
06228716e3 Doc: add a conceptual overview of the peering process 
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-12-02 11:28:38 -08:00
Mark Kampe
813523a681 Doc: delete gratuitous index.html 
It was not an index, and seems to contain recommendations
for system configuration.  I have renamed it to confusing.txt
and will merge it in a future commit.

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-12-01 16:13:12 -08:00
Mark Kampe
48165af5c2 Doc: complete reversion of architecture.rst 
(abandon in progress improvements until everything works)

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-12-01 16:12:34 -08:00
Mark Kampe
3c7a82a6dc Doc: deleted gratuitious PlanningImplementation.html, 
which was a copy of PlanningImplementation.txt
(and not html at all).

restored previous index.rst, which was overwritten with a copy
of PlanninImplementation.txt, but removed all of the recursively
included content from the document.

I will cherry-pick merge the new contents in a subsequent commit.

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-12-01 16:12:12 -08:00
Mark Kampe
fdf3f7bd7d Doc: Restore the previous version of architecture.rst 
it was accidentally overwritten with a version of the product
had a somewhat different audience/focus and a few sphinx
formatting errors.

I will cherry-pick the corrections in a subsequent commit.

Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-12-01 16:11:05 -08:00
Mark Kampe
4cfe0815cb doc: change state model from .svg to .png 
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-12-01 16:07:41 -08:00
Steve MacGregor
1bbf9ae6b5 fixed ubuntu version typo 2011-12-01 14:41:38 -08:00
Samuel Just
1c696b6566 doc: Add peering state diagram 
Signed-off-by: Samuel Just <samuel.just@dreamhost.com>
 2011-11-29 16:35:59 -08:00
Mark Kampe
30def38d21 corrected variable (con) to be consistent with prior examples (cluster) 
Signed-off-by: Mark Kampe <mark.kampe@dreamhost.com>
 2011-11-23 15:56:52 -08:00
Sage Weil
8e150fb496 mon: add '--fsid foo' arg for setting generated monmap fsid 
Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
 2011-11-12 13:16:30 -08:00
Josh Durgin
480b8260cc rbd: add showmapped to clitests and rst man page 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2011-11-07 09:27:55 -08:00
Sondra.Menthers
ed839f5a41 fixed graphic reference and headings 2011-10-27 14:04:56 -07:00
Sondra.Menthers
2c4eb07536 fixed image reference 2011-10-27 14:00:57 -07:00
Sondra.Menthers
b42443ec71 fixed architecture document 2011-10-27 13:54:31 -07:00
Sondra.Menthers
c57ed06cf3 add images for documentation 2011-10-27 13:43:05 -07:00
Sondra.Menthers
7a02202977 rgw: handle swift PUT with incorrect etag 2011-10-27 12:51:57 -07:00
Sondra.Menthers
cae7d5a056 rgw: handle swift PUT with incorrect etag 2011-10-27 12:44:37 -07:00
Sondra.Menthers
697bba394d rgw: handle swift PUT with incorrect etag 2011-10-27 12:44:09 -07:00
Sondra.Menthers
a817a38eff rgw: handle swift PUT with incorrect etag 2011-10-27 11:20:41 -07:00
Sondra.Menthers
d9dfd14761 rgw: handle swift PUT with incorrect etag 2011-10-27 11:16:51 -07:00
Sondra.Menthers
87224c08ae rgw: handle swift PUT with incorrect etag 2011-10-27 11:02:23 -07:00
Tommi Virtanen
e6dbd7141b doc: Change diagram to have radosgw closer to direct rados access. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-10-17 16:13:14 -07:00
Sage Weil
9c9560492a mkcephfs: copy ceph.conf to /etc/ceph/ceph.conf (when -a) 
You can disable this with --no-copy-conf.

Signed-off-by: Sage Weil <sage@newdream.net>
 2011-10-17 10:49:46 -07: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
Josh Durgin
c00e06f697 doc: add documentation for librbd python bindings 
Signed-off-by: Josh Durgin <josh.durgin@dreamhost.com>
 2011-09-30 11:37:15 -07:00
Tommi Virtanen
7f301510c2 doc: Fix reStructuredText formatting warnings. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-23 15:55:01 -07:00
Tommi Virtanen
1ce18d3ae3 doc: v0.35 is out, remove rpm build workaround. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-23 15:55:01 -07:00
Tommi Virtanen
c4166492ab doc: Add index into the sidebar. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-23 15:55:01 -07:00
Tommi Virtanen
b2d46ef35a doc: Search page is always in sidebar, no need to have it on page. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-23 15:55:01 -07:00
Tommi Virtanen
8ca4c5a143 doc: Add a space after sudoers "NOPASSWD:", as that seems more common. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-23 15:55:01 -07:00
Tommi Virtanen
76fbdfb3dd doc: Add index entries, remove glossary as it's practically replaced by the index. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-23 15:55:00 -07: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
3e9a936062 doc: more c* -> ceph-* renames 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-09-22 16:18:37 -07:00
Sage Weil
fba541e4e8 libceph -> libcephfs 
Signed-off-by: Sage Weil <sage@newdream.net>
 2011-09-22 15:08:25 -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
f488908c79 doc: Content for Getting Started with cephfs and rbd. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 14:55:11 -07:00
Tommi Virtanen
69fabca63d doc: Content for Getting Started with RADOS. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
c3fae7e777 doc: Structure for Getting Started. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
47dfe29fab doc: Separate key management from mounting. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
c01d36cf5a doc: Move config reference to top-level. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
093f4f3307 doc: Split data placement into concrete operations and recommendations. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
bc9477af43 doc: Reorganize ops/manage/ 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
8648b7a55d doc: Move recommendations under /rec. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
d292aee8fb doc: Move ops/grow under ops/manage. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
9888fc6d5d doc: Split manage into multiple pages. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:04 -07:00
Tommi Virtanen
331510f308 doc: Split install into multiple pages. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:03 -07:00
Tommi Virtanen
c448c4c004 doc: Clean reStructuredText syntax. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-21 13:46:03 -07:00
Colin Patrick McCabe
cb7f5534f0 doc/dev/logs.rst: Add performance counter writeup 
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
 2011-09-16 15:43:47 -07:00
Colin Patrick McCabe
89c06e71f4 doc: Add section about changing config values 
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
 2011-09-16 15:41:13 -07:00
Tommi Virtanen
668afd7d33 doc: Typo. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-14 10:42:11 -07:00
Tommi Virtanen
2f3cfa174a doc: Instructions how to build RPMs. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-14 08:58:03 -07:00
Tommi Virtanen
b68eaf1875 doc: Say "radosgw" not "rgw". 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-14 08:42:06 -07:00
Tommi Virtanen
ecd368c230 doc: Shrinking of MDSes is not supported yet. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-14 08:42:06 -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
80f54606b4 doc: Hide TODO note in rbd.8 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-09 16:26:40 -07:00
Tommi Virtanen
3f199beeaf doc: Make rbd.8 "pool-name", like the old man page. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-09 16:26:40 -07:00
Tommi Virtanen
c25b95552b doc: Remove duplicate paragraph from rbd.8 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-09 16:26:39 -07:00
Tommi Virtanen
37c7067351 doc: Note that mkcephfs can't do upgrades etc. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-06 16:08:58 -07:00
Tommi Virtanen
ecefa8e697 doc: mkcephfs ssh's directly as root@ 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-06 15:57:17 -07:00
Tommi Virtanen
1a52cbdeb7 doc: Explicitly say ceph.conf host= must not include domain name. 
Hopefully this will work some day, but it doesn't right now.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-06 13:48:44 -07:00
Tommi Virtanen
28539ccde8 doc: Document mkcephfs-style installation. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-06 13:19:44 -07:00
Tommi Virtanen
62f3c460d6 doc: Deb install should work now. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-02 12:35:58 -07:00
Tommi Virtanen
39b0354a7d doc: Write about deb installation. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-02 12:34:05 -07:00
Tommi Virtanen
e09d4a9602 doc: Architecture, placeholder in install, and first appendix. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-01 13:28:12 -07:00
Tommi Virtanen
0a14c75b1a doc: Make object store diagram fit in 1024 pix wide browser. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-01 13:28:12 -07:00
Tommi Virtanen
66ee58f691 doc: Move internals into a new section, /dev. 
Most of the doc is user-oriented, let's isolate internals more.

Split into multiple files. Clean up RST.

Use Sphinx's graphviz plugin for graphs.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-09-01 13:28:12 -07:00
Colin Patrick McCabe
2e63eace85 Add object store architecture overview picture 
It requires graphviz / dot to be installed. It generates a nice graph
of the dependencies between classes in the object store.

Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
 2011-08-31 18:09:52 -07:00
Colin Patrick McCabe
5bcea24d69 architecture.rst: describe debug logs, cephcontext 
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
 2011-08-31 16:08:42 -07:00
Colin Patrick McCabe
4dce9fe5ea doc/architecture: describe lib arch, config arch 
Signed-off-by: Colin McCabe <colin.mccabe@dreamhost.com>
 2011-08-30 19:35:13 -07:00
Tommi Virtanen
cc1cb8da7e doc: Hide empty and broken "module index" page. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-08-30 12:47:24 -07:00
Tommi Virtanen
df0f32b73a doc: Disable static file copying, we don't use it. 
Avoids a warning from sphinx on every run.

Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-08-30 12:38:37 -07:00
Tommi Virtanen
3144fd73d9 doc: Flesh out librados API example, to show doxygen & sphinx integration. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-08-30 12:37:12 -07:00
Tommi Virtanen
c85c2f7535 doc: Adjust how table of contents is presented. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-08-30 11:26:56 -07:00
Tommi Virtanen
afede55c83 Integrate Doxygen into Sphinx docs. 
Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
 2011-08-29 17:27:14 -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