docs: document RUN_SETUP_GENTLY and clarify RUN_SETUP
We only said what happens when we find the Git directory under RUN_SETUP, without saying what happens otherwise. Signed-off-by: David Turner <dturner@twitter.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
David Turner committed
Apr 29, 2014 at 15:21 UTC
1d39dbecc2e55c2f723e2c2af43072891317dde9
1 file changed
+8
-5
Documentation/technical/api-builtin.txt
+8
-5
@@ -22,11 +22,14 @@ Git:
22
where options is the bitwise-or of:
23
24
`RUN_SETUP`::
25
-
26
- Make sure there is a Git directory to work on, and if there is a
27
- work tree, chdir to the top of it if the command was invoked
28
- in a subdirectory. If there is no work tree, no chdir() is
29
- done.
25
+ If there is not a Git directory to work on, abort. If there
26
+ is a work tree, chdir to the top of it if the command was
27
+ invoked in a subdirectory. If there is no work tree, no
28
+ chdir() is done.
29
+
30
+`RUN_SETUP_GENTLY`::
31
+ If there is a Git directory, chdir as per RUN_SETUP, otherwise,
32
+ don't chdir anywhere.
33
34
`USE_PAGER`::
35