Skip to content

Commit

Permalink
doc: improve submodule update command - README.md
Browse files Browse the repository at this point in the history
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 <[email protected]>
  • Loading branch information
zdover23 committed Aug 15, 2023
1 parent 1d9a0f6 commit 578fdb2
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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


Expand Down

0 comments on commit 578fdb2

Please sign in to comment.