Re: [gentoo-dev] gentoo-x86 tree cleanup for 'DESCRIPTION ends with a '.' character' warnings

["Michał Górny" <mgorny@gentoo.org>]

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

Dnia 2014-08-11, o godz. 20:48:20
William Hubbs <williamh@gentoo.org> napisał(a):

> On Sun, Aug 10, 2014 at 03:22:11PM +0300, Sergei Trofimovich wrote:
> > Hello World!
> > 
> > TL;DR:
> >   This evening I plan to mangle ~3000 ebuilds in the main tree
> >   by dropping trailing '.' in all 'DESCRIPTION=' fields (except "etc." case)
> > 
> > Long story:
> > 
> > As you may know newest portage release 2.2.11
> > got a minor (but chatty) QA warning:
> >     DESCRIPTION ends with a '.' character
> 
> Why is this a QA warning in the first place?

Because it is a common mistake, and having the warning in-place should
help people avoid repeating it.

> I don't recall a policy mandating that descriptions can't end with '.'. I
> asked our QA lead about it and was told that he didn't recall that we
> have an official policy about it either. Also, the devmanual never
> mentions any such requirement.

I don't know if and where it is documented but that's what I was taught
when I started contributing to Gentoo, and it pretty much follows
the common sense. DESCRIPTION is supposed to be short and descriptive.
So you do an elliptical sentence (if I got the right translation),
and that doesn't end with a dot.

If you have any fair reason to not follow this, please speak of it.
Otherwise, this is pure bikeshed and waste of time. This thread already
took much more time than fixing your packages if repoman complained
about them.

> If someone can point me to something I'm missing, let me know.
> Otherwise, I think the warning should be removed.

Even if there were no written-down policy, why would it be removed?
What is the benefit of removing the check that resulted in many fixes
already? Do you want to revert the removals afterwards? Or do you want
to introduce new packages which use '.' there?

-- 
Best regards,
Michał Górny

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 949 bytes --]