From f5c87693abcfc9a6a3869a3f52549384807fba9d Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 19 Dec 2023 19:15:57 +1000 Subject: [PATCH] doc/install: update "update submodules" Remove misleading material that would give readers the wrong idea about when stale submodules are present. This commit is made in response to information given to me by Ilya Dryomov here: https://github.com/ceph/ceph/pull/54929#issuecomment-1859237986. Signed-off-by: Zac Dover --- doc/install/clone-source.rst | 74 ++---------------------------------- 1 file changed, 4 insertions(+), 70 deletions(-) diff --git a/doc/install/clone-source.rst b/doc/install/clone-source.rst index 8e783fed8e836..453d544b68562 100644 --- a/doc/install/clone-source.rst +++ b/doc/install/clone-source.rst @@ -98,59 +98,7 @@ repository. Updating Submodules ------------------- -#. Determine whether your submodules are out of date: - - .. prompt:: bash $ - - git status - - A. If your submodules are up to date - If your submodules are up to date, the following console output will - appear: - - :: - - On branch main - Your branch is up to date with 'origin/main'. - - nothing to commit, working tree clean - - If you see this console output, then your submodules are up to date. - You do not need this procedure. - - - 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 - submodules were no longer current. Your list of files will not be the - same as this list of files, but this list is provided as an example. - If in your case any untracked files are listed, then you should - continue to the next step of this procedure. - - :: - - On branch main - Your branch is up to date with 'origin/main'. - - Untracked files: - (use "git add ..." to include in what will be committed) - src/pybind/cephfs/build/ - src/pybind/cephfs/cephfs.c - src/pybind/cephfs/cephfs.egg-info/ - src/pybind/rados/build/ - src/pybind/rados/rados.c - src/pybind/rados/rados.egg-info/ - src/pybind/rbd/build/ - src/pybind/rbd/rbd.c - src/pybind/rbd/rbd.egg-info/ - src/pybind/rgw/build/ - src/pybind/rgw/rgw.c - src/pybind/rgw/rgw.egg-info/ - - nothing added to commit but untracked files present (use "git add" to track) - -#. If your submodules are out of date, run the following commands: +If your submodules are out of date, run the following commands: .. prompt:: bash $ @@ -158,24 +106,10 @@ Updating Submodules git clean -fdx git submodule foreach git clean -fdx - If you still have problems with a submodule directory, use ``rm -rf - [directory name]`` to remove the directory. Then run ``git submodule update - --init --recursive --progress`` again. - -#. Run ``git status`` again: - - .. prompt:: bash $ - - git status - - Your submodules are up to date if you see the following message: - - :: +If you still have problems with a submodule directory, use ``rm -rf [directory +name]`` to remove the directory. Then run ``git submodule update --init +--recursive --progress`` again. - On branch main - Your branch is up to date with 'origin/main'. - - nothing to commit, working tree clean Choose a Branch =============== -- 2.39.5