On Sat, 28 Jan 2017 21:25:24 +0000, Jason McIntyre <j...@kerhand.co.uk>
wrote:
> On Sat, Jan 28, 2017 at 09:13:14PM +0000, Stuart Henderson wrote:
> > On 2017/01/28 08:47, Daniel Jakots wrote:
> > > Hi,
> > >
> > > I'd like to add this sentence to bsd.port.mk(5). It comes from
> > > more or less faq/ports/guide.html (point 17 in the checklist).
> >
> > I think this would be useful, you have 1 more character though (60
> > is allowed, 61 isn't). I'd prefer to say what it can be rather than
> > what it can't - perhaps "It may be up to 60 characters long, and
> > should normally begin with a lower-case letter"?
> >
> > CC'ing jmc who isn't on ports@ :)
Thanks, I wasn't sure if I should.
> > > Index: bsd.port.mk.5
> > > ===================================================================
> > > RCS file: /cvs/src/share/man/man5/bsd.port.mk.5,v
> > > retrieving revision 1.444
> > > diff -u -p -r1.444 bsd.port.mk.5
> > > --- bsd.port.mk.5 23 Jan 2017 11:13:11 -0000 1.444
> > > +++ bsd.port.mk.5 28 Jan 2017 13:39:59 -0000
> > > @@ -1268,6 +1268,8 @@ by setting CLEANDEPENDS_${PKGPATH}.
> > > .It Ev COMMENT
> > > Short, one line description of the port, used for the package,
> > > and in the INDEX.
> > > +It must be shorter than 60 characters and must not start with an
> > > +uppercase letter unless semantically significant.
>
> you can do it like this:
>
> .It Ev COMMENT
> Short (no more than 60 characters) description of the port,
> used for the package and the INDEX.
> It should not start with an uppercase letter
> unless semantically significant.
>
> (though not sure how to define "semantically significant")
Yes, when I created the first diff I thought about something like
> Short (< 60 characters)
But this is a lot better!
Diff updated:
Index: bsd.port.mk.5
===================================================================
RCS file: /cvs/src/share/man/man5/bsd.port.mk.5,v
retrieving revision 1.444
diff -u -p -r1.444 bsd.port.mk.5
--- bsd.port.mk.5 23 Jan 2017 11:13:11 -0000 1.444
+++ bsd.port.mk.5 28 Jan 2017 21:45:25 -0000
@@ -1266,8 +1266,10 @@ target will also clean dependencies.
Can be overridden on a per-${PKGPATH} basis,
by setting CLEANDEPENDS_${PKGPATH}.
.It Ev COMMENT
-Short, one line description of the port, used for the package, and in the
-INDEX.
+Short (no more than 60 characters) description of the port, used for
+the package, and the INDEX.
+It should not start with an uppercase letter unless semantically
+significant.
.It Ev COMMENT-foo
Same as COMMENT but used for sub package -foo in a multi-package setup.
.It Ev COMMENT-vanilla
