From d6a2eea1c282714a4526dba18c775ca2e152004a Mon Sep 17 00:00:00 2001 From: Zac Dover Date: Wed, 22 Jun 2022 00:09:05 +1000 Subject: [PATCH] doc/dev: add context note to dev guide config 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 (cherry picked from commit 3e6bcd7f0be2d0f896146c563a3381c9b7ea0e83) --- doc/dev/developer_guide/basic-workflow.rst | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/doc/dev/developer_guide/basic-workflow.rst b/doc/dev/developer_guide/basic-workflow.rst index 6e83e0081873a..25ea32227a78e 100644 --- a/doc/dev/developer_guide/basic-workflow.rst +++ b/doc/dev/developer_guide/basic-workflow.rst @@ -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" -- 2.39.5