Skip site navigation (1)Skip section navigation (2)
Date:      Tue, 08 Jun 2021 01:36:41 +0200
From:      Adriaan de Groot <adridg@freebsd.org>
To:        ports-committers@freebsd.org
Cc:        dev-commits-ports-all@freebsd.org, dev-commits-ports-main@freebsd.org
Subject:   Re: git: 9a34ad5a4907 - main - category/port: Package name dependencies do not support globbing.
Message-ID:  <2009685.BuRyMYtAyW@beastie.bionicmutton.org>
In-Reply-To: <c5dee561-3091-0687-0733-7f844c8e4442@FreeBSD.org>
References:  <202106072240.157MeM5N088916@gitrepo.freebsd.org> <YL6iNVIGH/Sb7gPy@KGPE-D16> <c5dee561-3091-0687-0733-7f844c8e4442@FreeBSD.org>

next in thread | previous in thread | raw e-mail | index | archive | help
--nextPart39588911.yjtGejjdTc
Content-Transfer-Encoding: 7Bit
Content-Type: text/plain; charset="utf-8"; protected-headers="v1"
From: Adriaan de Groot <adridg@freebsd.org>
To: ports-committers@freebsd.org
Cc: dev-commits-ports-all@freebsd.org, dev-commits-ports-main@freebsd.org
Subject: Re: git: 9a34ad5a4907 - main - category/port: Package name dependencies do not support globbing.
Date: Tue, 08 Jun 2021 01:36:41 +0200
Message-ID: <2009685.BuRyMYtAyW@beastie.bionicmutton.org>
Organization: FreeBSD
In-Reply-To: <c5dee561-3091-0687-0733-7f844c8e4442@FreeBSD.org>
References: <202106072240.157MeM5N088916@gitrepo.freebsd.org> <YL6iNVIGH/Sb7gPy@KGPE-D16> <c5dee561-3091-0687-0733-7f844c8e4442@FreeBSD.org>

On Tuesday, 8 June 2021 00:51:11 CEST Bryan Drewery wrote:
> On 6/7/2021 3:48 PM, Piotr Kubaj wrote:
> > Uhm.
> > 
> > On 21-06-07 22:40:22, Bryan Drewery wrote:
> >> The branch main has been updated by bdrewery:
> >> 
> >> URL:
> >> https://cgit.FreeBSD.org/ports/commit/?id=9a34ad5a4907925598c80d6c3e3cfe
> >> ac1ca9e4a9
> >> 
> >> commit 9a34ad5a4907925598c80d6c3e3cfeac1ca9e4a9
> >> Author:     Bryan Drewery <bdrewery@FreeBSD.org>
> >> AuthorDate: 2021-06-07 22:24:25 +0000
> >> Commit:     Bryan Drewery <bdrewery@FreeBSD.org>
> >> CommitDate: 2021-06-07 22:39:37 +0000
> >> 
> >>     category/port: Package name dependencies do not support globbing.
> > 
> > So now we're working around the limitations we ourselves set?
> 
> See the commit 4 above this one. It's only getting in the way.

This is a message, sent at most once a week to an arbitrary commit-message-
related thread, to remind people that commit messages are a *communication 
tool*. Something to tell other ports folks -- who are human, just like you -- 
what is going on.

Git commits are displayed in many formats, by many different tools. Because of 
the history of git itself -- which was strongly email-oriented -- git commits 
look a *tiny* bit like email messages:
	<one line "subject" or summary of the commit>
	<a blank line>
	<a multi-line body>
Many tools will show the first line as the summary of the commit.

Different projects have developed different traditions around how-to-write-
the-summary. Since ports commits are *generally* concerned with one single 
port, a useful tradition to use -- which imitates the kinds of messages that 
the svn-mailer produces -- is to write
	<category>/<port>: <summary>
	<a blank line>
	<a multi-line body>
If you like, you can look back at https://svnweb.freebsd.org/ports/head/ to 
see a hodgepodge of messages from SVN times.

Being social and communicative is .. well, it's a social matter. And ports 
commits *generally* apply to one port, but not always. So there's a judgement 
call when to write
	<category>/<port>: <summary>
and when to use some other subject / summary line, like
	KDE: make ecm a build-dep everywhere

I would hope that the latter message makes people (humans, just like you) 
think "this commit is special, it doesn't name a specific port, but a 
collection of ports; but I'm glad that I understand it applies to KDE ports 
(not GNOME ones, not Haskell ones) and does something unspeakable with ecm, 
whatever that is".

Unfortunately, we had a social problem -- uncommunicative commit messages, 
hard-of-learning with respect to the preferred format -- to which we applied a 
technical solution: a server-side hook that requires a strict format.

The arbitrary commit I'm replying to is an *excellent* example of where this 
technical soluition bumps up against "generally". The right description of the 
commit is there, after the bogus "category/port:" -- bogus, because it's 
inserted to satisfy the technical tool, rather than the social and 
communicative needs of the project.

Ideally, we would drop the technical tool.

Sure, we (ports committers as a group) are then back at the stage of 
"remember, commit messages are there to help others understand what you're 
doing", but I'd assume that even the most recalcitrant of committers 
eventually understand that ports is not their private playground. I'm 
perfectly happy to continue to send my once-a-week kind of reminders when 
there's honestly and accidentally a lousy commit message. Others do the same 
regarding the commit body, or the actual commit contents.

Everyone has tools available to help locally, such as the very helpful ports-
specific prepare-commit-msg script. Those are technical *assistants*, rather 
than technical solutions to social problems.

[ade]
--nextPart39588911.yjtGejjdTc
Content-Type: application/pgp-signature; name="signature.asc"
Content-Description: This is a digitally signed message part.
Content-Transfer-Encoding: 7Bit

-----BEGIN PGP SIGNATURE-----

iQGzBAABCAAdFiEEhrjttu2OP5apuuy1z93JbxKxkVwFAmC+rYkACgkQz93JbxKx
kVx+ogwAh0ka5L9OzXibwc2BnUTB0pz1aKF4+JcOhqAGoPeAcV3+q7Fj1YyfEKUi
tpUT0ohndG3+1+KduS0RBBkA9mpf6BY2jh4heM2CnYPzNEBn/rfznE5whxCUaO+u
be1CMONOxN5qce7W7M5Gx7XGMVmA6vnVoOj9yRboAOpkmYEiMFLf2rr17cA1NmmG
9X+4zzDDOiKG8YbVgd+yTt+da6+XZki1lKpQbyvqnnxxiJOQ9F0+V9qylwHbNGt3
I5TKhfOhvCVWCKR2ilBpj3OaQQNc5E6hnS1KViZAw4qISByR3l0chpBVj7mzL5/M
g8ZTYAygYH0gEnHbP5iw2W1xCaqSFfWyvh9o10KOeowcTA3x3pBV9O0E8rc4fyBQ
fW9eFvvJCb6HfBEvWS+Dorz5LPd3B7d3Onw/qm9nX/XzzPOw8Nwm98ZiZq5n05qj
rDBFwoC9Jas71CoMNNf4E3EwMzn6GUoTlhjN+PPjH0AlDOJvdEM3MdNTLYObSfYO
i9PyMDgM
=ObpH
-----END PGP SIGNATURE-----

--nextPart39588911.yjtGejjdTc--






Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?2009685.BuRyMYtAyW>