diff options
| author |  Junio C Hamano <gitster@pobox.com> | 2014-06-03 12:06:45 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2014-06-03 12:06:45 -0700 |
| commit | 520cd9cd20a97d1220d6f0ebf921406683ad62ee (patch) | |
| tree | c9bd7516dd9ee9bdc2c6178c398323c972d35062 /Documentation | |
| parent | Merge branch 'fc/mergetool-prompt' (diff) | |
| parent | docs: document RUN_SETUP_GENTLY and clarify RUN_SETUP (diff) | |
| download | tgif-520cd9cd20a97d1220d6f0ebf921406683ad62ee.tar.xz | |
Merge branch 'dt/api-doc-setup-gently'
* dt/api-doc-setup-gently:
docs: document RUN_SETUP_GENTLY and clarify RUN_SETUP
Diffstat (limited to 'Documentation')
| -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`:: |