Skip to content

Commit

Permalink
line-range-format.txt: clarify -L:regex usage form
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Eric Sunshine authored and Junio C Hamano committed Aug 6, 2013
1 parent 1e15983 commit 0ddd471
Show file tree
Hide file tree
Showing 3 changed files with 3 additions and 8 deletions.
2 changes: 0 additions & 2 deletions Documentation/blame-options.txt
Original file line number Diff line number Diff line change
Expand Up @@ -15,8 +15,6 @@
``-L <start>'' or ``-L <start>,'' spans from <start> to end of file.
``-L ,<end>'' spans from start of file to <end>.
+
<start> and <end> can take one of these forms:

include::line-range-format.txt[]

-l::
Expand Down
2 changes: 0 additions & 2 deletions Documentation/git-log.txt
Original file line number Diff line number Diff line change
Expand Up @@ -72,8 +72,6 @@ produced by --stat etc.
give zero or one positive revision arguments.
You can specify this option more than once.
+
<start> and <end> can take one of these forms:

include::line-range-format.txt[]

<revision range>::
Expand Down
7 changes: 3 additions & 4 deletions Documentation/line-range-format.txt
Original file line number Diff line number Diff line change
@@ -1,3 +1,5 @@
<start> and <end> can take one of these forms:

- number
+
If <start> or <end> is a number, it specifies an
Expand All @@ -15,11 +17,8 @@ starting at the line given by <start>.
+
This is only valid for <end> and will specify a number
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
funcname line.
+

0 comments on commit 0ddd471

Please sign in to comment.