diff options
| author |  Philippe Blain <levraiphilippeblain@gmail.com> | 2020-11-01 17:28:41 +0000 |
|---|---|---|
| committer |  Junio C Hamano <gitster@pobox.com> | 2020-11-01 15:54:14 -0800 |
| commit | fd5c74e7818a478fac66d821c38c4c2275c77da6 (patch) | |
| tree | bb76abf466bf8ac1d6be95778e85bcde61d97816 /Documentation/line-range-format.txt | |
| parent | doc: log, gitk: move '-L' description to 'line-range-options.txt' (diff) | |
| download | tgif-fd5c74e7818a478fac66d821c38c4c2275c77da6.tar.xz | |
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>
Diffstat (limited to 'Documentation/line-range-format.txt')
| -rw-r--r-- | Documentation/line-range-format.txt | 24 |
1 files changed, 12 insertions, 12 deletions
diff --git a/Documentation/line-range-format.txt b/Documentation/line-range-format.txt index 829676ff98..43759eef89 100644 --- a/Documentation/line-range-format.txt +++ b/Documentation/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 + -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). + -- /regex/ +- `/regex/` + 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. -If <start> is ``^/regex/'', it will search from the start of file. -If <end> is a regex, it will search -starting at the line given by <start>. +If '<start>' is `^/regex/`, it will search from the start of file. +If '<end>' is a regex, it will search +starting at the line given by '<start>'. + - +offset or -offset + -This is only valid for <end> and will specify a number -of lines before or after 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>'. + -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 -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 -from the start of file. ``^:<funcname>'' searches from the start of +from the start of file. `^:<funcname>` searches from the start of file. |