diff options
| author | Junio C Hamano <gitster@pobox.com> | 2026-08-28 11:04:57 -0700 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2026-08-28 11:04:57 -0700 |
| commit | 9c94d206f01cb6eb9305d44afed6209496c5a773 (patch) | |
| tree | 163b14d268dd9885b1f13a5379c96ae75d8e7c7c | |
| parent | f78ce2f7b6df702f93d40b85d6bda92a3f65da79 (diff) | |
| parent | 634257a89b4619ff14f9e7c75cc2645e52d8702b (diff) | |
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
| -rw-r--r-- | Documentation/git-format-rev.adoc | 9 |
1 files changed, 5 insertions, 4 deletions
diff --git a/Documentation/git-format-rev.adoc b/Documentation/git-format-rev.adoc index 505a52fecc..c2268c92b5 100644 --- a/Documentation/git-format-rev.adoc +++ b/Documentation/git-format-rev.adoc @@ -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. |