[gentoo-dev] DESCRIPTION size

[gentoo-dev] DESCRIPTION size

[Mounir Lamouri]

Hi,

According to devmanunal [1], DESCRIPTION should be 80 characters max but
according to repoman, DESCRIPTION should be 100 characters max.
I'm confused, who should I believe ? :)

[1] http://devmanual.gentoo.org/ebuild-writing/variables/index.html

Thanks,
Mounir

[gentoo-dev] Re: DESCRIPTION size

[Nikos Chantziaras]

Mounir Lamouri wrote:
> Hi,
> 
> According to devmanunal [1], DESCRIPTION should be 80 characters max but
> according to repoman, DESCRIPTION should be 100 characters max.
> I'm confused, who should I believe ? :)
> 
> [1] http://devmanual.gentoo.org/ebuild-writing/variables/index.html

Though I'm not a Gentoo dev, I'd say common sense dictates that the 80 
characters limit is just a recommendation based on the 80x25 characters 
the default VGA text-mode supports.  In other words, "one line of text." 
  In any event, I don't think any short description of any package would 
need more than that.  But also don't think you would break any "rules" 
by using more than 80, unless it becomes clearly too long.

Re: [gentoo-dev] DESCRIPTION size

[Ulrich Mueller]

>>>>> On Sun, 17 May 2009, Mounir Lamouri wrote:

> According to devmanunal [1], DESCRIPTION should be 80 characters max

<nitpicking>
It says "less than 80" so 79 is the maximum. ;-)
</nitpicking>

> but according to repoman, DESCRIPTION should be 100 characters max.
> I'm confused, who should I believe ? :)

> [1] http://devmanual.gentoo.org/ebuild-writing/variables/index.html

The devmanual also says "Where possible, try to keep lines no wider
than 80 positions." which would limit DESCRIPTION to 66 characters.

These are guidelines, not strict rules. Keep it shorter if it's
reasonably possible.

Ulrich

Re: [gentoo-dev] DESCRIPTION size

[Mounir Lamouri]

Ulrich Mueller wrote:
> The devmanual also says "Where possible, try to keep lines no wider
> than 80 positions." which would limit DESCRIPTION to 66 characters.
>
> These are guidelines, not strict rules. Keep it shorter if it's
> reasonably possible.
>   
Even guidelines should be consistent. If devmanual recommand <80  and
repoman <100, in my opinion, someone is wrong. repoman should recommand
<80 or devmanual should recommand <100. That's surely not a major issue
even far from that but having some consistency in those guidelines is a
minimum. IMHO, repoman should be updated to <80.

Mounir

Re: [gentoo-dev] DESCRIPTION size

[Petteri Räty]

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

Mounir Lamouri wrote:
> Ulrich Mueller wrote:
>> The devmanual also says "Where possible, try to keep lines no wider
>> than 80 positions." which would limit DESCRIPTION to 66 characters.
>>
>> These are guidelines, not strict rules. Keep it shorter if it's
>> reasonably possible.
>>   
> Even guidelines should be consistent. If devmanual recommand <80  and
> repoman <100, in my opinion, someone is wrong. repoman should recommand
> <80 or devmanual should recommand <100. That's surely not a major issue
> even far from that but having some consistency in those guidelines is a
> minimum. IMHO, repoman should be updated to <80.
> 
> Mounir
> 

When I made the repoman check putting 80 there got opposition. I am not
entirely sure but I think zmedico and vapier wanted to put 100 there
although we do recommend keeping it under 80.

Regards,
Petteri


[-- Attachment #2: OpenPGP digital signature --]
[-- Type: application/pgp-signature, Size: 261 bytes --]