Re: [PATCH 5/6] blame-options.txt: place each -L option variation on its own line

From: Junio C Hamano <gitster@pobox.com>
Date: Jul 18, 2013, 17:51 UTC
Message-ID: <7vvc473gfe.fsf@alter.siamese.dyndns.org>
In-Reply-To: <87hafs84jc.fsf@linux-k42r.v.cablecom.net>

Thomas Rast <tr@thomasrast.ch> writes:

Show 27 quoted lines

> Eric Sunshine <sunshine@sunshineco.com> writes:
>
>> Standard practice in Git documentation is for each variation of an
>> option (such as: -p / --porcelain) to be placed on its own line in the
>> OPTIONS table. The -L option does not follow suit. It cuddles
>> "-L <start>,<end>" and "-L :<regex>", separated by a comma. This is
>> inconsistent and potentially confusing since the comma separating them
>> is typeset the same as the comma in "<start>,<end>". Fix this by placing
>> each variation on its own line.
>
> Ok, but why not fix them all in one go?
>
> Edited to remove the false positives:
>
> $ git grep -n '^.*,.*::$' Documentation/*.txt
> Documentation/blame-options.txt:12:-L <start>,<end>, -L :<regex>::
> Documentation/config.txt:1252:gitcvs.dbuser, gitcvs.dbpass::
> Documentation/config.txt:1513:http.lowSpeedLimit, http.lowSpeedTime::
> Documentation/git-add.txt:90:-e, \--edit::
> Documentation/git-check-attr.txt:22:-a, --all::
> Documentation/git-check-ignore.txt:26:-q, --quiet::
> Documentation/git-check-ignore.txt:30:-v, --verbose::
> Documentation/git-check-ignore.txt:42:-n, --non-matching::
> Documentation/git-log.txt:65:-L <start>,<end>:<file>, -L :<regex>:<file>::
> Documentation/git-log.txt:156:git log -L '/int main/',/^}/:main.c::
> Documentation/git-p4.txt:171:--verbose, -v::
> Documentation/git-p4.txt:282:--dry-run, -n::

Thanks, but I think it is cleaner to fix the others in a separate "treewide clean-up" patch.

Also I wonder if this one Documentation/git-log.txt:156

    git log -L '/int main/',/^}/:main.c

should be more like one of these:

    git log -L '/int main/,/^}/':main.c
    git log -L '/int main/,/^}/:main.c'

I find it somewhat hard to spot the closing sq in the middle of a string.