Skip to content

commit -v: add --word-diff opt to commit template#2276

Open
kraktus wants to merge 1 commit into
git:masterfrom
kraktus:gdiff_word_commit
Open

commit -v: add --word-diff opt to commit template#2276
kraktus wants to merge 1 commit into
git:masterfrom
kraktus:gdiff_word_commit

Conversation

@kraktus
Copy link
Copy Markdown

@kraktus kraktus commented Apr 20, 2026

No description provided.

@gitgitgadget-git
Copy link
Copy Markdown

Welcome to GitGitGadget

Hi @kraktus, 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

Invalid author email in e15c389: "kraktus@users.noreply.github.com"

@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 20, 2026

/allow

@kraktus kraktus force-pushed the gdiff_word_commit branch from e15c389 to 2923136 Compare April 20, 2026 17:14
@gitgitgadget-git
Copy link
Copy Markdown

User kraktus is now allowed to use GitGitGadget.

WARNING: kraktus has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 20, 2026

@kraktus you will need to use git commit --amend --signoff

`--word-diff` was available for the `diff` command, but not for
the `commit` one, whereas it is very useful when updating column-based
data-format like CSV for example.

Only support the PORCELAIN mode for now, but if deemed necessary can
add plain too, I don't think COLOR makes sense when outputting a file.

Signed-off-by: kraktus <rinses-riotous8n@icloud.com>
@kraktus kraktus force-pushed the gdiff_word_commit branch from 2923136 to 475722d Compare April 20, 2026 17:16
@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

hey @dscho, thanks for the quick follow-up, done

@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 20, 2026

hey @dscho, thanks for the quick follow-up, done

Excellent!

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

User kraktus is now allowed to use GitGitGadget.

WARNING: kraktus has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

I'd have thought it'd use the author email, but will do.

@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 20, 2026

WARNING: kraktus has no public email address set on GitHub; GitGitGadget needs an email address to Cc: you on your contribution, so that you receive any feedback on the Git mailing list. Go to https://github.com/settings/profile to make your preferred email public to let GitGitGadget know which email address to use.

I'd have thought it'd use the author email, but will do.

The author email can be completely bogus. But a public email address set on GitHub will have been verified by GitHub ;-)

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

/preview

@gitgitgadget-git
Copy link
Copy Markdown

Error: Could not determine full name of kraktus

@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 20, 2026

Error: Could not determine full name of kraktus

Hmm. Let me investigate what this means.

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

/preview

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

Error: Could not determine full name of kraktus

Hmm. Let me investigate what this means.

I assume that was because I didn't have set a name on my GitHub profile

@dscho
Copy link
Copy Markdown
Member

dscho commented Apr 20, 2026

Error: Could not determine full name of kraktus

Hmm. Let me investigate what this means.

I assume that was because I didn't have set a name on my GitHub profile

Indeed! Excellent guess ;-)

@gitgitgadget-git
Copy link
Copy Markdown

Preview email sent as pull.2276.git.git.1776714460317.gitgitgadget@gmail.com

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

Error: Could not determine full name of kraktus

Hmm. Let me investigate what this means.

I assume that was because I didn't have set a name on my GitHub profile

Indeed! Excellent guess ;-)

Found back a patch of yours being more lenient in 2021 ;) https://github.com/gitgitgadget/gitgitgadget/pull/412/changes

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 20, 2026

/submit

@gitgitgadget-git
Copy link
Copy Markdown

Submitted as pull.2276.git.git.1776716038088.gitgitgadget@gmail.com

To fetch this version into FETCH_HEAD:

git fetch https://github.com/gitgitgadget/git/ pr-git-2276/kraktus/gdiff_word_commit-v1

To fetch this version to local tag pr-git-2276/kraktus/gdiff_word_commit-v1:

git fetch --no-tags https://github.com/gitgitgadget/git/ tag pr-git-2276/kraktus/gdiff_word_commit-v1

@kraktus
Copy link
Copy Markdown
Author

kraktus commented Apr 29, 2026

What's the appropriate timescale to bump it on the mailing list?

@kraktus
Copy link
Copy Markdown
Author

kraktus commented May 14, 2026

What's the appropriate timescale to bump it on the mailing list?

bump, cc @dscho in case you know :)

@dscho
Copy link
Copy Markdown
Member

dscho commented May 14, 2026

What's the appropriate timescale to bump it on the mailing list?

Personally, I replied to my patches after at most a week with a gentle ping. You might want to do the same.

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