]> git.apps.os.sepia.ceph.com Git - ceph.git/commitdiff
doc/dev: add context note to dev guide config 46817/head
authorZac Dover <zac.dover@gmail.com>
Tue, 21 Jun 2022 14:09:05 +0000 (00:09 +1000)
committerZac Dover <zac.dover@gmail.com>
Wed, 22 Jun 2022 14:09:10 +0000 (00:09 +1000)
This PR adds a note directing first-time cloners of
their Ceph git forks to make sure to cd into the ceph/
directory before trying to run the "git config" commands.

Signed-off-by: Zac Dover <zac.dover@gmail.com>
(cherry picked from commit 3e6bcd7f0be2d0f896146c563a3381c9b7ea0e83)

doc/dev/developer_guide/basic-workflow.rst

index db048190e1ff19caf3d7f2d0bf0a913bd2b39d5a..9eff4b7abb07533f5478f1f3c3e37643c4504a8e 100644 (file)
@@ -142,6 +142,10 @@ to work on the Ceph repository.".
 
 1. Configure your local git environment with your name and email address.  
 
+   .. note::
+      These commands will work only from within the ``ceph/`` directory
+      that was created when you cloned your fork.
+
    .. prompt:: bash $
 
       git config user.name "FIRST_NAME LAST_NAME"