Re: [gentoo-dev] Summary line (was: Re: Referencing bug reports in git)

[Alec Warner <antarus@gentoo.org>]

[-- Attachment #1: Type: text/plain, Size: 1965 bytes --]

On Tue, Aug 11, 2015 at 7:35 AM, Kent Fredric <kentfredric@gmail.com> wrote:

> On 12 August 2015 at 02:28, Ian Stakenvicius <axs@gentoo.org> wrote:
> > Stuff like 'cat/pn: version bumps', 'cat/pn: new features', 'cat/pn:
> > adjusted dependencies' are generic (and short) enough yet descriptive
> > enough to see what went on while scanning the log.
>
> I personally find those summaries a bit too terse.
>

Summaries are supposed to be terse, they are summaries ;)


>
> Mostly, because when I see "A version is bumped" I immediately expect
> to know which version the bump is to, but have to dig out the diff to
> find out.
>
>
So I thought we used to have scripts that would dig out this information
and populate them in headers?

-A


> I would also prefer, where possible, to replace "adjusted
> dependencies" to be more concise, like "include dev-perl/Foo in
> dependencies", ( though of course, apply some taste, listing more than
> 3 distinct new dependencies in the summary is execessive, treat them
> like hashtags on twitter, 1 is good, 2 is OK, 3 and you're starting to
> get crazy )
>
> > Multi-package commits are going to be more of an issue of course..  I
> > did one last night, fortunately I think I can get away with using
> > "mozilla packages" in place of cat/pn since it is a very specific set
> > of packages.  Perhaps for sweeping changes like that we can use the
> > herdname or projectname or the category name (if its a particular
> > category only)?
>
> Agreed. If you need multi-package changes and you can't think of a
> good category prefix to use, the commit message should visibly
> acknowledge that its a multi-package commit of some kind, and the
> *kind* of change should be very clear.
>
> Just keep in mind really the recommendations for prefix naming are
> descriptive, not prescriptive, and interpretation and good taste need
> to be applied everywhere.
>
>
>
> --
> Kent
>
> KENTNL - https://metacpan.org/author/KENTNL
>
>

[-- Attachment #2: Type: text/html, Size: 3050 bytes --]