pretty: add diff-stat log placeholders#2284
Conversation
Welcome to GitGitGadgetHi @zarandr, and welcome to GitGitGadget, the GitHub App to send patch series to the Git mailing list from GitHub Pull Requests. Please make sure that either:
You can CC potential reviewers by adding a footer to the PR description with the following syntax: NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description, Also, it is a good idea to review the commit messages one last time, as the Git project expects them in a quite specific form:
It is in general a good idea to await the automated test ("Checks") in this Pull Request before contributing the patches, e.g. to avoid trivial issues such as unportable code. Contributing the patchesBefore you can contribute the patches, your GitHub username needs to be added to the list of permitted users. Any already-permitted user can do that, by adding a comment to your PR of the form Both the person who commented An alternative is the channel Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment If you want to see what email(s) would be sent for a After you submit, GitGitGadget will respond with another comment that contains the link to the cover letter mail in the Git mailing list archive. Please make sure to monitor the discussion in that thread and to address comments and suggestions (while the comments and suggestions will be mirrored into the PR by GitGitGadget, you will still want to reply via mail). If you do not want to subscribe to the Git mailing list just to be able to respond to a mail, you can download the mbox from the Git mailing list archive (click the curl -g --user "<EMailAddress>:<Password>" \
--url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txtTo iterate on your change, i.e. send a revised patch or patch series, you will first want to (force-)push to the same branch. You probably also want to modify your Pull Request description (or title). It is a good idea to summarize the revision by adding something like this to the cover letter (read: by editing the first comment on the PR, i.e. the PR description): To send a new iteration, just add another PR comment with the contents: Need help?New contributors who want advice are encouraged to join git-mentoring@googlegroups.com, where volunteers who regularly contribute to Git are willing to answer newbie questions, give advice, or otherwise provide mentoring to interested contributors. You must join in order to post or view messages, but anyone can join. You may also be able to find help in real time in the developer IRC channel, |
|
There is an issue in commit e5dff08:
|
|
There is an issue in commit 01af6bc:
|
Currently, users who want per-commit line/file change counts in a custom log format must post-process `git log --shortstat` output because the pretty formatter exposes no equivalent placeholders. Introduce `%(diff-stat:files)`, `%(diff-stat:insertions)`, `%(diff-stat:deletions)`, and `%(diff-stat:lines)`, computed from the same diffstat machinery as `--shortstat` and cached once per commit during format expansion. Short aliases are provided as `%aF`, `%aA`, and `%aR`. The requested `%aI` and `%aD` forms are unavailable because those names already expand to author dates, so use additions/removals mnemonics instead. When log output is already walking a diff, the formatter reuses the current diff queue. Otherwise it computes a private summary lazily, so formats without these placeholders still pay no diff cost. Signed-off-by: Andrey Zarubin <zarandr@gmail.com>
|
/allow |
|
User zarandr is now allowed to use GitGitGadget. |
|
/preview |
|
Preview email sent as pull.2284.git.git.1777575898171.gitgitgadget@gmail.com |
|
/submit |
|
Submitted as pull.2284.git.git.1777578903593.gitgitgadget@gmail.com To fetch this version into To fetch this version to local tag |
|
Junio C Hamano wrote on the Git mailing list (how to reply to this email): "Andrey Zarubin via GitGitGadget" <gitgitgadget@gmail.com> writes:
> From: Andrey Zarubin <zarandr@gmail.com>
>
> Currently, users who want per-commit line/file change counts in
> a custom log format must post-process `git log --shortstat`
> output because the pretty formatter exposes no equivalent
> placeholders.
>
> Introduce `%(diff-stat:files)`, `%(diff-stat:insertions)`,
> `%(diff-stat:deletions)`, and `%(diff-stat:lines)`, computed
> from the same diffstat machinery as `--shortstat` and cached
> once per commit during format expansion.
>
> Short aliases are provided as `%aF`, `%aA`, and `%aR`. The
> requested `%aI` and `%aD` forms are unavailable because those
> names already expand to author dates, so use additions/removals
> mnemonics instead.
>
> When log output is already walking a diff, the formatter reuses
> the current diff queue. Otherwise it computes a private summary
> lazily, so formats without these placeholders still pay no diff
> cost.
>
> Signed-off-by: Andrey Zarubin <zarandr@gmail.com>
> ---
> pretty: add diff-stat log placeholders
Personally I find this a bit on the other side of the line between
sensible and insanity. Will we next be adding a new placeholder to
show the summary (i.e. list of created, deleted, and renamed paths)
and another placeholder to show the entire patch text?
|
|
Andrey Zarubin wrote on the Git mailing list (how to reply to this email): On Mon, May 4, 2026 at 8:09 AM Junio C Hamano <gitster@pobox.com> wrote:
>
> "Andrey Zarubin via GitGitGadget" <gitgitgadget@gmail.com> writes:
>
> > From: Andrey Zarubin <zarandr@gmail.com>
> >
> > Currently, users who want per-commit line/file change counts in
> > a custom log format must post-process `git log --shortstat`
> > output because the pretty formatter exposes no equivalent
> > placeholders.
> >
> > Introduce `%(diff-stat:files)`, `%(diff-stat:insertions)`,
> > `%(diff-stat:deletions)`, and `%(diff-stat:lines)`, computed
> > from the same diffstat machinery as `--shortstat` and cached
> > once per commit during format expansion.
> >
> > Short aliases are provided as `%aF`, `%aA`, and `%aR`. The
> > requested `%aI` and `%aD` forms are unavailable because those
> > names already expand to author dates, so use additions/removals
> > mnemonics instead.
> >
> > When log output is already walking a diff, the formatter reuses
> > the current diff queue. Otherwise it computes a private summary
> > lazily, so formats without these placeholders still pay no diff
> > cost.
> >
> > Signed-off-by: Andrey Zarubin <zarandr@gmail.com>
> > ---
> > pretty: add diff-stat log placeholders
>
> Personally I find this a bit on the other side of the line between
> sensible and insanity. Will we next be adding a new placeholder to
> show the summary (i.e. list of created, deleted, and renamed paths)
> and another placeholder to show the entire patch text?
I see the concern, and I agree that placeholders for `--summary` or
full patch text would cross that line.
The distinction I had in mind is that these are bounded scalar values,
not diff output. They are the same three counters already produced by
`--shortstat`, and the main use case is one-line structured log output
where today callers have to run `git log --shortstat` and parse/correlate
the human-oriented output after the fact.
Path summaries and patch text are qualitatively different: they are
multi-line, formatting-heavy, affected by quoting/color/output choices,
and would effectively embed diff output inside the pretty formatter. I
would not want this change to imply support for that direction.
If the short aliases make this feel too much like expanding the kitchen
sink, I can drop them and keep only the explicit
`%(diff-stat:<field>)` forms. I think the long forms make the intended
scope clearer: numeric shortstat counters only. |
No description provided.