From: Philip Oakley <philipoakley@iee.email>
To: GitList <git@vger.kernel.org>, Junio C Hamano <gitster@pobox.com>
Cc: Taylor Blau <me@ttaylorr.com>,
NSENGIYUMVA WILBERFORCE <nsengiyumvawilberforce@gmail.com>,
self <philipoakley@iee.email>
Subject: [PATCH v5 0/5] Pretty formats: Clarify column alignment
Date: Thu, 19 Jan 2023 18:18:22 +0000 [thread overview]
Message-ID: <20230119181827.1319-1-philipoakley@iee.email> (raw)
In-Reply-To: <20221112143616.1429-1-philipoakley@iee.email>
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(-)
--
2.39.1.windows.1
next prev parent reply other threads:[~2023-01-19 18:20 UTC|newest]
Thread overview: 30+ messages / expand[flat|nested] mbox.gz Atom feed top
2022-10-30 18:56 [PATCH 0/1] extend the truncating pretty formats Philip Oakley
2022-10-30 18:56 ` [PATCH 1/1] pretty-formats: add hard truncation, without ellipsis, options Philip Oakley
2022-10-30 19:23 ` Taylor Blau
2022-10-30 22:01 ` Philip Oakley
2022-10-30 23:42 ` Taylor Blau
2022-10-30 21:41 ` [PATCH 0/1] extend the truncating pretty formats Philip Oakley
2022-11-01 22:57 ` [PATCH v2 " Philip Oakley
2022-11-01 22:57 ` [PATCH v2 1/1] pretty-formats: add hard truncation, without ellipsis, options Philip Oakley
2022-11-01 23:05 ` Philip Oakley
2022-11-02 0:45 ` Taylor Blau
2022-11-02 12:08 ` [PATCH v3] " Philip Oakley
2022-11-12 14:36 ` [PATCH v4] " Philip Oakley
2022-11-21 0:34 ` Junio C Hamano
2022-11-21 18:10 ` Philip Oakley
2022-11-22 0:57 ` Junio C Hamano
2022-11-23 14:26 ` Philip Oakley
2022-11-25 7:11 ` Junio C Hamano
2022-11-26 14:32 ` Philip Oakley
2022-11-26 22:44 ` Philip Oakley
2022-11-26 23:19 ` Junio C Hamano
2022-11-28 13:39 ` Philip Oakley
2022-11-29 0:18 ` Junio C Hamano
2022-12-07 0:24 ` Philip Oakley
2022-12-07 0:54 ` Junio C Hamano
2023-01-19 18:18 ` Philip Oakley [this message]
2023-01-19 18:18 ` [PATCH v5 1/5] doc: pretty-formats: separate parameters from placeholders Philip Oakley
2023-01-19 18:18 ` [PATCH v5 2/5] doc: pretty-formats: delineate `%<|(` parameter values Philip Oakley
2023-01-19 18:18 ` [PATCH v5 3/5] doc: pretty-formats document negative column alignments Philip Oakley
2023-01-19 18:18 ` [PATCH v5 4/5] doc: pretty-formats describe use of ellipsis in truncation Philip Oakley
2023-01-19 18:18 ` [PATCH v5 5/5] doc: pretty-formats note wide char limitations, and add tests Philip Oakley
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
List information: http://vger.kernel.org/majordomo-info.html
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20230119181827.1319-1-philipoakley@iee.email \
--to=philipoakley@iee.email \
--cc=git@vger.kernel.org \
--cc=gitster@pobox.com \
--cc=me@ttaylorr.com \
--cc=nsengiyumvawilberforce@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
Code repositories for project(s) associated with this public inbox
https://80x24.org/mirrors/git.git
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).