Subject: Re: Documenting user-variables
To: Hubert Feyrer <firstname.lastname@example.org>
From: Todd Vierling <email@example.com>
Date: 06/04/2005 12:08:30
On Sat, 4 Jun 2005, Hubert Feyrer wrote:
> > The main maintenance problem with packages.7 is the fact that it's in src/,
> > but it contains information about pkgsrc/. How about putting it into
> > something designed for this sort of thing, maintained in the same
> > repository: pkgsrc/doc/guide?
> No, the pkgsrc guide was never designed to document _code_.
It was designed to document the *user-visible* parts of pkgsrc, which most
definitely includes everything a user can set in mk.conf (which includes,
AFAICT, almost all of what's in packages.7).
Documenting internal variables used for .mk processing purposes in
bsd.pkg.mk would be OK, but the user-visible ones should be in real
documentation, not hidden in a .mk file.
-- Todd Vierling <firstname.lastname@example.org> <email@example.com> <firstname.lastname@example.org>