From e68ef0ced3b6ec34009f725a7ac762e6df4fa868 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Fri, 13 Dec 2019 20:29:03 -0500 Subject: [PATCH 1/2] doc: log, gitk: document accepted line-log diff formats Currently the line-log functionality (git log -L) only supports displaying patch output (`-p | --patch`, its default behavior) and suppressing it (`-s | --no-patch`). A check was added in the code to that effect in 5314efaea (line-log: detect unsupported formats, 2019-03-10) but the documentation was not updated. Explicitly mention that `-L` implies `-p`, that patch output can be suppressed using `-s`, and that all other diff formats are not allowed. Signed-off-by: Philippe Blain --- Documentation/git-log.txt | 5 ++++- Documentation/gitk.txt | 5 ++++- 2 files changed, 8 insertions(+), 2 deletions(-) diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index b406bc4c48f423..6574c0d91f1000 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -77,7 +77,10 @@ produced by `--stat`, etc. 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. - You can specify this option more than once. + 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[] diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index 1eabb0aaf3aec9..c487af5b74f81c 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -106,7 +106,10 @@ linkgit:git-rev-list[1] for a complete list. 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. - You can specify this option more than once. + 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 From c7d489794caa8f76e8d3cc4ec95b76279333dff1 Mon Sep 17 00:00:00 2001 From: Philippe Blain Date: Sun, 15 Dec 2019 23:15:34 -0500 Subject: [PATCH 2/2] doc: log, gitk: line-log arguments must exist in starting revision The line number, regex or offset parameters and in `git log -L ,:`, or the function name regex in `git log -L ::` must exist in the starting revision, or else the command exits with a fatal error. This is not obvious in the documentation, so add a note to that effect. Signed-off-by: Philippe Blain --- Documentation/git-log.txt | 3 ++- Documentation/gitk.txt | 3 ++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt index 6574c0d91f1000..bed09bb09e52c6 100644 --- a/Documentation/git-log.txt +++ b/Documentation/git-log.txt @@ -76,7 +76,8 @@ produced by `--stat`, etc. (or the function name regex ) within the . 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. + give zero or one positive revision arguments, and + and (or ) 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`, diff --git a/Documentation/gitk.txt b/Documentation/gitk.txt index c487af5b74f81c..c653ebb6a80c03 100644 --- a/Documentation/gitk.txt +++ b/Documentation/gitk.txt @@ -105,7 +105,8 @@ linkgit:git-rev-list[1] for a complete list. (or the function name regex ) within the . 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. + give zero or one positive revision arguments, and + and (or ) 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`,