From e55c3b114be402eae94550c603cf7c028c9b64bf Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Wed, 12 Oct 2022 22:39:36 +1000 Subject: [PATCH] doc/dev: add submodule-update link to dev guide This commit links to the procedure in install/clone-source.rst that explains how to update submodules. Signed-off-by: Zac Dover --- doc/dev/developer_guide/basic-workflow.rst | 3 +++ doc/install/clone-source.rst | 4 ++-- 2 files changed, 5 insertions(+), 2 deletions(-) diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 79bd30f6202..42f6e0e0f31 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -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 `. + .. _bugfix_branch: Creating a Bugfix branch diff --git a/doc/install/clone-source.rst b/doc/install/clone-source.rst index f394366e529..6a55a880e7f 100644 --- a/doc/install/clone-source.rst +++ b/doc/install/clone-source.rst @@ -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 -- 2.39.5