RepoMirrors
/
ceph
mirror of https://github.com/ceph/ceph
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
ceph/doc/dev/index.rst

37 lines
804 B
ReStructuredText
Raw Normal View History

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 23:29:00 +00:00
==================================
Internal developer documentation
==================================
.. note:: If you're looking for how to use Ceph as a library from your
own software, please see :doc:`/api/index`.
You can start a development mode Ceph cluster, after compiling the source, with::
cd src
install -d -m0755 out dev/osd0
./vstart.sh -n -x -l
# check that it's there
./ceph health
.. todo:: vstart is woefully undocumented and full of sharp sticks to poke yourself with.
doc: Write about deb installation. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2011-09-02 19:31:37 +00:00
doc: fix misc typos, bad phrasing Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-03-07 04:35:33 +00:00
.. _mailing-list:
doc: Convert the mailing list mention to not be a section heading. If toctree is inside a section, the subtree is inside the section too. We don't want all of dev/* to be under "Mailing list". I have not found a decent workaround for this. The toplevel toctree avoids this purely by the fact that it is the topmost toctree. Right now that means you should 1) avoid having more than a few paragraphs of text before the toctree for that subtree (put most of the content after the toctree; clumsy if the toctree is long), or 2) put the toptree immediately after the document title, make it :hidden:, and let the reader use links in the text or the ToC in the sidebar to navigate. See start/index for an example of this. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-03-28 20:55:01 +00:00
.. rubric:: Mailing list
doc: fix misc typos, bad phrasing Signed-off-by: Sage Weil <sage.weil@dreamhost.com>
2012-03-07 04:35:33 +00:00
The official development email list is ``ceph-devel@vger.kernel.org``. Subscribe by sending
a message to ``majordomo@vger.kernel.org`` with the line::
subscribe ceph-devel
in the body of the message.
doc: Convert the mailing list mention to not be a section heading. If toctree is inside a section, the subtree is inside the section too. We don't want all of dev/* to be under "Mailing list". I have not found a decent workaround for this. The toplevel toctree avoids this purely by the fact that it is the topmost toctree. Right now that means you should 1) avoid having more than a few paragraphs of text before the toctree for that subtree (put most of the content after the toctree; clumsy if the toctree is long), or 2) put the toptree immediately after the document title, make it :hidden:, and let the reader use links in the text or the ToC in the sidebar to navigate. See start/index for an example of this. Signed-off-by: Tommi Virtanen <tommi.virtanen@dreamhost.com>
2012-03-28 20:55:01 +00:00
.. rubric:: Contents
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 19:42:56 +00:00
.. toctree::
:glob:
*