Skip site navigation (1)Skip section navigation (2)
Date:      12 Nov 2000 16:52:03 +0100
From:      Cyrille Lefevre <clefevre@cybercable.fr>
To:        Sheldon Hearn <sheldonh@uunet.co.za>
Cc:        freebsd-doc@FreeBSD.ORG
Subject:   Re: docs/22676: No man pages for Make.conf or /usr/src/sys/Makefile
Message-ID:  <snoxi3x8.fsf@gits.dyndns.org>
In-Reply-To: Sheldon Hearn's message of "Thu, 9 Nov 2000 00:20:01 -0800 (PST)"
References:  <200011090820.AAA85763@freefall.freebsd.org>

next in thread | previous in thread | raw e-mail | index | archive | help
Sheldon Hearn <sheldonh@uunet.co.za> writes:

>  On Wed, 08 Nov 2000 09:30:32 CST, Mike Meyer wrote:
> 
>  > First, build(7) doesn't document a single file, but a process. Of
>  > course, it duplicates information in the files that take place in the
>  > process - but what man page doesn't duplicate information from the
>  > sources?
> 
>  You're right.  I stand down for build(7) (in other words, I think it's a
>  good idea), but still don't think that make.conf(5) is a good idea.

this thread remember me an identical discution in some ml (-current I guess)
about the self documentation of /sys/i386/conf/LINT from sources to make it
up-to-date. the summary of this, do nothing.

for instance, the summary of this thread is... do-nothing.

well, from my point of view, we are not going forward this way.

consider the newbie point of view. you are saying that there is no one
oint of documentation, but many. sometimes, it's there, somethimes, it's
out there. while a simple man should suffice.

the answer is, one entry point, and the current entry point is not the good
one (read /etc/defaults/make.conf). much better is something like this :

$ cat /etc/defaults/make.conf
#
# see make.conf(5) for the description of possible values in the file.
#

# BDECFLAGS are a set of gcc warning settings that Bruce Evans has suggested
# for use in developing FreeBSD and testing changes.  They can be used by
# putting "CFLAGS+=${BDECFLAGS}" in /etc/make.conf.
#
BDECFLAGS=      -W -Wall -ansi -pedantic -Wbad-function-cast -Wcast-align \
                -Wcast-qual -Wchar-subscripts -Wconversion -Winline \
                -Wmissing-prototypes -Wnested-externs -Wpointer-arith \
                -Wredundant-decls -Wshadow -Wstrict-prototypes -Wwrite-strings

$ man make.conf
...

that's it.

Cyrille.
--
home: mailto:clefevre@citeweb.net work: mailto:Cyrille.Lefevre@edf.fr



To Unsubscribe: send mail to majordomo@FreeBSD.org
with "unsubscribe freebsd-doc" in the body of the message




Want to link to this message? Use this URL: <https://mail-archive.FreeBSD.org/cgi/mid.cgi?snoxi3x8.fsf>