From b8472b98e2c6cd20e7c3e5d7f9b0e7c9ec381d7a Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Sun, 25 Sep 2022 13:41:35 +1000 Subject: [PATCH] doc/dev: improve presentation of note (git remote) This commit corrects the formatting of a note that previously did not make console output and commands as clear as this commit makes them. Signed-off-by: Zac Dover --- doc/dev/developer_guide/basic-workflow.rst | 25 ++++++++++++++-------- 1 file changed, 16 insertions(+), 9 deletions(-) diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index a73c8ad30ca..79bd30f6202 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -280,13 +280,13 @@ believe that it works. .. note:: - In the command `git push origin fix_1`, `origin` is the name of your fork - of the upstream Ceph repository, and can be thought of as a nickname for - `git@github.com:username/ceph.git`, where `username` is your GitHub - username. + In the command ``git push origin fix_1``, ``origin`` is the name of your + fork of the upstream Ceph repository, and can be thought of as a nickname + for ``git@github.com:username/ceph.git``, where ``username`` is your + GitHub username. - It is possible that `origin` is not the name of your fork. Discover the - name of your fork by running `git remote -v`, as shown here: + It is possible that ``origin`` is not the name of your fork. Discover the + name of your fork by running ``git remote -v``, as shown here: .. code-block:: bash @@ -296,9 +296,16 @@ believe that it works. origin git@github.com:username/ceph.git (fetch) origin git@github.com:username/ceph.git (push) - The line "origin git@github.com:username/ceph.git (fetch)" and the line - "origin git@github.com:username/ceph.git (push)" provide the information - that "origin" is the name of your fork of the Ceph repository. + The line:: + + origin git@github.com:username/ceph.git (fetch) + + and the line:: + + origin git@github.com:username/ceph.git (push) + + provide the information that "origin" is the name of your fork of the + Ceph repository. Opening a GitHub pull request -- 2.39.5