kernel
/
git
mirror of https://git.kernel.org/pub/scm/git/git.git
1
0
Fork 0
Code Releases Activity

Merge branch 'kh/format-rev-doc-synopsis' 

The documentation for 'git format-rev' has been updated to use the
[synopsis] block definition on code blocks to properly highlight
placeholders, and a quoting inconsistency in the running text has
been fixed.

* kh/format-rev-doc-synopsis:
  doc: format-rev: use [synopsis] on code block
  doc: format-rev: quote subject placeholder before and after
main
Junio C Hamano 2026-08-28 11:04:57 -07:00
parent f78ce2f7b6 634257a89b
commit 9c94d206f0
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
Documentation/git-format-rev.adoc
View File

@ -93,12 +93,13 @@ acts as a _terminator_, not a _separator_. In other words, the final
line or record is also terminated by the terminator character.

The mode `--stdin-mode=text` replaces each object name with the
formatted commit, i.e. the format `%s` would transform some commit
object name to `<subject>` without any termination. Like this:
formatted commit, i.e. the format `"%s"` would transform some commit
object name to `"<subject>"` without any termination. Like this:

----
[synopsis]
--
Did we not fix this in "<subject>"?
----
--

It is safe to interactively read and write from this command since each
record is immediately flushed.