From 707c739268f37062ab858542b0eba50800339cbb Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sun, 9 Jun 2024 06:32:19 +1000 Subject: [PATCH] doc/start: format squash procedure Add letters to substeps in a procedure so that readers won't get too confused by having numbered steps nested inside numbered steps. Signed-off-by: Zac Dover --- doc/start/documenting-ceph.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/start/documenting-ceph.rst b/doc/start/documenting-ceph.rst index fef870f008614..f9d8870cd157f 100644 --- a/doc/start/documenting-ceph.rst +++ b/doc/start/documenting-ceph.rst @@ -546,7 +546,7 @@ commits will be squashed into a single commit. #. Make the commits that you will later squash. - #. Make the first commit. + A. Make the first commit. :: @@ -564,7 +564,7 @@ commits will be squashed into a single commit. # modified: glossary.rst # - #. Make the second commit. + B. Make the second commit. :: @@ -584,7 +584,7 @@ commits will be squashed into a single commit. # Changes to be committed: # modified: architecture.rst - #. Make the third commit. + C. Make the third commit. :: @@ -607,14 +607,14 @@ commits will be squashed into a single commit. #. There are now three commits in the feature branch. We will now begin the process of squashing them into a single commit. - #. Run the command ``git rebase -i main``, which rebases the current branch + A. Run the command ``git rebase -i main``, which rebases the current branch (the feature branch) against the ``main`` branch: .. prompt:: bash git rebase -i main - #. A list of the commits that have been made to the feature branch now + B. A list of the commits that have been made to the feature branch now appear, and looks like this: :: @@ -695,7 +695,7 @@ commits will be squashed into a single commit. #. Now we create a commit message that applies to all the commits that have been squashed together: - #. When you save and close the list of commits that you have designated for + A. When you save and close the list of commits that you have designated for squashing, a list of all three commit messages appears, and it looks like this: @@ -744,7 +744,7 @@ commits will be squashed into a single commit. # modified: doc/architecture.rst # modified: doc/glossary.rst - #. The commit messages have been revised into the simpler form presented here: + B. The commit messages have been revised into the simpler form presented here: :: -- 2.39.5