diff mbox series

[v3,1/7] pretty-formats: define "literal formatting code"

Message ID 20230810211619.19055-1-andy.koppe@gmail.com (mailing list archive)
State Accepted
Commit 014aa1d1aae2548c644959bdba766a66b6a7f5cb
Headers show
Series [v3,1/7] pretty-formats: define "literal formatting code" | expand

Commit Message

Andy Koppe Aug. 10, 2023, 9:16 p.m. UTC 
From: Junio C Hamano <gitster@pobox.com>

The description for a %(trailer) option already uses this term without
having a definition anywhere in the document, and we are about to add
another one in %(decorate) that uses it.

Signed-off-by: Junio C Hamano <gitster@pobox.com>
Signed-off-by: Andy Koppe <andy.koppe@gmail.com>
---
 Documentation/pretty-formats.txt | 4 +++-
 1 file changed, 3 insertions(+), 1 deletion(-)

Comments

Junio C Hamano Aug. 16, 2023, 4:23 a.m. UTC | #1 
The v3 iteration of the series that begins at

  https://lore.kernel.org/git/20230810211619.19055-1-andy.koppe@gmail.com/

08-10 ` [PATCH v3 1/7] pretty-formats: define "literal formatting code"
08-10   ` [PATCH v3 2/7] pretty-formats: enclose options in angle brackets
08-10   ` [PATCH v3 3/7] decorate: refactor format_decorations()
08-10   ` [PATCH v3 4/7] decorate: avoid some unnecessary color overhead
08-10   ` [PATCH v3 5/7] decorate: color each token separately
08-10   ` [PATCH v3 6/7] pretty: add %(decorate[:<options>]) format
08-10   ` [PATCH v3 7/7] pretty: add pointer and tag options to %(decorate)

unfortunately did not see any discussion.  Any comments?
diff mbox series

Patch

diff --git a/Documentation/pretty-formats.txt b/Documentation/pretty-formats.txt
index 3b71334459..5e1432951b 100644
--- a/Documentation/pretty-formats.txt
+++ b/Documentation/pretty-formats.txt
@@ -122,7 +122,9 @@  The placeholders are:
 - Placeholders that expand to a single literal character:
 '%n':: newline
 '%%':: a raw '%'
-'%x00':: print a byte from a hex code
+'%x00':: '%x' followed by two hexadecimal digits is replaced with a
+	 byte with the hexadecimal digits' value (we will call this
+	 "literal formatting code" in the rest of this document).
 
 - Placeholders that affect formatting of later placeholders:
 '%Cred':: switch color to red