[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

TO FIX: package COMMENTS



What purpose do the package COMMENTS serve ?
Easy, they give a simple explanation of what the port is for.
When are they used ?
When you list installed packages, thru pkg_info.
What is the limit on their length ?
60 characters, because it's what pkg_info displays.

Having longer pkg COMMENTS is a bad idea, because it gets 
truncated, and pkg_info is not as informative as it should be.
Besides, pkg COMMENTS should be terse. Longer description ?
that's what DESCR is for.

pkg_create has been upgraded to give a warning for COMMENTS
over 60 characters. 
bsd.port.mk is going to be updated likewise for make install.

In one month, we (yes, I asked Marco about it too)
turn the warning into an error.

This looks like a reasonable delay, doesn't it ?

Here are the ports with problems (yes, I'm guilty for several
of them, including a swap between COMMENTS and DESCR). 

If you added a port VERY recently, I've not CVS updated
yet, so you're not in the list.

maintainer: package (length)
----------------------------
angelos@openbsd.org: audio/gsm (      66 )
angelos@openbsd.org: audio/nspmod (      64 )
angelos@openbsd.org: comms/pilot-link (      70 )
angelos@openbsd.org: comms/qpage (      66 )
angelos@openbsd.org: games/xgolgo (      68 )
angelos@openbsd.org: games/xonix (      62 )
angelos@openbsd.org: mail/adcomplain (      73 )
angelos@openbsd.org: mail/bulk_mailer (      72 )
angelos@openbsd.org: mail/poppassd (      68 )
angelos@openbsd.org: mail/xlbiff (      72 )
angelos@openbsd.org: mbone/rtptools (      67 )
angelos@openbsd.org: misc/mmv (      74 )
angelos@openbsd.org: misc/xless (      72 )
angelos@openbsd.org: print/bibview (      67 )
angelos@openbsd.org: print/ghostview (      64 )
angelos@openbsd.org: security/cfs (      68 )
angelos@openbsd.org: security/libident (      66 )
angelos@openbsd.org: textproc/catdoc (      70 )
angelos@openbsd.org: textproc/iso12083 (      68 )
angelos@openbsd.org: textproc/sp (      72 )
angelos@openbsd.org: x11/explorer (      67 )
angelos@openbsd.org: x11/rclock (      64 )
angelos@openbsd.org: x11/rxvt (      64 )
angelos@openbsd.org: x11/xdtm (      62 )
angelos@openbsd.org: x11/xfedor (      67 )
don@OpenBSD.ORG: graphics/tiff34 (      62 )
don@OpenBSD.ORG: x11/afterstep (      68 )
don@OpenBSD.ORG: x11/ctwm (      69 )
don@OpenBSD.ORG: x11/fvwm2 (      73 )
don@OpenBSD.ORG: x11/swisswatch (      65 )
don@openBSD.ORG: lang/STk (      67 )
downsj@openbsd.org: audio/xmp (      75 )
downsj@openbsd.org: net/tinyfugue (      64 )
espie@openbsd.org: lang/egcs-snapshot (      62 )
espie@openbsd.org: lang/egcs-stable (      63 )
espie@OpenBSD.ORG: games/nethack (      61 )
espie@OpenBSD.ORG: games/slash (      70 )
espie@openbsd.org: games/xkobo (      67 )
espie@openbsd.org: japanese/Wnn (      61 )
espie@openbsd.org: net/dxpc (     485 )
felix@mamba.pond.sub.org: misc/xdelta (      61 )
form@OpenBSD.ORG: editors/nedit (      64 )
form@OpenBSD.ORG: graphics/netpbm (      61 )
form@OpenBSD.ORG: net/ntop (      61 )
form@openbsd.org: net/licq (     270 )
gene@OpenBSD.ORG: shells/scsh (      66 )
graichen@OpenBSD.ORG: x11/xautolock (      67 )
ian@OpenBSD.ORG: lang/kaffe1 (      70 )
ian@openbsd.org: math/hoc (      68 )
ian@openbsd.org: textproc/idiff (      81 )
ian@openbsd.org: textproc/spiff (      73 )
joey@OpenBSD.ORG: chinese/lunar (      79 )
joey@OpenBSD.ORG: net/ircii-epic (      62 )
joey@OpenBSD.org: editors/beav (      62 )
joey@openbsd.org: sysutils/tcplist (      74 )
kiri@kiri.toba-cmt.ac.jp: lang/ocaml (      61 )
marc@OpenBSD.ORG: mail/metamail (      67 )
marc@OpenBSD.ORG: news/leafnode (      64 )
marc@OpenBSD.org: graphics/tiff  ???
marc@openbsd.org: devel/ddd (      79 )
marc@openbsd.org: graphics/ImageMagick (      63 )
marc@openbsd.org: sysutils/idled (      69 )
matthieu@laas.fr: textproc/sgmlformat (      66 )
mickey@openbsd.org: games/xripple (      71 )
niklas@openbsd.org: archivers/gtar (      61 )
niklas@openbsd.org: misc/cdrecord (      68 )
ports@OpenBSD.ORG: comms/kermit (      76 )
ports@OpenBSD.ORG: devel/id-utils (      69 )
ports@OpenBSD.ORG: mail/fetchmail (      67 )
ports@OpenBSD.ORG: www/apache (      66 )
ports@OpenBSD.ORG: www/navigator (      71 )
ports@openbsd.org: security/pgp (      61 )
todd@OpenBSD.org: devel/libslang (      67 )
-- 
	Marc Espie		
|anime, sf, juggling, unicycle, acrobatics, comics...
|AmigaOS, OpenBSD, C++, perl, Icon, PostScript...
| `real programmers don't die, they just get out of beta'