Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 587100 - review: Uppercase characters are strongly discouraged, but technically valid.
Summary: review: Uppercase characters are strongly discouraged, but technically valid.
Status: CONFIRMED
Alias: None
Product: Documentation
Classification: Unclassified
Component: Devmanual (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Gentoo Devmanual Team
URL: https://devmanual.gentoo.org/ebuild-w...
Whiteboard:
Keywords: NeedPatch
Depends on:
Blocks:
 
Reported: 2016-06-26 00:27 UTC by Jonas Stein
Modified: 2022-06-04 09:58 UTC (History)
0 users

See Also:
Package list:
Runtime testing required: ---


Attachments

Note You need to log in before you can comment on or make changes to this bug.
Description Jonas Stein gentoo-dev 2016-06-26 00:27:03 UTC
find /usr/portage -name "*[A-Z]*" | grep .ebuild | wc -l
2383
packages use uppercase in the file name and/or category.

This situation does not reflect "The name section should contain only lowercase non-accented letters, the digits 0-9, hyphens, underscores and plus characters. . Uppercase characters are strongly discouraged, but technically valid." 

The reader would be interested in a short explanation for this rule at this point too.

Should the sentence be "Uppercase characters are technically valid, but should be used sparingly, because ..."

Even newer packages use upper case characters in file names for example "dev-perl/Tk"

Reproducible: Always
Comment 1 Ulrich Müller gentoo-dev 2016-06-26 08:42:38 UTC
There are some traditional exceptions (perl, php, X), but generally the policy is that uppercase letters are strongly discouraged. Following all the crazy and inconsistent upstream capitalisation rules would add no value. Or, as the old ebuild howto had put it more pointedly:

"We have some packages in Portage that don't follow these rules, but *your* packages should."

https://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml?revision=1.57&view=markup#l244
Comment 2 Ulrich Müller gentoo-dev 2022-06-04 09:58:58 UTC
(In reply to Ulrich Müller from comment #1)
> "We have some packages in Portage that don't follow these rules, but *your*
> packages should."
> 
> https://sources.gentoo.org/cgi-bin/viewvc.cgi/gentoo/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml?revision=1.57&view=markup#l244

That link won't work any more. Here's an updated one:
https://gitweb.gentoo.org/archive/proj/gentoo.git/tree/xml/htdocs/proj/en/devrel/handbook/hb-guide-ebuild.xml?id=ee09d45ba4e2c8694d7159a08013163d04f3ff75#n244