Re: git: 97b0bb60dc4d - main - textproc/opensearch: Revert "Switch to a static pkg-plist"

From: Romain Tartière <romain_at_blogreen.org>
Date: Tue, 13 Sep 2022 01:28:47 UTC
Hi!

On Mon, Sep 12, 2022 at 04:27:13AM +0000, Alexey Dokuchaev wrote:
> On Sun, Sep 11, 2022 at 09:02:39PM +0000, Romain Tarti??re wrote:
> > commit 97b0bb60dc4dc6a71a26e08cc3d92576067b017a
> > 
> >   textproc/opensearch: Revert "Switch to a static pkg-plist"
> > 
> >   This reverts commit 43c14b71d3e7212d18e14b44911abffc99f40c9b.
> 
> Replying to a random backout commit with "this reverts commit $sha1"
> commit log: are they being performed automatically?  Why they's never
> a sensible commit message which would explain the reasons for revert?

Not sure I can help, but I can write the story of this commit:

I was unsure about the changes in
43c14b71d3e7212d18e14b44911abffc99f40c9b that's the reason why these
changes where in a specific commit, and I noted the reason for this in
the PR that suggested the change:
https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=265704#c6

As I feared, this change turns out to be a pain when updating the port,
so I decided to revert the change and to back to the dynamic plist
before adding another commit to update the port.  So usual git business
when I want to revert a commit:

| git revert 43c14b71d3e7212d18e14b44911abffc99f40c9b

This auto-fill the commit message with the information about the
reverted commit (short description and commit sha1), I am used to this
format and refrain from altering the default so that it keeps
recognizable. However, when pushing this, the system complained that the
first line of the commit message (Revert "textproc/opensearch: Switch to
a static pkg-plist") was not in the form "category/port: message" so I
amended this commit to match the enforced format, but did not touched
the rest of the commit.

So this is not _exactly_ what git produced, and having to alter it did
not me feel happy.



My understanding is that when you go back in history, if a line is added
in a line that revert a commit, you want to jump to the commit just
before the mentioned one to continue digging this line history and the
terse commit message makes this explicit.

I also assume some tooling might exist and help you navigate easily in
history, and they might be mislead by altered revert commit messages
(the reason why I was not happy with amending the commit).



So this is the reason _I_ keep the generated commit message and don't
replace it with something more descriptive like "textproc/opensearch:
Revert back to dynamic plist".  But I can't tell if it is relevant or
not ¯\_ (ツ)_/¯

Romain

-- 
Romain Tartière <romain@blogreen.org>        http://romain.blogreen.org/
pgp: 8234 9A78 E7C0 B807 0B59  80FF BA4D 1D95 5112 336F (ID: 0x5112336F)
(plain text =non-HTML= PGP/GPG encrypted/signed e-mail much appreciated)