On Wed, Feb 16, 2011 at 01:08:11PM -0800, Danek Duvall wrote:
> Peter Schow wrote:
> 
> > Ok, I get it now.  I think this section of the pkgmogrify(1) man page
> > should also take your advice and explictly refer to "Actions" in pkg(5),
> > too.
> > 
> > I'll file a man page bug and propose the following wording change to make
> > this clearer:
> > 
> > Old:  
> > 
> >      Matching criteria are of the form:
> > 
> >          [action-type ... ] [attribute=<value-regexp> ...]
> > 
> >      One of the action-types specified must match. 
> > 
> > Proposed:
> > 
> >      Matching criteria are of the form:
> > 
> >          [action-type ... ] [attribute=<value-regexp> ...]
> > 
> >      where action-type is one of the actions listed in the ``Actions''
> >      section of pkg(5).  One of the action-types specified must match. 
> 
> But that's the fourth time pkgmogrify(1) uses the term "action".  Had you
> read up to that point knowing what actions were all about but suddenly
> found yourself wondering what an action type was?  Or should we reference
> this section of pkg(5) up at the first time we use the term?  Or perhaps
> every time we use the term?  Are there other terms in this manpage where we
> don't point to a suitable definition?
> 
> I understand that being nudged towards the pkg(5) man page helped you
> understand what was going on here.  But it's referenced in the SEE ALSO
> section, and there's no guarantee in any man page that you'll be able to
> understand everything in it without potentially referring to some of the
> pages mentioned there.  And while you had problems with this, someone else
> will get tripped up on some other connection.  We can't eliminate all sharp
> edges.
> 
> That said, feel free to file the manpage bug; I don't doubt that someone
> will address it.

Right you are.  I shouldn't have been trying to read pkgmogrify(1) in 
isolation with just cursory knowledge of the bigger pkg(5) big picture.

What really confused me, in looking at some working Makefiles, is that
"set" can be both an action-type and an operation in a transform.   Like 
most things, it's starting to make sense now after a few days.

I'll still file a CR with my suggested change but everything else
made sense to me.


_______________________________________________
pkg-discuss mailing list
[email protected]
http://mail.opensolaris.org/mailman/listinfo/pkg-discuss

Reply via email to