line-range-format.txt: clarify -L:regex usage form

blame/log documentation describes -L option as:

  -L<start>,<end>
  -L:<regex>

  <start> and <end> can take one of these forms:

    * number
    * /regex/
    * +offset or -offset
    * :regex

which is incorrect and confusing since :regex is not one of the valid
forms of <start> or <end>; in fact, it must be -L's lone argument.

Clarify by discussing :<regex> at the same indentation level as "<start>
and <end>...":

  -L<start>,<end>
  -L:<regex>

  <start> and <end> can take one of these forms:

    * number
    * /regex/
    * +offset or -offset

  If :<regex> is given in place of <start> and <end> ...

Signed-off-by: Eric Sunshine <sunshine@sunshineco.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
Eric Sunshine
2013-08-06 09:59:35 -04:00
committed by Junio C Hamano
parent 1e159833c7
commit 0ddd47193c
3 changed files with 3 additions and 8 deletions

View File

@ -15,8 +15,6 @@
``-L <start>'' or ``-L <start>,'' spans from <start> to end of file. ``-L <start>'' or ``-L <start>,'' spans from <start> to end of file.
``-L ,<end>'' spans from start of file to <end>. ``-L ,<end>'' spans from start of file to <end>.
+ +
<start> and <end> can take one of these forms:
include::line-range-format.txt[] include::line-range-format.txt[]
-l:: -l::

View File

@ -72,8 +72,6 @@ produced by --stat etc.
give zero or one positive revision arguments. give zero or one positive revision arguments.
You can specify this option more than once. You can specify this option more than once.
+ +
<start> and <end> can take one of these forms:
include::line-range-format.txt[] include::line-range-format.txt[]
<revision range>:: <revision range>::

View File

@ -1,3 +1,5 @@
<start> and <end> can take one of these forms:
- number - number
+ +
If <start> or <end> is a number, it specifies an If <start> or <end> is a number, it specifies an
@ -15,11 +17,8 @@ starting at the line given by <start>.
+ +
This is only valid for <end> and will specify a number This is only valid for <end> and will specify a number
of lines before or after the line given by <start>. of lines before or after the line given by <start>.
+
- :regex
+ +
If the option's argument is of the form :regex, it denotes the range If ``:<regex>'' is given in place of <start> and <end>, it denotes the range
from the first funcname line that matches <regex>, up to the next from the first funcname line that matches <regex>, up to the next
funcname line. funcname line.
+