]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: log, gitk: move '-L' description to 'line-range-options.txt'
authorPhilippe Blain <levraiphilippeblain@gmail.com>
Sun, 1 Nov 2020 17:28:40 +0000 (17:28 +0000)
committerJunio C Hamano <gitster@pobox.com>
Sun, 1 Nov 2020 23:54:14 +0000 (15:54 -0800)
The description of the '-L' option for `git log` and `gitk` is almost
the same, but is repeated in both 'git-log.txt' and 'gitk.txt' (the
difference being that 'git-log.txt' lists the option with a space
after '-L', while 'gitk.txt' lists it as stuck and notes that `gitk`
only understands the stuck form).

Reduce duplication by creating a new file, 'line-range-options.txt',
and include it in both files.

To simplify the presentation, only list the stuck form for both
commands, and remove the note about `gitk` only understanding the stuck
form.

Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/git-log.txt
Documentation/gitk.txt
Documentation/line-range-options.txt [new file with mode: 0644]

index 2b8ac5ff882ae84d52d08458c2439f314d2a0370..dd189a353a443e8d1b18ae95ece7d7d24cceee3d 100644 (file)
@@ -77,20 +77,7 @@ produced by `--stat`, etc.
        Intended to speed up tools that read log messages from `git log`
        output by allowing them to allocate space in advance.
 
--L <start>,<end>:<file>::
--L :<funcname>:<file>::
-       Trace the evolution of the line range given by "<start>,<end>"
-       (or the function name regex <funcname>) within the <file>.  You may
-       not give any pathspec limiters.  This is currently limited to
-       a walk starting from a single revision, i.e., you may only
-       give zero or one positive revision arguments, and
-       <start> and <end> (or <funcname>) must exist in the starting revision.
-       You can specify this option more than once. Implies `--patch`.
-       Patch output can be suppressed using `--no-patch`, but other diff formats
-       (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
-       `--name-only`, `--name-status`, `--check`) are not currently implemented.
-+
-include::line-range-format.txt[]
+include::line-range-options.txt[]
 
 <revision range>::
        Show only commits in the specified revision range.  When no
index c653ebb6a80c03bab1e593f13b488d742ff5cbce..d50e9ed10e04c688b6ee898b20e24a1cd796cc78 100644 (file)
@@ -98,25 +98,7 @@ linkgit:git-rev-list[1] for a complete list.
        (See "History simplification" in linkgit:git-log[1] for a more
        detailed explanation.)
 
--L<start>,<end>:<file>::
--L:<funcname>:<file>::
-
-       Trace the evolution of the line range given by "<start>,<end>"
-       (or the function name regex <funcname>) within the <file>.  You may
-       not give any pathspec limiters.  This is currently limited to
-       a walk starting from a single revision, i.e., you may only
-       give zero or one positive revision arguments, and
-       <start> and <end> (or <funcname>) must exist in the starting revision.
-       You can specify this option more than once. Implies `--patch`.
-       Patch output can be suppressed using `--no-patch`, but other diff formats
-       (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
-       `--name-only`, `--name-status`, `--check`) are not currently implemented.
-+
-*Note:* gitk (unlike linkgit:git-log[1]) currently only understands
-this option if you specify it "glued together" with its argument.  Do
-*not* put a space after `-L`.
-+
-include::line-range-format.txt[]
+include::line-range-options.txt[]
 
 <revision range>::
 
diff --git a/Documentation/line-range-options.txt b/Documentation/line-range-options.txt
new file mode 100644 (file)
index 0000000..266263f
--- /dev/null
@@ -0,0 +1,15 @@
+-L<start>,<end>:<file>::
+-L:<funcname>:<file>::
+
+       Trace the evolution of the line range given by "<start>,<end>"
+       (or the function name regex <funcname>) within the <file>.  You may
+       not give any pathspec limiters.  This is currently limited to
+       a walk starting from a single revision, i.e., you may only
+       give zero or one positive revision arguments, and
+       <start> and <end> (or <funcname>) must exist in the starting revision.
+       You can specify this option more than once. Implies `--patch`.
+       Patch output can be suppressed using `--no-patch`, but other diff formats
+       (namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
+       `--name-only`, `--name-status`, `--check`) are not currently implemented.
++
+include::line-range-format.txt[]