diff options
| author | David Turner <dturner@twopensource.com> | 2014-04-29 15:21:34 -0400 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-04-30 11:28:21 -0700 |
| commit | 1d39dbecc2e55c2f723e2c2af43072891317dde9 (patch) | |
| tree | fefa0c97cc6b25367365d8d4d7ce84efecba3da6 | |
| parent | 0bc85abb7aa9b24b093253018801a0fb43d01122 (diff) | |
| download | git-dt/api-doc-setup-gently.tar.gz | |
docs: document RUN_SETUP_GENTLY and clarify RUN_SETUPdt/api-doc-setup-gently
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>
| -rw-r--r-- | Documentation/technical/api-builtin.txt | 13 |
1 files changed, 8 insertions, 5 deletions
diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt index e3d6e7a79a..22a39b9299 100644 --- a/Documentation/technical/api-builtin.txt +++ b/Documentation/technical/api-builtin.txt @@ -22,11 +22,14 @@ Git: where options is the bitwise-or of: `RUN_SETUP`:: - - Make sure there is a Git directory to work on, and 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. + 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. + +`RUN_SETUP_GENTLY`:: + If there is a Git directory, chdir as per RUN_SETUP, otherwise, + don't chdir anywhere. `USE_PAGER`:: |