Skip site navigation (1)Skip section navigation (2)
Date:      Mon, 19 Feb 2001 12:15:02 +0200
From:      Maxim Sobolev <sobomax@FreeBSD.org>
To:        Kris Kennaway <kris@obsecurity.org>
Cc:        Nevermind <never@nevermind.kiev.ua>, ports@FreeBSD.org
Subject:   Re: COMMENT in makefiles (Re: [wiz@netbsd.org: CVS commit: pkgsrc])
Message-ID:  <3A90F226.A4E3DD8A@FreeBSD.org>
References:  <20010218171737.B44211@nevermind.kiev.ua> <200102181927.f1IJR0n01529@vic.sabbo.net> <20010219020452.A40459@mollari.cthul.hu>

next in thread | previous in thread | raw e-mail | index | archive | help
Kris Kennaway wrote:

> On Sun, Feb 18, 2001 at 09:27:00PM +0200, Maxim Sobolev wrote:
>
> > > >> Log Message:
> > > >> Update to new COMMENT style: COMMENT var in Makefile instead of pkg/COMM=
> > > ENT.
> > >
> > > > What do people think about this change? Personally, I think it would
> > > > be great..frees up another 4500 inodes from the ports collection.
> > >
> > > I think that should be useful. I have slow hdds, so it will be useful while
> > > cvsuping, while make readme'ing and so on.=20
> >
> > I'm also voting for this change, however IMO Makefile a best place
> > for a COMMENT (Makefile's from our ports collection are already overloaded
> > with variables). I would propose to put it into pkg-descr, just like WWW
> > line. Another possible benefit for having it in pkg-descr is that you can
>
> Well, I don't agree there are good enough reasons to do it this
> way..it seems gratuitously different and it makes the pkg-descr file
> more difficult to read (comments often aren't very clear descriptions
> because of size constraints).

I did not mean that comment would replace description. I told that it could be either
a COMMENT: field at the end of pkg-descr or first introductory line of description.
Following two examples illustrate my concept using real-world example:
-----------------------
This is bzip2, an advanced block-sorting file compressor.  It is
believed to be free from any patents.

WWW: http://sourceware.cygnus.com/bzip2/
COMMENT: A block-sorting file compressor
-----------------------
A block-sorting file compressor.

Bzip2 is an advanced block-sorting file compressor.  It is
believed to be free from any patents.

WWW: http://sourceware.cygnus.com/bzip2/
-----------------------

-Maxim



To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-ports" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?3A90F226.A4E3DD8A>