]> git.apps.os.sepia.ceph.com Git - ceph-ci.git/commitdiff
doc/start: format squash procedure
authorZac Dover <zac.dover@proton.me>
Sat, 8 Jun 2024 20:32:19 +0000 (06:32 +1000)
committerZac Dover <zac.dover@proton.me>
Sat, 8 Jun 2024 20:32:19 +0000 (06:32 +1000)
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 <zac.dover@proton.me>
doc/start/documenting-ceph.rst

index fef870f008614d09da7f3d0fab159f28b2c4fd12..f9d8870cd157f5a68a56a9d23206a0e14c9bafe4 100644 (file)
@@ -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:
 
       ::