On Sat, Feb 08, 2020 at 03:33:37PM -0700, Theo de Raadt wrote:
> Jason McIntyre <[email protected]> wrote:
> 
> > without getting into a discussion about /etc/examples, in this case i
> > personally see neither the point of the example config file (so trivial
> > as to be questionable) nor the addition to the man page (if the example
> > is worthwhile, add it to mixerctl, not the conf page).
> 
> there is additional pieces of "documentation" that occurs here
> 
> - this is a filename, which if placed one directory above., would
>   perform a function

yep. so the reference in FILES makes sense. but could confuse the reader
too (because an example in top level /etc is no longer provided). i don;t
currently have a solution to that issue.

> - the comment format of the file is demonstrated

yep. but the comment format is pretty much universal and not needed for
demonstration.

> - the basic format of the file is demonstrated (is it simply a series
>   of name=value, or have we created a richer DSL)
> 

yep.

> you can argue that is in the manual page.  It is.  After you read a
> lot more.  There is a pace-of-learning going on here.  Noone ever

it's in the first paragraph

> demanded that learning must come from a man page, additional sources
> of transient information are not prohibited, but I'm picking up a
> disdain for information learned any other way...
> 

i don;t think it's disdain. just a discussion about how to get the info
across effectively. that the discussion began is maybe evidence that we
haven;t nailed it/.

jmc

Reply via email to