]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: add formatting to basic workflow 58600/head
authorZac Dover <zac.dover@proton.me>
Mon, 15 Jul 2024 16:03:37 +0000 (02:03 +1000)
committerZac Dover <zac.dover@proton.me>
Mon, 15 Jul 2024 16:03:37 +0000 (02:03 +1000)
Add some formatting to a few sections near the end of
doc/dev/developer_guide_basic-workflow.rst.

Signed-off-by: Zac Dover <zac.dover@proton.me>
doc/dev/developer_guide/basic-workflow.rst

index 27000fa2b577be4e6613136371c7b39c58e33e50..7706e070989521edbec46b3fdb7342492378a5c2 100644 (file)
@@ -501,17 +501,17 @@ the merge message input will be automatically populated.
 Using .githubmap to Find a Reviewer's Email Address
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If you cannot find the email address of the reviewer on his or her GitHub
-page, you can look it up in the **.githubmap** file, which can be found in
-the repository at **/ceph/.githubmap**.
+page, you can look it up in the ``.githubmap`` file, which can be found in
+the repository at ``/ceph/.githubmap``.
 
 Using "git log" to find a Reviewer's Email Address
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 If you cannot find a reviewer's email address by using the above methods, you
 can search the git log for their email address. Reviewers are likely to have
-committed something before.  If they have made previous contributions, the git
+committed something before. If they have made previous contributions, the git
 log will probably contain their email address.
 
-Use the following command
+Use the following command:
 
 .. prompt:: bash [branch-under-review]$
 
@@ -521,9 +521,9 @@ Using ptl-tool to Generate Merge Commits
 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
 
 Another method of generating merge commits involves using Patrick Donnelly's
-**ptl-tool** pull commits. This tool can be found at
-**/ceph/src/script/ptl-tool.py**.  Merge commits that have been generated by
-the **ptl-tool** have the following form::
+``ptl-tool`` to pull commits. This tool can be found at
+``/ceph/src/script/ptl-tool.py``.  Merge commits that have been generated by the
+``ptl-tool`` have the following form::
 
      Merge PR #36257 into main 
      * refs/pull/36257/head: