Merge pull request #58600 from zdover23/wip-doc-2024-07-16-dev-guide-basic-workflow

doc/dev: add formatting to basic workflow

Reviewed-by: Anthony D'Atri <anthony.datri@gmail.com>
This commit is contained in:
Zac Dover 2024-07-23 04:00:49 +10:00 committed by GitHub
commit f836a76cb7
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194

View File

@ -505,17 +505,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]$
@ -525,9 +525,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: