Documentation: Fix compilation error.

ovs_submodule documentation had some issues: * Indentation was seen as inconsistent by the rst parser. * The document was not in any toctree. * The document was not listed in the Makefile. Signed-off-by: Mark Michelson <mmichels@redhat.com>
ovn-org · Feb 25, 2022 · bc9bd2f · bc9bd2f
1 parent b988d5f
commit bc9bd2f
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 9 deletions.
diff --git a/Documentation/automake.mk b/Documentation/automake.mk
@@ -49,6 +49,7 @@ DOC_SOURCE = \
 	Documentation/internals/documentation.rst \
 	Documentation/internals/mailing-lists.rst \
 	Documentation/internals/maintainers.rst \
+	Documentation/internals/ovs_submodule.rst \
 	Documentation/internals/patchwork.rst \
 	Documentation/internals/release-process.rst \
 	Documentation/internals/security.rst \

diff --git a/Documentation/internals/index.rst b/Documentation/internals/index.rst
@@ -45,3 +45,4 @@ itself and how they might involved.
    authors
    maintainers
    documentation
+   ovs_submodule
diff --git a/Documentation/internals/ovs_submodule.rst b/Documentation/internals/ovs_submodule.rst
@@ -64,15 +64,17 @@ submodule to the next stable branch of OVS at a later time.
 As an example, let's assume that the OVS commit history looks something like
 this in the main branch:
 
-(Newest)
-Commit 3
-   |
-   |
-Commit 2 (used to create OVS branch-Y)
-   |
-   |
-Commit 1
-(Oldest)
+::
+
+    (Newest)
+    Commit 3
+       |
+       |
+    Commit 2 (used to create OVS branch-Y)
+       |
+       |
+    Commit 1
+    (Oldest)
 
 Let's say that we are planning to release OVN version X. At this point, the
 submodule is pointing to Commit 1. As part of the release process, we will bump