Please use portname in first line of git commit message

Adriaan de Groot adridg at freebsd.org
Wed Apr 7 09:35:35 UTC 2021


Not picking on Wen Heping, but purely as an example, here's a commit message 
from today, with the email subject:

On Wednesday, 7 April 2021 10:48:22 CEST Wen Heping wrote:
> git: 8a7bd1522fcd - main - - Update to 3.3.2

In the before times, that would might have looked something like this:

> svn commit: r569270 - head/audio/zynaddsubfx

The git email doesn't know what paths have been committed, and "just" uses the 
first line of the commit message. Many people now use

<category>/<port>: <change summary>

as the first line of the commit message, also because "git log" doesn't show 
files by default, and convenient git-history viewers like gitk and qgit show 
the first line. Using this format for the first line of a commit message 
(followed by one blank line) helps all consumers of the git tree -- you can 
spot a couple by me that do *not* follow this format as well, that was before 
I realised that "this can be better".

[ade]
-------------- next part --------------
A non-text attachment was scrubbed...
Name: signature.asc
Type: application/pgp-signature
Size: 659 bytes
Desc: This is a digitally signed message part.
URL: <http://lists.freebsd.org/pipermail/dev-commits-ports-all/attachments/20210407/6e3d0370/attachment.sig>


More information about the dev-commits-ports-all mailing list