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

Re: [PATCH 1/9] doc: convert git-log to new documentation format

From
Junio C Hamano <gitster@pobox.com>
Date
Jun 16, 2025, 23:02 UTC
Message-ID
<xmqq5xgvz3ws.fsf@gitster.g>
In-Reply-To
<1ce06a184817d0493f4e56725aeb8ed5ccae1ba4.1749373787.git.gitgitgadget@gmail.com>
"Jean-Noël Avila via GitGitGadget" <gitgitgadget@gmail.com> writes:
Show 13 quoted lines
> From: =?UTF-8?q?Jean-No=C3=ABl=20Avila?= <jn.avila@free.fr>
>
> - Switch the synopsis to a synopsis block which will automatically
>   format placeholders in italics and keywords in monospace
> - Use _<placeholder>_ instead of <placeholder> in the description
> - Use `backticks` for keywords and more complex option
> descriptions. The new rendering engine will apply synopsis rules to
> these spans.
>
> Signed-off-by: Jean-Noël Avila <jn.avila@free.fr>
> ---
>  Documentation/git-log.adoc | 83 ++++++++++++++++++++------------------
>  1 file changed, 44 insertions(+), 39 deletions(-)
This hunk (lightly edited to shift contexts) ...
Show 27 quoted lines
> ---no-decorate::
> ---decorate[=short|full|auto|no]::
> -	Print out the ref names of any commits that are shown. If 'short' is
> -	specified, the ref name prefixes 'refs/heads/', 'refs/tags/' and
> -	'refs/remotes/' will not be printed. If 'full' is specified, the
> -	full ref name (including prefix) will be printed. If 'auto' is
> -	specified, then if the output is going to a terminal, the ref names
> -	are shown as if 'short' were given, otherwise no ref names are
> -	shown. The option `--decorate` is short-hand for `--decorate=short`.
> -	Default to configuration value of `log.decorate` if configured,
> -	otherwise, `auto`.
> +`--no-decorate`::
> +`--decorate[=(short|full|auto|no)]`::
> +	Print out the ref names of any commits that are shown. Possible values
> +	are:
> ++
> +----
> +`short`;; the ref name prefixes `refs/heads/`, `refs/tags/` and
> +	`refs/remotes/` are not printed.
> +`full`;; the full ref name (including prefix) is printed.
> +`auto`:: if the output is going to a terminal, the ref names
> +	are shown as if `short` were given, otherwise no ref names are
> +	shown.
> +----
> ++
> +The option `--decorate` is short-hand for `--decorate=short`. Default to
> +configuration value of `log.decorate` if configured, otherwise, `auto`.

... does more than what the three-bullet list in the proposed log message describes. The result is certainly easier to follow and more extensible to have these possible values in an enumerated list than in a prose.

Show 7 quoted lines
> +`--decorate-refs=<pattern>`::
> +`--decorate-refs-exclude=<pattern>`::
>  	For each candidate reference, do not use it for decoration if it
> -	matches any patterns given to `--decorate-refs-exclude` or if it
> -	doesn't match any of the patterns given to `--decorate-refs`. The
> +	matches any of _<pattern>_ given to `--decorate-refs-exclude` or if it
> +	doesn't match any of _<pattern>_ given to `--decorate-refs`. The

"any patterns" in the original may not be grammatical, but the rewritten "any of _<pattern>_" does not sound grammatical, either. "any of the _<pattern>_s"? I dunno what the convention should be when more than one <placeholder> instances have to be referenced.

Previous: Jean-Noël Avila via GitGitGadgetNext: Jean-Noël AVILA
Message 3 of 50 in “Doc git log”
  1. 0/9 Doc git logJean-Noël Avila via GitGitGadget, Jun 8, 2025
  2. 1/9 doc: convert git-log to new documentation formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  3. Junio C HamanoJun 16, 2025
  4. Jean-Noël AVILAJun 19, 2025
  5. 2/9 doc: git-log convert rev-list-description to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  6. Junio C HamanoJun 19, 2025
  7. Jean-Noël AVILAJun 19, 2025
  8. 3/9 doc: git-log: convert line range options to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  9. 4/9 doc: git-log: convert line range format to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  10. 6/9 doc: git-log: convert pretty options to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  11. 5/9 doc: git-log: convert rev list options to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  12. 8/9 doc: git-log: convert diff options to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  13. 7/9 doc: git-log: convert pretty formats to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  14. Kristoffer HaugsbakkJul 4, 2025
  15. Kristoffer HaugsbakkJul 4, 2025
  16. Jean-Noël AVILAJul 6, 2025
  17. 9/9 doc: git-log: convert log config to new doc formatJean-Noël Avila via GitGitGadget, Jun 8, 2025
  18. Junio C HamanoJun 18, 2025
  19. Jean-Noël AVILAJul 6, 2025
  20. 0/9 doc: convert git log man page to new synopsis formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  21. 1/9 doc: convert git-log to new documentation formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  22. 2/9 doc: git-log convert rev-list-description to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  23. 3/9 doc: git-log: convert line range options to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  24. 4/9 doc: git-log: convert line range format to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  25. 6/9 doc: git-log: convert pretty options to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  26. Kristoffer HaugsbakkJul 4, 2025
  27. 5/9 doc: git-log: convert rev list options to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  28. 7/9 doc: git-log: convert pretty formats to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  29. 8/9 doc: git-log: convert diff options to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  30. 9/9 doc: git-log: convert log config to new doc formatJean-Noël Avila via GitGitGadget, Jun 29, 2025
  31. 0/9 doc: convert git log man page to new synopsis formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  32. 1/9 doc: convert git-log to new documentation formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  33. 2/9 doc: git-log convert rev-list-description to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  34. 3/9 doc: git-log: convert line range options to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  35. 4/9 doc: git-log: convert line range format to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  36. 6/9 doc: git-log: convert pretty options to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  37. 5/9 doc: git-log: convert rev list options to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  38. 7/9 doc: git-log: convert pretty formats to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  39. SZEDER GáborAug 17, 2025
  40. doc: fix asciidoc format compatibility in pretty-formats.adocJean-Noël Avila, Aug 19, 2025
  41. Junio C HamanoAug 19, 2025
  42. doc: fix asciidoc format compatibility in pretty-formats.adocJean-Noël Avila, Aug 20, 2025
  43. doc: fix asciidoc format compatibility in pretty-formats.adocJean-Noël Avila, Aug 20, 2025
  44. Junio C HamanoAug 20, 2025
  45. Jean-Noël AVILAAug 20, 2025
  46. doc: fix asciidoc format compatibility in pretty-formats.adocJean-Noël Avila, Aug 20, 2025
  47. 8/9 doc: git-log: convert diff options to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  48. 9/9 doc: git-log: convert log config to new doc formatJean-Noël Avila via GitGitGadget, Jul 7, 2025
  49. Junio C HamanoJul 7, 2025
  50. Jean-Noël AVILAJul 7, 2025

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.