Gentoo Websites Logo
Go to: Gentoo Home Documentation Forums Lists Bugs Planet Store Wiki Get Gentoo!
Bug 729968 - dev-util/pkgcheck: warn about ebuild descriptions beginning with a lowercase letter
Summary: dev-util/pkgcheck: warn about ebuild descriptions beginning with a lowercase ...
Status: UNCONFIRMED
Alias: None
Product: Gentoo Hosted Projects
Classification: Unclassified
Component: PkgCore (show other bugs)
Hardware: All Linux
: Normal normal (vote)
Assignee: Arthur Zamarin
URL:
Whiteboard:
Keywords:
Depends on:
Blocks:
 
Reported: 2020-06-28 04:19 UTC by Jan Ziak (atomsymbol)
Modified: 2022-09-18 16:15 UTC (History)
1 user (show)

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 Jan Ziak (atomsymbol) 2020-06-28 04:19:11 UTC
Hello. About 8.3% of DESCRIPTION fields in ebuilds begin with a lowercase letter:

$ eix --format="<description>\n" --not --overlay | wc -l
18872

$ eix --format="<description>\n" --not --overlay | grep "^[a-z]" | wc -l
1568

It would be nice if repoman would be able to warn about new ebuilds that have a lowercase character in the beginning of their DESCRIPTION.

Exceptions to this rule could for example be "vim plugin: ...". This might be handled by adding a command-line option to permit lowercase in the beginning of descriptions. Existence of this command-line option should be mentioned to the user if repoman prints the warning.
Comment 1 Mike Gilbert gentoo-dev 2020-06-28 15:21:57 UTC
This seems a bit silly in my opinion. Is there a policy that would warrant adding a QA check for this?
Comment 2 Jan Ziak (atomsymbol) 2020-06-28 15:27:51 UTC
(In reply to Mike Gilbert from comment #1)
> This seems a bit silly in my opinion. Is there a policy that would warrant
> adding a QA check for this?

If main Gentoo developers agree that it is meaningless to enforce this kind of regularity in ebuild descriptions then I agree that this bug should be closed.
Comment 3 Fabian Groffen gentoo-dev 2020-06-28 15:29:46 UTC
perhaps also consider for such policy whether description should end with a . (if it starts with a capital)
Comment 4 Jan Ziak (atomsymbol) 2020-06-28 15:46:36 UTC
(In reply to Fabian Groffen from comment #3)
> perhaps also consider for such policy whether description should end with a
> . (if it starts with a capital)

183 package descriptions end with one dot, 3 end with two dots and 6 with three dots. The rule can be to accept descriptions without a trailing dot and descriptions ending with 3 dots.
Comment 5 Brian Dolbec gentoo-dev 2020-06-28 16:16:19 UTC
As I recall,  the description was already deemed to NOT end in a period several years ago.  And there was a mass of ebuilds fixed for that.

And if repoman is to be changed to check for Capitalization, then it is just as easy to have repoman capitalize it unconditionally, save checking it.

"Just DO IT"
Comment 6 Jan Ziak (atomsymbol) 2020-06-28 17:25:43 UTC
For fun, a random sampling of errors obtained by partial examinination of the output of passing ebuild descriptions to aspell:

$ eix --format="<description>\n" --not --overlay | aspell -a | less

accesible                                                                                                                                           
complient
configurationfiles
generalised
intance
libary
librares
maintainance
managme
persitance
synchronise
sytems

linux (should be Linux)
amiga
debian
sudoku
Comment 7 Jan Ziak (atomsymbol) 2020-06-28 17:34:00 UTC
(In reply to Brian Dolbec from comment #5)
> And if repoman is to be changed to check for Capitalization, then it is just as easy to have repoman capitalize it unconditionally, save checking it.

The official name of ncurses is literally "ncurses":

$ eix --format="<description>\n" --not --overlay | grep ^ncurses
ncurses-based program to monitor CPU, disk, network and memory usage
ncurses based password database client compatible with KeePass 1.x databases
ncurses-based hex-editor with diff mode
ncurses based hex editor
ncurses interface for QEMU
ncurses based analog clock
ncurses-based visual comparison of binary files
ncurses based sudoku game
ncurses bandwidth monitor
ncurses directconnect client

----

$ eix --format="<description>\n" --not --overlay | grep ^os

os-traits is a library containing standardized trait strings.

Should be either ^OS-traits or ^os-traits (the latter is the official name of the library), not ^Os-traits.
Comment 8 Sam James archtester Gentoo Infrastructure gentoo-dev Security 2022-07-12 03:18:16 UTC
repoman support has been removed per bug 835013.

Please file a new bug (or, I suppose, reopen this one) if you feel this check is still applicable to pkgcheck and doesn't already exist.