From: Zac Dover Date: Tue, 15 Aug 2023 03:28:00 +0000 (+1000) Subject: doc: improve submodule update command - README.md X-Git-Tag: v18.2.1~380^2 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=b3d820d5b4ae86c986883cec76f7d71fee90f5f1;p=ceph-ci.git doc: improve submodule update command - README.md Improve the portion of README.md that directs the reader to update the submodules. Previously, the text assumed that the reader knew that they should cd into the ceph directory. Now the text is explicit about the necessity of this action. Signed-off-by: Zac Dover (cherry picked from commit 578fdb27a09c629003ab20c0d27267d4d97b5d6c) --- diff --git a/README.md b/README.md index 1f00c5dd1d4..2ac8c99fbe6 100644 --- a/README.md +++ b/README.md @@ -33,10 +33,11 @@ command on a system that has git installed: git clone https://github.com/ceph/ceph.git -When the ceph/ceph repository has been cloned to your system, run the following -command to check out the git submodules associated with the ceph/ceph -repository: +When the `ceph/ceph` repository has been cloned to your system, run the +following commands to move into the cloned `ceph/ceph` repository and to check +out the git submodules associated with it: + cd ceph git submodule update --init --recursive