[PATCH v5 0/5] Pretty formats: Clarify column alignment

This is a follow up to earlier versions of the series [1,2,3,4] that looked to add left and right hard truncation of the column limited placeholders.

Taylor had provided an early review at [5].

Junio identified [6] that one problem would be that wide characters may need to be cut in half and this wasn't properly covered.

I noted that there were other existing complications, and the wide character problem could already be seen with particular placeholders.

I said I would at least update the docs [7] to cover features that weren't fully documented and add a few simple tests to show the wide character and other discovered problems.

The series now has 5 patches. The first four add documentation to match their original code changes.

The final patch adds the tests for the special character cases, and adds a cautionary note to the docs.

The added tests make assumptions as to the desired solution in the 'expect' result, and alternatives are discussed as to how to 'split' a wide character to fit a single column when required to fit to column limits.

This series is unaffected by the security fix (CVE-2022-41903 size_t/int) in Git 2.39.1 [8] within this formatting code.

Philip

[1] https://lore.kernel.org/git/20221030185614.3842-1-philipoakley@iee.email/ [PATCH 0/1] extend the truncating pretty formats [2] https://lore.kernel.org/git/20221101225724.2165-1-philipoakley@iee.email/ [PATCH v2 0/1] extend the truncating pretty formats [3] https://lore.kernel.org/git/20221102120853.2013-1-philipoakley@iee.email/ [PATCH v3] pretty-formats: add hard truncation, without ellipsis, options [4] https://lore.kernel.org/git/20221112143616.1429-1-philipoakley@iee.email/ [PATCH v4] pretty-formats: add hard truncation, without ellipsis, options [5] https://lore.kernel.org/git/Y17PS%2F2LgRIJKGoo@nand.local/ (Taylor: t4205-log-pretty-formats.sh. Is that coverage ..) [6] https://lore.kernel.org/git/xmqqfsedywli.fsf@gitster.g/ (Junio: Imagine there are series of wide characters,...) [7] https://lore.kernel.org/git/093e1dca-b9d4-f1f2-0845-ad6711622cf5@iee.email/ (po: I'll at least work on the doc clarification..) [8] https://lore.kernel.org/git/xmqq7cxl9h0i.fsf@gitster.g/

Philip Oakley (5):
  doc: pretty-formats: separate parameters from placeholders
  doc: pretty-formats: delineate `%<|(` parameter values
  doc: pretty-formats document negative column alignments
  doc: pretty-formats describe use of ellipsis in truncation
  doc: pretty-formats note wide char limitations, and add tests

 Documentation/pretty-formats.txt | 32 +++++++++++++++++++++-----------
 t/t4205-log-pretty-formats.sh    | 27 +++++++++++++++++++++++++++
 2 files changed, 48 insertions(+), 11 deletions(-)