]> git-server-git.apps.pok.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: improve presentation of note (git remote) 48236/head
authorZac Dover <zac.dover@gmail.com>
Sun, 25 Sep 2022 03:41:35 +0000 (13:41 +1000)
committerZac Dover <zac.dover@gmail.com>
Sun, 25 Sep 2022 04:38:01 +0000 (14:38 +1000)
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 <zac.dover@gmail.com>
doc/dev/developer_guide/basic-workflow.rst

index 03452674db2c36806a1a48f5f9fbad7da08f44fd..0f9aa6a6c4c71f977bde6d740401e96054ecc554 100644 (file)
@@ -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