mirrors/git
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

docs: document RUN_SETUP_GENTLY and clarify RUN_SETUP

Browse Source 
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>
This commit is contained in:
David Turner
2014-04-29 15:21:34 -04:00
committed by Junio C Hamano
parent 0bc85abb7a
commit 1d39dbecc2
1 changed files with 7 additions and 4 deletions
Download Patch File Download Diff File Expand all files Collapse all files

11
Documentation/technical/api-builtin.txt
View File

@ -22,11 +22,14 @@ Git:
where options is the bitwise-or of: where options is the bitwise-or of:
`RUN_SETUP`:: `RUN_SETUP`::
If there is not a Git directory to work on, abort. If there
is a work tree, chdir to the top of it if the command was
invoked in a subdirectory. If there is no work tree, no
chdir() is done.
Make sure there is a Git directory to work on, and if there is a `RUN_SETUP_GENTLY`::
work tree, chdir to the top of it if the command was invoked If there is a Git directory, chdir as per RUN_SETUP, otherwise,
in a subdirectory. If there is no work tree, no chdir() is don't chdir anywhere.
done.
`USE_PAGER`:: `USE_PAGER`::