Re: Bug#139957: period at the end of short description?
On Wed, 2002-03-27 at 21:19, Joey Hess wrote:
> I think the main case would be a short description where someone has
> managed to cram two complete sentences in. No I cannot think of one
> offhand.
Do we really want to allow people to do such things? Here is my
"annotated grep":
walters@space-ghost> egrep '^Description.+\. .+\.' /var/lib/dpkg/available
Description: mysql database common files (e.g. /etc/mysql/my.cnf)
False positive.
Description: The GNU wdiff utility. Compares two files word by word.
This package already violates policy because it has its name in the
synopsis line. I would instead write: "The GNU utility for comparing
two files word by word"
Description: XForms mail user agent. Is transitioning into Archimedes currently.
"An XForms-based mail user agent, soon to be named Archimedes"
Description: ad! BBS. A perl based bbs or easy menu system.
Again, just remove the name (and the trailing period).
Description: Chess In Lisp. A library for cmucl.
"A Lisp chess library for cmucl"
Description: Spanish fortune cookies. Offensive section.
"Spanish fortune cookies (offensive)"
Description: The perl data language. Perl extensions for numerics.
"Perl extensions for numeric calculation"
Description: Sound module editor/player. Supports .xm modules, .xi instruments.
"Sound module editor/player which supports .xm modules and .xi instruments"
Description: Perl interface to the uulib library (a.k.a. uudeview/uuenview).
False positive.
Description: /bin/login replacement with RADIUS. Header file and link lib.
What to do about library packages is still somewhat up in the air, I
think. I personally like the approach of adding a parenthetical.
"/bin/login replacement with RADIUS authentication (development files)"
Description: Control ieee1394 audio/video devices. (Development files.)
"Control ieee1394 audio/video devices (development files)"
Description: Transitional package. Can be removed.
"A transitional package, which can be safely removed"
Description: Command line image gallery generator. It also makes thumbnails.
"Command line image gallery generator; can also make thumbnails"
Description: Maps for the crossfire game. Needed only with the server.
"Maps for the crossfire game; needed for the server only"
Or just drop the "needed for the server only" part; this is something
that should really be part of the long description.
Description: /bin/login replacement with RADIUS. Shared lib to used by programs.
"/bin/login replacement with RADIUS authentication (shared library)"
--
To UNSUBSCRIBE, email to debian-policy-request@lists.debian.org
with a subject of "unsubscribe". Trouble? Contact listmaster@lists.debian.org
Reply to: