line-range-format.txt: clarify -L:regex usage form
authorEric Sunshine <sunshine@sunshineco.com>
Tue, 6 Aug 2013 13:59:35 +0000 (09:59 -0400)
committerJunio C Hamano <gitster@pobox.com>
Tue, 6 Aug 2013 21:26:26 +0000 (14:26 -0700)
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>
Documentation/blame-options.txt
Documentation/git-log.txt
Documentation/line-range-format.txt
index 4e55b1564e8ad6526c53f797141cfccd83648fc7..489032c7a3edbdf92d0dff05ab065868da62132f 100644 (file)
@@ -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::
index fe04e06acba1a428698faf98dd8033cee304aeb2..34097efea707aa59b6a5703826445f5c3fccabcf 100644 (file)
@@ -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>::
index 3e7ce72daab23d6dfcf12d1e0dd1dd6be705e56d..a1b2f4e0893cdcc34b6bd58a6474582b8afc96e3 100644 (file)
@@ -1,3 +1,5 @@
+<start> and <end> can take one of these forms:
+
 - number
 +
 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
 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.
-+