doc: pretty-formats: delineate `%<|(` parameter values
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>
Philip Oakley committed
Jan 19, 2023 at 18:18 UTC
8bcb8f8e2282ff27f7ffd106eb2fb7bf982ff2d1
1 file changed
+7
-7
Documentation/pretty-formats.txt
+7
-7
@@ -147,7 +147,7 @@ The placeholders are:
147
'%w([<w>[,<i1>[,<i2>]]])':: switch line wrapping, like the -w option of
148
linkgit:git-shortlog[1].
149
'%<( <N> [,trunc|ltrunc|mtrunc])':: make the next placeholder take at
150
- least N columns, padding spaces on
150
+ least N column widths, padding spaces on
151
the right if necessary. Optionally
152
truncate at the beginning (ltrunc),
153
the middle (mtrunc) or the end
@@ -155,18 +155,18 @@ The placeholders are:
155
N columns.
156
Note 1: that truncating
157
only works correctly with N >= 2.
158
- Note 2: spaces around the N
158
+ Note 2: spaces around the N and M (see below)
159
values are optional.
160
-'%<|( <N> )':: make the next placeholder take at least until Nth
161
- columns, padding spaces on the right if necessary
162
-'%>( <N> )', '%>|( <N> )':: similar to '%<( <N> )', '%<|( <N> )' respectively,
160
+'%<|( <M> )':: make the next placeholder take at least until Mth
161
+ display column, padding spaces on the right if necessary
162
+'%>( <N> )', '%>|( <M> )':: similar to '%<( <N> )', '%<|( <M> )' respectively,
163
but padding spaces on the left
164
-'%>>( <N> )', '%>>|( <N> )':: similar to '%>( <N> )', '%>|( <N> )'
164
+'%>>( <N> )', '%>>|( <M> )':: similar to '%>( <N> )', '%>|( <M> )'
165
respectively, except that if the next
166
placeholder takes more spaces than given and
167
there are spaces on its left, use those
168
spaces
169
-'%><( <N> )', '%><|( <N> )':: similar to '%<( <N> )', '%<|( <N> )'
169
+'%><( <N> )', '%><|( <M> )':: similar to '%<( <N> )', '%<|( <M> )'
170
respectively, but padding both sides
171
(i.e. the text is centered)
172