summaryrefslogtreecommitdiff
path: root/Documentation/technical
diff options
context:
space:
mode:
authorJunio C Hamano <gitster@pobox.com>2014-06-03 19:06:45 (GMT)
committerJunio C Hamano <gitster@pobox.com>2014-06-03 19:06:45 (GMT)
commit520cd9cd20a97d1220d6f0ebf921406683ad62ee (patch)
treec9bd7516dd9ee9bdc2c6178c398323c972d35062 /Documentation/technical
parent7ea60c15cc98ab586aea77c256934acd438c7f95 (diff)
parent1d39dbecc2e55c2f723e2c2af43072891317dde9 (diff)
downloadgit-520cd9cd20a97d1220d6f0ebf921406683ad62ee.zip
git-520cd9cd20a97d1220d6f0ebf921406683ad62ee.tar.gz
git-520cd9cd20a97d1220d6f0ebf921406683ad62ee.tar.bz2
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/technical')
-rw-r--r--Documentation/technical/api-builtin.txt13
1 files changed, 8 insertions, 5 deletions
diff --git a/Documentation/technical/api-builtin.txt b/Documentation/technical/api-builtin.txt
index e3d6e7a..22a39b9 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`::