Re: CVS commit: src/share

["Valeriy E. Ushakov" <uwe%ptc.spbu.ru@localhost>]

On Wed, Dec 21, 2005 at 04:25:54 +0000, Hubert Feyrer wrote:

> Module Name:  src
> Committed By: hubertf
> Date:         Wed Dec 21 04:25:54 UTC 2005
> 
> Modified Files:
>       src/share/man/man5: mk.conf.5
>       src/share/mk: bsd.README
> 
> Log Message:
> At least try to be consistent about where to document (most...)
> user-settable MKxxx and USE_xxx variables, and put them into mk.conf(5).
> Sort alphabetically.
> 
> OK: christos, lukem

I don't like this change.  It just mechanically lumps a bunch of stuff
into unsuspecting mk.conf(5) without any consideration if that's
appropriate or not.

No further then on the very first page we now document NOxxx with a
comment that is is not intended for users!  And that's in a man page
that is supposed to desribe user-configurable make variables.

I also question the wisdom of documenting USE_xxx in the mk.conf, not
by the verbatim move from bsd.README in any case.  This was started by
confusion about MKxxx vs USE_xxx and no text at all has been added to
explain the difference.

I seriously consider asking for this commit to be reverted.  If we
want to proper document our make vars we should make bsd.README into a
proper man page(s), not just rip some random part of it and insert it
into a losely related man page.

SY, Uwe
-- 
uwe%ptc.spbu.ru@localhost                         |       Zu Grunde kommen
http://snark.ptc.spbu.ru/~uwe/          |       Ist zu Grunde gehen