mirror of
https://github.com/ceph/ceph
synced 2024-12-15 16:07:00 +00:00
b6f9a9b2b1
Replace existing index.rst with the beginnings of a comprehensive developer guide. Move the old index.rst to index-old.rst. Signed-off-by: Nathan Cutler <ncutler@suse.com>
40 lines
870 B
ReStructuredText
40 lines
870 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:
|
|
|
|
*
|
|
osd_internals/index*
|
|
mds_internals/index*
|
|
radosgw/index*
|