git/list[1] front-page[2] threads[3] people[4] search[5] about
 

Re: [PATCH 1/2] Documentation/git-log: document accepted line-log diff formats

From
Derrick Stolee <stolee@gmail.com>
Date
Dec 17, 2019, 15:33 UTC
Message-ID
<ba68e03a-18ff-0fb4-e64a-002b6d6c4d4a@gmail.com>
In-Reply-To
<0ed04a8629a64d15062e13c1f1739b01436a897b.1576559263.git.gitgitgadget@gmail.com>
On 12/17/2019 12:07 AM, Philippe Blain via GitGitGadget wrote:
Show 12 quoted lines
> From: Philippe Blain <levraiphilippeblain@gmail.com>
> 
> Currently the line-log functionality (git log -L) only supports
> displaying patch output (`-p`, its default behavior) and suppressing it
> (`-s`). 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.
> 
> Additionnally, mention that the ':<funcname>' form implies `--function-context`.
s/Additionnally/Additionally/
Show 18 quoted lines
> Signed-off-by: Philippe Blain <levraiphilippeblain@gmail.com>
> ---
>  Documentation/git-log.txt | 6 +++++-
>  Documentation/gitk.txt    | 6 +++++-
>  2 files changed, 10 insertions(+), 2 deletions(-)
> 
> diff --git a/Documentation/git-log.txt b/Documentation/git-log.txt
> index b406bc4c48..1c52bf184d 100644
> --- a/Documentation/git-log.txt
> +++ b/Documentation/git-log.txt
> @@ -77,7 +77,11 @@ 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`.
> +	If ``:<funcname>'' is given, implies `--function-context`.
> +	Patch output can be suppressed using `-s`, but other diff formats

I would prefer the longer "--no-patch" over "-s", especially because you follow with several options in this style.

Show 17 quoted lines
> +	(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 1eabb0aaf3..91993b9d4c 100644
> --- a/Documentation/gitk.txt
> +++ b/Documentation/gitk.txt
> @@ -106,7 +106,11 @@ 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`.
> +	If ``:<funcname>'' is given, implies `--function-context`.
> +	Patch output can be suppressed using `-s`, but other diff formats
(same)
> +	(namely `--raw`, `--numstat`, `--shortstat`, `--dirstat`, `--summary`,
> +	`--name-only`, `--name-status`, `--check`) are not currently implemented.

Thanks, -Stolee

Previous: Philippe BlainNext: Philippe Blain
Message 5 of 18 in “Improve line log documentation”
  1. 0/2 Improve line log documentationPhilippe Blain via GitGitGadget, Dec 17, 2019
  2. 1/2 Documentation/git-log: document accepted line-log diff formatsPhilippe Blain via GitGitGadget, Dec 17, 2019
  3. SZEDER GáborDec 17, 2019
  4. Philippe BlainDec 18, 2019
  5. Derrick StoleeDec 17, 2019
  6. Philippe BlainDec 18, 2019
  7. 2/2 Documentation/git-log: mention that line-log regex must match in starting revisionPhilippe Blain via GitGitGadget, Dec 17, 2019
  8. Derrick StoleeDec 17, 2019
  9. Junio C HamanoDec 17, 2019
  10. Philippe BlainDec 18, 2019
  11. Derrick StoleeDec 18, 2019
  12. SZEDER GáborDec 18, 2019
  13. Junio C HamanoDec 18, 2019
  14. Philippe BlainDec 26, 2019
  15. SZEDER GáborDec 18, 2019
  16. 0/2 Improve line log documentationPhilippe Blain via GitGitGadget, Dec 26, 2019
  17. 1/2 doc: log, gitk: document accepted line-log diff formatsPhilippe Blain via GitGitGadget, Dec 26, 2019
  18. 2/2 doc: log, gitk: line-log arguments must exist in starting revisionPhilippe Blain via GitGitGadget, Dec 26, 2019

Read the whole thread, see it on lore, or plain text.

$ cat FOOTERMessages come from the public archive at lore.kernel.org/git, fetched every hour. The front page is chosen and written each morning by an AI editor and can be wrong; the threads themselves are the record. About and API. For agents: an MCP server at https://gitlist.dev/mcp, and any thread, story or person page as Markdown by adding .md to its URL (or sending Accept: text/markdown). Details in /llms.txt.