INCLUDE_CONFIG_FILE in GENERIC

[John Baldwin]

On Wednesday 13 January 2010 3:28:31 pm Julian Elischer wrote:
> John Baldwin wrote:
> > On Wednesday 13 January 2010 1:48:38 pm Doug Barton wrote:
> >> To address the other responses, Tom, sorry, your suggested text doesn't
> >> address my concern. John, I don't think that users would somehow
> >> magically know to look in NOTES for more information about an option
> >> that is already in GENERIC.
> > 
> > You really think users do not already know to look in manpages or NOTES to 
> > find out more details about kernel options? 
> 
> how about a one line comment in GENERIC suggesting that people look at 
> NOTES for more info.

There is already a large block comment at the top of GENERIC that gives people
several other places to look for more detailed info on kernel options as a
general rule:

#
# GENERIC -- Generic kernel configuration file for FreeBSD/amd64
#
# For more information on this file, please read the config(5) manual page,
# and/or the handbook section on Kernel Configuration Files:
#
#    http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/handbook/kernelconfig-config.html
#
# The handbook is also available locally in /usr/share/doc/handbook
# if you've installed the doc distribution, otherwise always see the
# FreeBSD World Wide Web server (http://www.FreeBSD.org/) for the
# latest information.
#
# An exhaustive list of options and more detailed explanations of the
# device lines is also present in the ../../conf/NOTES and NOTES files.
# If you are in doubt as to the purpose or necessity of a line, check first
# in NOTES.
#
# $FreeBSD: head/sys/amd64/conf/GENERIC 202019 2010-01-10 17:44:22Z imp $

I think the existing paragraph about NOTES in particular is sufficient
without requiring additional detailed documentation for each option.

-- 
John Baldwin