doc: line-range: improve formatting
Improve the formatting of the description of the line-range option '-L' for `git log`, `gitk` and `git blame`: - Use bold for <start>, <end> and <funcname> - Use backticks for literals Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com> Signed-off-by: Junio C Hamano <gitster@pobox.com>
This commit is contained in:
parent
f9c8d8cbbe
commit
fd5c74e781
@ -14,8 +14,8 @@
|
|||||||
Annotate only the given line range. May be specified multiple times.
|
Annotate only the given line range. May be specified multiple times.
|
||||||
Overlapping ranges are allowed.
|
Overlapping ranges are allowed.
|
||||||
+
|
+
|
||||||
<start> and <end> are optional. ``-L <start>'' or ``-L <start>,'' spans from
|
'<start>' and '<end>' are optional. `-L <start>` or `-L <start>,` spans from
|
||||||
<start> to end of file. ``-L ,<end>'' spans from start of file to <end>.
|
'<start>' to end of file. `-L ,<end>` spans from start of file to '<end>'.
|
||||||
+
|
+
|
||||||
include::line-range-format.txt[]
|
include::line-range-format.txt[]
|
||||||
|
|
||||||
|
@ -1,30 +1,30 @@
|
|||||||
<start> and <end> can take one of these forms:
|
'<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
|
||||||
absolute line number (lines count from 1).
|
absolute line number (lines count from 1).
|
||||||
+
|
+
|
||||||
|
|
||||||
- /regex/
|
- `/regex/`
|
||||||
+
|
+
|
||||||
This form will use the first line matching the given
|
This form will use the first line matching the given
|
||||||
POSIX regex. If <start> is a regex, it will search from the end of
|
POSIX regex. If '<start>' is a regex, it will search from the end of
|
||||||
the previous `-L` range, if any, otherwise from the start of file.
|
the previous `-L` range, if any, otherwise from the start of file.
|
||||||
If <start> is ``^/regex/'', it will search from the start of file.
|
If '<start>' is `^/regex/`, it will search from the start of file.
|
||||||
If <end> is a regex, it will search
|
If '<end>' is a regex, it will search
|
||||||
starting at the line given by <start>.
|
starting at the line given by '<start>'.
|
||||||
+
|
+
|
||||||
|
|
||||||
- +offset or -offset
|
- +offset or -offset
|
||||||
+
|
+
|
||||||
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>'.
|
||||||
|
|
||||||
+
|
+
|
||||||
If ``:<funcname>'' is given in place of <start> and <end>, it is a
|
If `:<funcname>` is given in place of '<start>' and '<end>', it is a
|
||||||
regular expression that denotes the range from the first funcname line
|
regular expression that denotes the range from the first funcname line
|
||||||
that matches <funcname>, up to the next funcname line. ``:<funcname>''
|
that matches '<funcname>', up to the next funcname line. `:<funcname>`
|
||||||
searches from the end of the previous `-L` range, if any, otherwise
|
searches from the end of the previous `-L` range, if any, otherwise
|
||||||
from the start of file. ``^:<funcname>'' searches from the start of
|
from the start of file. `^:<funcname>` searches from the start of
|
||||||
file.
|
file.
|
||||||
|
@ -1,12 +1,12 @@
|
|||||||
-L<start>,<end>:<file>::
|
-L<start>,<end>:<file>::
|
||||||
-L:<funcname>:<file>::
|
-L:<funcname>:<file>::
|
||||||
|
|
||||||
Trace the evolution of the line range given by "<start>,<end>"
|
Trace the evolution of the line range given by '<start>,<end>'
|
||||||
(or the function name regex <funcname>) within the <file>. You may
|
(or the function name regex '<funcname>') within the '<file>'. You may
|
||||||
not give any pathspec limiters. This is currently limited to
|
not give any pathspec limiters. This is currently limited to
|
||||||
a walk starting from a single revision, i.e., you may only
|
a walk starting from a single revision, i.e., you may only
|
||||||
give zero or one positive revision arguments, and
|
give zero or one positive revision arguments, and
|
||||||
<start> and <end> (or <funcname>) must exist in the starting revision.
|
'<start>' and '<end>' (or '<funcname>') must exist in the starting revision.
|
||||||
You can specify this option more than once. Implies `--patch`.
|
You can specify this option more than once. Implies `--patch`.
|
||||||
Patch output can be suppressed using `--no-patch`, but other diff formats
|
Patch output can be suppressed using `--no-patch`, but other diff formats
|
||||||
(namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
|
(namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
|
||||||
|
Loading…
Reference in New Issue
Block a user