]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc: improve submodule update command - README.md 53001/head
authorZac Dover <zac.dover@proton.me>
Tue, 15 Aug 2023 03:28:00 +0000 (13:28 +1000)
committerZac Dover <zac.dover@proton.me>
Tue, 15 Aug 2023 14:30:23 +0000 (00:30 +1000)
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 <zac.dover@proton.me>
(cherry picked from commit 578fdb27a09c629003ab20c0d27267d4d97b5d6c)

README.md

index 00f7d24c3626e840b8742c49f3ffdc26e8b41d81..91fee7edb8102e5997adcf5ebec1067136a74e37 100644 (file)
--- a/README.md
+++ b/README.md
@@ -33,10 +33,11 @@ command on a system that has git installed:
 
        git clone git://github.com/ceph/ceph
 
-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