]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/dev: add submodule-update link to dev guide
authorZac Dover <zac.dover@gmail.com>
Wed, 12 Oct 2022 12:39:36 +0000 (22:39 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 12 Oct 2022 17:30:42 +0000 (03:30 +1000)
This commit links to the procedure in install/clone-source.rst that
explains how to update submodules.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
doc/dev/developer_guide/basic-workflow.rst
doc/install/clone-source.rst

index 79bd30f62026a80a464b874a0b619a92ad6284d4..42f6e0e0f315a711cd6409bb2fd54bce2ef99844 100644 (file)
@@ -201,6 +201,9 @@ upstream repository:
 This procedure should be followed often, in order to keep your local ``main``
 in sync with upstream ``main``.
 
+If the command ``git status`` returns a line that reads "Untracked files", see
+:ref:`the procedure on updating submodules <update-submodules>`.
+
 .. _bugfix_branch:
 
 Creating a Bugfix branch
index f394366e5299c2ded3ab0fa88ae44e94972655de..6a55a880e7feb1c4ad3484520b5b8229f1405210 100644 (file)
@@ -92,7 +92,7 @@ Updating Submodules
 
       git status
 
-   #. If your submodules are up to date 
+   A. If your submodules are up to date 
          If your submodules are up to date, the following console output will
          appear: 
 
@@ -107,7 +107,7 @@ Updating Submodules
          You do not need this procedure.
 
 
-   #. If your submodules are not up to date 
+   B. If your submodules are not up to date 
          If your submodules are not up to date, you will see a message that
          includes a list of "untracked files". The example here shows such a
          list, which was generated from a real situation in which the