Skip to content

pretty: add diff-stat log placeholders#2284

Open
zarandr wants to merge 1 commit into
git:masterfrom
zarandr:master
Open

pretty: add diff-stat log placeholders#2284
zarandr wants to merge 1 commit into
git:masterfrom
zarandr:master

Conversation

@zarandr

@zarandr zarandr commented Apr 26, 2026

Copy link
Copy Markdown

No description provided.

@gitgitgadget-git

Copy link
Copy Markdown

Welcome to GitGitGadget

Hi @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:

  • Your Pull Request has a good description, if it consists of multiple commits, as it will be used as cover letter.
  • Your Pull Request description is empty, if it consists of a single commit, as the commit message should be descriptive enough by itself.

You can CC potential reviewers by adding a footer to the PR description with the following syntax:

CC: Revi Ewer <revi.ewer@example.com>, Ill Takalook <ill.takalook@example.net>

NOTE: DO NOT copy/paste your CC list from a previous GGG PR's description,
because it will result in a malformed CC list on the mailing list. See
example.

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:

  • the lines should not exceed 76 columns,
  • the first line should be like a header and typically start with a prefix like "tests:" or "revisions:" to state which subsystem the change is about, and
  • the commit messages' body should be describing the "why?" of the change.
  • Finally, the commit messages should end in a Signed-off-by: line matching the commits' author.

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 patches

Before 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 /allow. A good way to find other contributors is to locate recent pull requests where someone has been /allowed:

Both the person who commented /allow and the PR author are able to /allow you.

An alternative is the channel #git-devel on the Libera Chat IRC network:

<newcontributor> I've just created my first PR, could someone please /allow me? https://github.com/gitgitgadget/git/pull/12345
<veteran> newcontributor: it is done
<newcontributor> thanks!

Once on the list of permitted usernames, you can contribute the patches to the Git mailing list by adding a PR comment /submit.

If you want to see what email(s) would be sent for a /submit request, add a PR comment /preview to have the email(s) sent to you. You must have a public GitHub email address for this. Note that any reviewers CC'd via the list in the PR description will not actually be sent emails.

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 (raw) link), then import it into your mail program. If you use GMail, you can do this via:

curl -g --user "<EMailAddress>:<Password>" \
    --url "imaps://imap.gmail.com/INBOX" -T /path/to/raw.txt

To 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):

Changes since v1:
- Fixed a typo in the commit message (found by ...)
- Added a code comment to ... as suggested by ...
...

To send a new iteration, just add another PR comment with the contents: /submit.

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, #git-devel on Libera Chat. Remember that IRC does not support offline messaging, so if you send someone a private message and log out, they cannot respond to you. The scrollback of #git-devel is archived, though.

@gitgitgadget-git

Copy link
Copy Markdown

There is an issue in commit e5dff08:
pretty: add diff-stat log placeholders

  • Lines in the body of the commit messages should be wrapped between 60 and 76 characters.
    Indented lines, and lines without whitespace, are exempt

@gitgitgadget-git

Copy link
Copy Markdown

There is an issue in commit 01af6bc:
pretty: add diff-stat log placeholders

  • Commit not signed off

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>
@dscho

dscho commented Apr 30, 2026

Copy link
Copy Markdown
Member

/allow

@gitgitgadget-git

Copy link
Copy Markdown

User zarandr is now allowed to use GitGitGadget.

@zarandr

zarandr commented Apr 30, 2026

Copy link
Copy Markdown
Author

/preview

@gitgitgadget-git

Copy link
Copy Markdown

Preview email sent as pull.2284.git.git.1777575898171.gitgitgadget@gmail.com

@zarandr

zarandr commented Apr 30, 2026

Copy link
Copy Markdown
Author

/submit

@gitgitgadget-git

Copy link
Copy Markdown

Submitted as pull.2284.git.git.1777578903593.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-2284/zarandr/master-v1

To fetch this version to local tag pr-git-2284/zarandr/master-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-2284/zarandr/master-v1

@gitgitgadget-git

Copy link
Copy Markdown

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?

@gitgitgadget-git

Copy link
Copy Markdown

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.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants