]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev/crimson: update index 60510/head
authorMatan Breizman <mbreizma@redhat.com>
Sun, 27 Oct 2024 16:32:58 +0000 (16:32 +0000)
committerZac Dover <zac.dover@proton.me>
Tue, 29 Oct 2024 02:05:00 +0000 (12:05 +1000)
Signed-off-by: Matan Breizman <mbreizma@redhat.com>
doc/dev/crimson/backfillmachine.rst
doc/dev/crimson/index.rst
doc/dev/crimson/osd.rst

index c42bb32bbfab3441cc67e2a181cfc28c58d21c8c..3f579621ad4790b6e8473cb88989c6380292426b 100644 (file)
@@ -3,7 +3,7 @@ BackfillMachine
 ===============
 
 
-In Crimson, Backfill is implemented with `Boost State Chart <https://www.boost.org/doc/libs/1_86_0/libs/statechart/doc/>`_.
+In Crimson, backfill is implemented with `Boost State Chart <https://www.boost.org/doc/libs/1_86_0/libs/statechart/doc/>`_.
 
 .. //TODO: Once the implementation is settled:
 ..         * Explain exceptional states once we finish working on this code
@@ -14,8 +14,10 @@ A sample of the recent state model:
 
 .. note:: ``Cancelled`` and ``Crushed`` states are not included in the
           following graph in order to make it easier to follow:
-            * **Any** state is able to transit into ``Crushed``.
-            * **Any** state (except from ``Initial`` and ``Waiting``) can transit into ``Cancelled``
+
+          * **Any** state is able to transit into ``Crushed``.
+
+          * **Any** state (except from ``Initial`` and ``Waiting``) can transit into ``Cancelled``
 
 .. image:: crimson_backfillmachine.svg
 
index 9790a9640c2e62abbcb2254a4f7fd282dbac8b2b..53864350bd7695ac0ac1be527de20bd9704c4e7b 100644 (file)
@@ -7,7 +7,11 @@ Crimson developer documentation
 .. rubric:: Contents
 
 .. toctree::
-   :glob:
-
-   *
+   :maxdepth: 1
 
+   Crimson <crimson>
+   OSDState <osd>
+   The ClientRequest Pipeline <pipeline>
+   Error Handling <error-handling>
+   BackfillMachine <backfillmachine>
+   PoseidonStore <poseidonstore>
index f7f132b3f9dba8bd380d8fb8a58ddb2de0469f22..4e78f648f451ebbb7a0fa8eef7f6beec3a03edb9 100644 (file)
@@ -1,5 +1,5 @@
-osd
-===
+OSDState
+========
 
 .. graphviz::