Re: [PATCH] Documentation: update-index: -z applies also to --index-info

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On Thu, Oct 7, 2010 at 20:33, ÅtÄpÃn NÄmec <stepnem@xxxxxxxxx> wrote:
> Bert Wesarg <bert.wesarg@xxxxxxxxxxxxxx> writes:
>
>> Also mention, that --stdin and --index-info needs to be the last
>> option supplied and indicate this in the usage string.
>>
>> Signed-off-by: Bert Wesarg <bert.wesarg@xxxxxxxxxxxxxx>
>>
>> ---
>>
>> We may like the usage string like this:
>>
>> [[-z] --stdin | --index-info]
>
> Yeah, that'd be definitely better IMO.

Will do.

>
> Also the usage string in builtin/update-index.c should be updated to the
> same effect.
>
> There is actually at least one more problem with the current SYNOPSIS of
> `update-index'. Obviously the `*' on the third line of the Asciidoc
> source makes the whole `--cacheinfo' line disappear and the rest bold
> (cf. e.g. the result at
> <http://www.kernel.org/pub/software/scm/git/docs/git-update-index.html>).
>
> I guess using `...' instead of the asterisks (also on the last line,
> i.e. [<file>...], not [<file>]*) would both fix the problem and at the
> same time make it more consistent with other man pages.

I wont change it in this patch, because I can't build the html docs right now.

>
>> to make it also clear, that -z applies only to --stdin or --index-only.
>> ---
>> ÂDocumentation/git-update-index.txt | Â 14 ++++++++------
>> Â1 files changed, 8 insertions(+), 6 deletions(-)
>>
>> diff --git a/Documentation/git-update-index.txt
>> b/Documentation/git-update-index.txt
>> index 74d1d49..4441d7c 100644 Documentation/git-update-index.txt
>> --- a/Documentation/git-update-index.txt
>> +++ b/Documentation/git-update-index.txt
>> @@ -18,8 +18,9 @@ SYNOPSIS
>> Â Â Â Â Â Â[--skip-worktree | --no-skip-worktree]
>> Â Â Â Â Â Â[--ignore-submodules]
>> Â Â Â Â Â Â[--really-refresh] [--unresolve] [--again | -g]
>> - Â Â Â Â Â[--info-only] [--index-info]
>> - Â Â Â Â Â[-z] [--stdin]
>> + Â Â Â Â Â[--info-only]
>> + Â Â Â Â Â[-z]
>> + Â Â Â Â Â[--stdin] [--index-info]
>> Â Â Â Â Â Â[--verbose]
>> Â Â Â Â Â Â[--] [<file>]*
>
> Shouldn't `--verbose' be also moved before the must-be-last options?

Sure. I noticed this myself, but the patch was already in the wire.

>
>> @@ -72,7 +73,7 @@ OPTIONS
>> Â Â Â Directly insert the specified info into the index.
>>
>> Â--index-info::
>> - Â Â Â ÂRead index information from stdin.
>> + Â Â Â ÂRead index information from stdin (Must be last option).
>
> I'm not a native speaker myself, but I suspect "must be THE last option"
> is more correct (including the lower-case `m' :-)).

Maybe this should be in its own sentence, like the '(Implies
--remove.)' in --force-remove.

>
>> Â--chmod=(+|-)x::
>> Â Â Â Â ÂSet the execute permissions on the updated files.
>> @@ -138,14 +139,15 @@ you will need to handle the situation manually.
>> Â--stdin::
>> Â Â Â Instead of taking list of paths from the command line,
>> Â Â Â read list of paths from the standard input. ÂPaths are
>> - Â Â separated by LF (i.e. one path per line) by default.
>> + Â Â separated by LF (i.e. one path per line) by default
>> + Â Â (Must be last option).
>
> (same here)
>
>>
>> Â--verbose::
>> Â Â Â Â ÂReport what is being added and removed from index.
>>
>> Â-z::
>> - Â Â Only meaningful with `--stdin`; paths are separated with
>> - Â Â NUL character instead of LF.
>> + Â Â Only meaningful with `--stdin` or `--index-info`; paths are
>> + Â Â separated with NUL character instead of LF.
>>
>> Â\--::
>> Â Â Â Do not interpret any more arguments as options.
>
> Thanks,

Thank you.

Bert

>
> ÅtÄpÃn
>
--
To unsubscribe from this list: send the line "unsubscribe git" in
the body of a message to majordomo@xxxxxxxxxxxxxxx
More majordomo info at  http://vger.kernel.org/majordomo-info.html


[Index of Archives]     [Linux Kernel Development]     [Gcc Help]     [IETF Annouce]     [DCCP]     [Netdev]     [Networking]     [Security]     [V4L]     [Bugtraq]     [Yosemite]     [MIPS Linux]     [ARM Linux]     [Linux Security]     [Linux RAID]     [Linux SCSI]     [Fedora Users]