mirror of
https://github.com/ceph/ceph
synced 2024-12-26 05:25:09 +00:00
1ec47db1bd
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>
37 lines
804 B
ReStructuredText
37 lines
804 B
ReStructuredText
==================================
|
|
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.
|
|
|
|
|
|
.. _mailing-list:
|
|
|
|
.. rubric:: Mailing list
|
|
|
|
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.
|
|
|
|
|
|
.. rubric:: Contents
|
|
|
|
.. toctree::
|
|
:glob:
|
|
|
|
*
|