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

Re: [PATCH] docs/pretty-formats: mention commas in %(trailers) syntax

From
Jacob Keller <jacob.keller@gmail.com>
Date
Dec 9, 2017, 08:06 UTC
Message-ID
<CA+P7+xr6XhnrxSk-jR0HyGksFsjBFkBuEr-RR8U-nEFUpJNJvg@mail.gmail.com>
In-Reply-To
<20171208051636.GA24693@sigill.intra.peff.net>
On Thu, Dec 7, 2017 at 9:16 PM, Jeff King <peff@peff.net> wrote:
Show 40 quoted lines
> Commit 84ff053d47 (pretty.c: delimit "%(trailers)" arguments
> with ",", 2017-10-01) switched the syntax of the trailers
> placeholder, but forgot to update the documentation in
> pretty-formats.txt.
>
> There's need to mention the old syntax; it was never in a
> released version of Git.
>
> Signed-off-by: Jeff King <peff@peff.net>
> ---
> This should go on top of tb/delimit-pretty-trailers-args-with-comma.
>
>  Documentation/pretty-formats.txt | 12 +++++++-----
>  1 file changed, 7 insertions(+), 5 deletions(-)
>
> diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
> index d433d50f81..e664c088a5 100644
> --- a/Documentation/pretty-formats.txt
> +++ b/Documentation/pretty-formats.txt
> @@ -204,11 +204,13 @@ endif::git-rev-list[]
>    than given and there are spaces on its left, use those spaces
>  - '%><(<N>)', '%><|(<N>)': similar to '% <(<N>)', '%<|(<N>)'
>    respectively, but padding both sides (i.e. the text is centered)
> -- %(trailers): display the trailers of the body as interpreted by
> -  linkgit:git-interpret-trailers[1]. If the `:only` option is given,
> -  omit non-trailer lines from the trailer block.  If the `:unfold`
> -  option is given, behave as if interpret-trailer's `--unfold` option
> -  was given. E.g., `%(trailers:only:unfold)` to do both.
> +- %(trailers[:options]): display the trailers of the body as interpreted
> +  by linkgit:git-interpret-trailers[1]. The `trailers` string may be
> +  followed by a colon and zero or more comma-separated options. If the
> +  `only` option is given, omit non-trailer lines from the trailer block.
> +  If the `unfold` option is given, behave as if interpret-trailer's
> +  `--unfold` option was given.  E.g., `%(trailers:only,unfold)` to do
> +  both.
>
>  NOTE: Some placeholders may depend on other options given to the
>  revision traversal engine. For example, the `%g*` reflog options will
> --
> 2.15.1.659.g8bd2eae3ea

HAH. I was recently looking at this documentation and going to send a patch. Looks good besides the other reviewers comments.

Thanks, Jake

Previous: Taylor Blau
Message 7 of 7 in “docs/pretty-formats: mention commas in %(trailers) syntax”
  1. docs/pretty-formats: mention commas in %(trailers) syntaxJeff King, Dec 8, 2017
  2. Eric SunshineDec 8, 2017
  3. Jeff KingDec 8, 2017
  4. Junio C HamanoDec 8, 2017
  5. Junio C HamanoDec 8, 2017
  6. Taylor BlauDec 9, 2017
  7. Jacob KellerDec 9, 2017

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.