doc: pretty-formats describe use of ellipsis in truncation

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>
maint
Philip Oakley 2023-01-19 18:18:26 +00:00 committed by Junio C Hamano
parent 63792c564c
commit b5cd634d7a
1 changed files with 3 additions and 3 deletions

View 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.