[svn.haxx.se] · SVN Dev · SVN Users · SVN Org · TSVN Dev · TSVN Users · Subclipse Dev · Subclipse Users · this month's index

Re: [PATCH] release.py: write-changelog function (POC)

From: Daniel Shahaf <d.s_at_daniel.shahaf.name>
Date: Tue, 05 Dec 2017 01:54:39 +0000

Johan Corveleyn wrote on Tue, 05 Dec 2017 00:04 +0100:
> On Mon, Dec 4, 2017 at 11:01 PM, Julian Foad <julianfoad_at_apache.org> wrote:
> > Johan Corveleyn wrote:
> >> Just thinking out loud here ...
> >
> > [...]> Hmmmm
> >
> > Now you're over-thinking it. What you said first, what you use at work, is
> > fine. Run with it!
>
> Hehe, maybe :-).
>
> OTOH: Subversion also has a 15+ year old log message style that has
> served it well. Before giving this system a try (if we agree we
> should),

Let's go ahead and backfill log messages using the new format for trunk since
1.10.0-alpha3 (excepting changes already released in 1.9.x patch releases).
That would (a) get our feet wet with the new format, and make any shortcomings
or redundancies in it obvious (as well as whether their frequency warrants
discussing them and implementing special syntaxes for them), (b) be technical
credit¹ towards writing the 1.10.0-rc1 changelog.

So we're all on the same page, I propose we start by using the [U:foo]/[D:bar]
format from jcorvel's original message, plus the [U]/[D] fallback Julian
proposed. We can add further extensions and solve edge cases (e.g., rfc822
line unfolding) as we run across them.

Personally, I wouldn't worry about duplication for now; we can always invent
additional syntaxes later that will reduce duplication in log messages.

Cheers,

Daniel

¹ "technical credit" is the opposite of technical debt.

> I think we should think carefully how to fit this into the
> existing style, without breaking it. It's especially important to get
> some buy-in from the people who create the most commits, and that's
> certainly not me :-).
>
> At work we have no such strong log message style as SVN. We limit
> ourselves to a couple of lines, and every line is *required* to have
> such a "tagged" prefix (which is enforced by a pre-commit hook, which
> on error gives a reminder of the precise syntax). It also looks a
> little different, with square brackets around the different parts:
>
> [U][General][SVN-1111] Fix crash in 'svn co'.
>
> (the issue annotation is optional, the other two are mandatory).
>
> [D][API] Add new api svn__blah() as entry point to the blahing feature.
Received on 2017-12-05 02:54:43 CET

This is an archived mail posted to the Subversion Dev mailing list.