diff mbox series

[v4,2/3] doc: add spacing around paginate options

Message ID 20240503071706.78109-3-james@jamesliu.io (mailing list archive)
State Accepted
Commit 5bd8811a734536186dd69ae767a9d58ce01ad7cb
Headers show
Series advice: add "all" option to disable all hints | expand

Commit Message

James Liu May 3, 2024, 7:17 a.m. UTC
Make the documentation page consistent with the usage string printed by
git.c

Signed-off-by: James Liu <james@jamesliu.io>
---
 Documentation/git.txt | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

karthik nayak May 3, 2024, 2:32 p.m. UTC | #1
James Liu <james@jamesliu.io> writes:

> Make the documentation page consistent with the usage string printed by
> git.c
>

Nit: missing full-stop here.

> Signed-off-by: James Liu <james@jamesliu.io>
> ---
>  Documentation/git.txt | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
>
> diff --git a/Documentation/git.txt b/Documentation/git.txt
> index 7fa75350b2..d11d3d0c86 100644
> --- a/Documentation/git.txt
> +++ b/Documentation/git.txt
> @@ -11,7 +11,7 @@ SYNOPSIS
>  [verse]
>  'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
>      [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
> -    [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--no-lazy-fetch]
> +    [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--no-lazy-fetch]
>      [--no-optional-locks] [--bare] [--git-dir=<path>] [--work-tree=<path>]
>      [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]
>
> --
> 2.44.0
Junio C Hamano May 3, 2024, 5:36 p.m. UTC | #2
Karthik Nayak <karthik.188@gmail.com> writes:

> James Liu <james@jamesliu.io> writes:
>
>> Make the documentation page consistent with the usage string printed by
>> git.c
>>
>
> Nit: missing full-stop here.

Yes, but "printed by git.c" is an unsatisfying way to say this.  We
can easily illustrate what the end user does to get it, for example:

    ... usage string given by "git help git".

It also makes it internally consistent with "[-v | --version]" that
exists in the same document, which is even better reason to do this
change.

Thanks, both.

>
>> Signed-off-by: James Liu <james@jamesliu.io>
>> ---
>>  Documentation/git.txt | 2 +-
>>  1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/Documentation/git.txt b/Documentation/git.txt
>> index 7fa75350b2..d11d3d0c86 100644
>> --- a/Documentation/git.txt
>> +++ b/Documentation/git.txt
>> @@ -11,7 +11,7 @@ SYNOPSIS
>>  [verse]
>>  'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
>>      [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
>> -    [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--no-lazy-fetch]
>> +    [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--no-lazy-fetch]
>>      [--no-optional-locks] [--bare] [--git-dir=<path>] [--work-tree=<path>]
>>      [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]
>>
>> --
>> 2.44.0
diff mbox series

Patch

diff --git a/Documentation/git.txt b/Documentation/git.txt
index 7fa75350b2..d11d3d0c86 100644
--- a/Documentation/git.txt
+++ b/Documentation/git.txt
@@ -11,7 +11,7 @@  SYNOPSIS
 [verse]
 'git' [-v | --version] [-h | --help] [-C <path>] [-c <name>=<value>]
     [--exec-path[=<path>]] [--html-path] [--man-path] [--info-path]
-    [-p|--paginate|-P|--no-pager] [--no-replace-objects] [--no-lazy-fetch]
+    [-p | --paginate | -P | --no-pager] [--no-replace-objects] [--no-lazy-fetch]
     [--no-optional-locks] [--bare] [--git-dir=<path>] [--work-tree=<path>]
     [--namespace=<name>] [--config-env=<name>=<envvar>] <command> [<args>]