Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 20 Apr 2021 11:25:16 +0200
From:      Michael Gmelin <grembo@freebsd.org>
To:        Dmitry Sivachenko <demon@freebsd.org>
Cc:        Yuri <yuri@freebsd.org>, ports-committers <ports-committers@freebsd.org>, dev-commits-ports-all@freebsd.org, dev-commits-ports-main@freebsd.org
Subject:   Re: git: d3ba089a5212 - main - Update to version 2.2.13.
Message-ID:  <FB1DA78E-B05E-4243-95A6-0A76CA6A1E79@freebsd.org>
In-Reply-To: <8A878FAE-FEBA-466A-AEC4-DD588028C0EC@FreeBSD.org>
References:  <8A878FAE-FEBA-466A-AEC4-DD588028C0EC@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help


> On 20. Apr 2021, at 10:57, Dmitry Sivachenko <demon@freebsd.org> wrote:
>=20
> =EF=BB=BF
>=20
>>> On 20 Apr 2021, at 02:07, Michael Gmelin <grembo@FreeBSD.org> wrote:
>>>=20
>>>=20
>>>=20
>>>> On 20. Apr 2021, at 00:24, Dmitry Sivachenko <demon@freebsd.org> wrote:=

>>>=20
>>> =EF=BB=BF
>>>=20
>>>> On 20 Apr 2021, at 01:17, Yuri <yuri@FreeBSD.org> wrote:
>>>>=20
>>>> On 4/19/21 3:13 PM, Dmitry Sivachenko wrote:
>>>>>   Update to version 2.2.13.
>>>>=20
>>>>=20
>>>> Why didn't you mention in the commit message what port was updated?
>>>> net/haproxy is one of thousands of ports and having a message like this=
 doesn't help to understand what the change is.
>>>>=20
>>>=20
>>> Hello,
>>>=20
>>> what do you mean 'what port was updated'?  It is clean from the commit l=
og that it is net/haproxy that was updated, only two files changed:
>>>  Update to version 2.2.13.
>>> ---
>>> net/haproxy/Makefile | 2 +-
>>> net/haproxy/distinfo | 6 +++---
>>> 2 files changed, 4 insertions(+), 4 deletions(-)
>>>=20
>>>=20
>>> Or may be I am missing something...
>>=20
>> The idea is to prefix the first line of the commit with <category>/<name>=
:, so it=E2=80=99s easier to understand which port was changed when looking a=
t a list of commits.
>>=20
>> See here for an example of why this helps:
>> https://cgit.freebsd.org/ports/log/
>>=20
>=20
>=20
> Aha, I see now.  I used to think that commit log should describe what has c=
hanged, and commit logs are just tool.
> But things changed and now we should think how commit log will look in mai=
l client provided you read only subject line  :)

Well, it=E2=80=99s not so much about mail clients (but it helps there too). M=
ost tools handling git commits work this way (present first line of commit a=
s a kind of subject in file trees and short commit logs), that includes cgit=
, GitHub, gitlab, phabricator, gitweb. It also helps when dealing with git's=
 internal feature features like merging, rebasing, cherry-picking commits et=
c. It=E2=80=99s basically a convention that evolved over time that=E2=80=99s=
 especially useful when dealing with the ports collection.

Best,
Michael

p.s. It also helps when looking at git logs on the command line, a nice litt=
le trick I found in a blog about a decade ago is (Google for "git lola" to f=
ind the original post):

Copy the following into ~/.gitconfig for your full color git lola action:

[alias]
        lol =3D log --graph --decorate --pretty=3Doneline --abbrev-commit
        lola =3D log --graph --decorate --pretty=3Doneline --abbrev-commit -=
-all
[color]
        branch =3D auto
        diff =3D auto
        interactive =3D auto
        status =3D auto

Then run `git lola' on your workdir.






Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?FB1DA78E-B05E-4243-95A6-0A76CA6A1E79>