]> Kevux Git Server - rit/commitdiff
doc: pretty-formats describe use of ellipsis in truncation
authorPhilip Oakley <philipoakley@iee.email>
Thu, 19 Jan 2023 18:18:26 +0000 (18:18 +0000)
committerJunio C Hamano <gitster@pobox.com>
Thu, 19 Jan 2023 22:35:15 +0000 (14:35 -0800)
Commit a7f01c6b4d (pretty: support truncating in %>, %< and %><,
2013-04-19) added the use of ellipsis when truncating placeholder
values.

Show our 'two dot' ellipsis, and examples for the left, middle and
right truncation to avoid any confusion as to which end of the string
is adjusted. (cf justification and sub-string).

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

index cbca60a..e51f1e5 100644 (file)
@@ -149,9 +149,9 @@ The placeholders are:
 '%<( <N> [,trunc|ltrunc|mtrunc])':: make the next placeholder take at
                                  least N column widths, padding spaces on
                                  the right if necessary.  Optionally
-                                 truncate at the beginning (ltrunc),
-                                 the middle (mtrunc) or the end
-                                 (trunc) if the output is longer than
+                                 truncate (with ellipsis '..') at the left (ltrunc) `..ft`,
+                                 the middle (mtrunc) `mi..le`, or the end
+                                 (trunc) `rig..`, if the output is longer than
                                  N columns.
                                  Note 1: that truncating
                                  only works correctly with N >= 2.