[PATCH v2] Document RUN_SETUP_GENTLY
From: David Turner <hidden>
Date: 2016-06-15 23:00:55
Sorry about that -- the documentation of RUN_SETUP confused me. So I have a new patch that edits that as well. -- RUN_SETUP_GENTLY and improve RUN_SETUP docs Signed-off-by: David Turner <redacted> --- Documentation/technical/api-builtin.txt | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-)
diff --git a/Documentation/technical/api-builtin.txtb/Documentation/technical/api-builtin.txt index e3d6e7a..b250c1a 100644
--- a/Documentation/technical/api-builtin.txt
+++ b/Documentation/technical/api-builtin.txt@@ -23,10 +23,15 @@ 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`::
--
On Tue, Apr 29, 2014 at 2:25 PM, Junio C Hamano <gitster@pobox.com> wrote:
> David Turner <dturner@twopensource.com> writes:
>
>> Document RUN_SETUP_GENTLY
>>
>> Signed-off-by: David Turner <dturner@twitter.com>
>> ---
>> Documentation/technical/api-builtin.txt | 5 +++++
>> 1 file changed, 5 insertions(+)
>>
>> diff --git a/Documentation/technical/api-builtin.txt
>> b/Documentation/technical/api-builtin.txt
>> index e3d6e7a..1bbeda2 100644
>> --- a/Documentation/technical/api-builtin.txt
>> +++ b/Documentation/technical/api-builtin.txt
>> @@ -28,6 +28,11 @@ where options is the bitwise-or of:
>> 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 create one and don't chdir.
>
> I can understand "don't chdir" part, but where does "don't create"
> come from? Makes it sound as if non GENTLY version would create one
> if there isn't there, but I am guessing that that is not what you
> meant to say.
>
> Puzzled.
>