From 4c4063a09759dc3412d89ecafb9ac55a55e6bc01 Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Tue, 16 Jul 2024 02:03:37 +1000 Subject: [PATCH] doc/dev: add formatting to basic workflow Add some formatting to a few sections near the end of doc/dev/developer_guide_basic-workflow.rst. Signed-off-by: Zac Dover --- doc/dev/developer_guide/basic-workflow.rst | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 27000fa2b577b..7706e07098952 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -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: -- 2.39.5