]> git.ipfire.org Git - thirdparty/git.git/commitdiff
doc: pretty-formats: delineate `%<|(` parameter values
authorPhilip Oakley <philipoakley@iee.email>
Thu, 19 Jan 2023 18:18:24 +0000 (18:18 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 19 Jan 2023 22:35:15 +0000 (14:35 -0800)
Commit a57523428b4 (pretty: support padding placeholders, %< %> and %><,
2013-04-19) introduced column width place holders. It also added
separate column position `%<|(` placeholders for display screen based
placement.

Change the display screen parameter reference from 'N' to 'M' and
corresponding descriptives to make the distinction clearer.

Signed-off-by: Philip Oakley <philipoakley@iee.email>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
Documentation/pretty-formats.txt

index 02bec2350906d8218afa21b961fd62295dc00f92..8cc1072196ef04678548a41f0816ac5354f66afe 100644 (file)
@@ -147,7 +147,7 @@ The placeholders are:
 '%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
                            linkgit:git-shortlog[1].
 '%<( <N> [,trunc|ltrunc|mtrunc])':: make the next placeholder take at
-                                 least N columns, padding spaces on
+                                 least N column widths, padding spaces on
                                  the right if necessary.  Optionally
                                  truncate at the beginning (ltrunc),
                                  the middle (mtrunc) or the end
@@ -155,18 +155,18 @@ The placeholders are:
                                  N columns.
                                  Note 1: that truncating
                                  only works correctly with N >= 2.
-                                 Note 2: spaces around the N
+                                 Note 2: spaces around the N and M (see below)
                                  values are optional.
-'%<|( <N> )':: make the next placeholder take at least until Nth
-            columns, padding spaces on the right if necessary
-'%>( <N> )', '%>|( <N> )':: similar to '%<( <N> )', '%<|( <N> )' respectively,
+'%<|( <M> )':: make the next placeholder take at least until Mth
+            display column, padding spaces on the right if necessary
+'%>( <N> )', '%>|( <M> )':: similar to '%<( <N> )', '%<|( <M> )' respectively,
                        but padding spaces on the left
-'%>>( <N> )', '%>>|( <N> )':: similar to '%>( <N> )', '%>|( <N> )'
+'%>>( <N> )', '%>>|( <M> )':: similar to '%>( <N> )', '%>|( <M> )'
                          respectively, except that if the next
                          placeholder takes more spaces than given and
                          there are spaces on its left, use those
                          spaces
-'%><( <N> )', '%><|( <N> )':: similar to '%<( <N> )', '%<|( <N> )'
+'%><( <N> )', '%><|( <M> )':: similar to '%<( <N> )', '%<|( <M> )'
                          respectively, but padding both sides
                          (i.e. the text is centered)