Date: Tue, 19 Nov 2002 03:44:49 -0500 (EST) From: Carl Schmidt <carl@slackerbsd.org> To: FreeBSD-gnats-submit@FreeBSD.org Subject: docs/45470: Document everything in make.conf(5) and make.conf. Message-ID: <20021119084449.DB2F641BA@laptop.slackerbsd.org>
next in thread | raw e-mail | index | archive | help
>Number: 45470
>Category: docs
>Synopsis: Document everything in make.conf(5) and make.conf.
>Confidential: no
>Severity: non-critical
>Priority: medium
>Responsible: freebsd-doc
>State: open
>Quarter:
>Keywords:
>Date-Required:
>Class: doc-bug
>Submitter-Id: current-users
>Arrival-Date: Tue Nov 19 00:50:01 PST 2002
>Closed-Date:
>Last-Modified:
>Originator: Carl Schmidt
>Release: FreeBSD 5.0-CURRENT i386
>Organization:
>Environment:
System: FreeBSD laptop.slackerbsd.org 5.0-CURRENT FreeBSD 5.0-CURRENT #0: Mon Nov 18 17:23:17 EST 2002 root@laptop.slackerbsd.org:/usr/obj/usr/src/sys/LAPTOP i386
>Description:
Make.conf has some knobs which are not documented in make.conf(5).
Make.conf(5) also documents some items which are not included in make.conf.
There are also some style inconsistencies in the example make.conf which
I have resolved in my preferred method. I'm sure a thousand people will
object to it.
>How-To-Repeat:
>Fix:
--- make.conf.5.diff begins here ---
--- share/man/man5/make.conf.5.old Mon Nov 18 20:07:02 2002
+++ share/man/man5/make.conf.5 Tue Nov 19 02:55:46 2002
@@ -111,6 +111,29 @@
.Bd -literal -offset indent
CFLAGS+=${BDECFLAGS}
.Ed
+.It Va CPUTYPE
+.Pq Vt str
+Controls which processor should be targeted for generated
+code. This controls processor-specific optimizations in
+certain code (currently only OpenSSL) as well as modifying
+the value of
+.Va CFLAGS
+and
+.Va COPTFLAGS
+to contain the appropriate optimization directive to gcc.
+The automatic setting of
+.Va CFLAGS
+and
+.Va COPTFLAGS
+may be overridden using the
+.Va NO_CPU_CFLAGS
+and
+.Va NO_CPU_COPTFLAGS
+variables, respectively. Refer to
+.Pa /usr/share/examples/make.conf
+for a list of recognized
+.Va CPUTYPE
+options.
.It Va CVS_UPDATE
.Pq Vt bool
Set this to use
@@ -144,6 +167,17 @@
make's in
.Pa /usr/src
in this variable.
+.It Va MAKE_SHELL
+.Pq Vt str
+Controls the shell used internally by
+.Xr make 1
+to process the command scripts in makefiles. Three shells
+are supported, sh, ksh, and csh. Using sh is most common,
+and advised. Using ksh *may* work, but is not guaranteed
+to. Using csh is absurd. The default is to use sh.
+.Bd -literal -offset indent
+MAKE_SHELL?=sh
+.Ed
.It Va MTREE_FOLLOWS_SYMLINKS
.Pq Vt str
Set this to
@@ -189,40 +223,30 @@
.Ar supfile
to use when doing a
.Dq Li "make update" .
-This defaults to
-.Pa /usr/share/examples/cvsup/standard\-supfile .
.It Va SUPFILE1
.Pq Vt str
The second
.Ar supfile
to use when doing a
.Dq Li "make update" .
-This defaults to
-.Pa /usr/share/examples/cvsup/secure\-supfile .
.It Va SUPFILE2
.Pq Vt str
The third
.Ar supfile
to use when doing a
.Dq Li "make update" .
-This defaults to
-.Pa /usr/share/examples/cvsup/secure\-supfile .
.It Va PORTSSUPFILE
.Pq Vt str
The ports
.Ar supfile
to use when doing a
.Dq Li "make update" .
-This defaults to
-.Pa /usr/share/examples/cvsup/ports\-supfile .
.It Va DOCSUPFILE
.Pq Vt str
The documentation
.Ar supfile
to use when doing a
.Dq Li "make update" .
-This defaults to
-.Pa /usr/share/examples/cvsup/doc\-supfile .
.El
.Pp
The following list provides a name and short description for variables
@@ -271,6 +295,18 @@
.Pa MINE .
It defaults to
.Pa GENERIC .
+.It Va LOADER_TFTP_SUPPORT
+.Pq Vt bool
+While not a buildkernel-affected option, there is no better place for this.
+By default the ``pxeboot'' loader retrieves the kernel via NFS. Defining
+this and recompiling
+.Pa /usr/src/sys/boot
+will cause it to retrieve the kernel via TFTP. This allows pxeboot to
+load a custom BOOTP diskless kernel yet still mount the server's `/'
+(i.e., rather than load the server's kernel).
+.It Va MODULES_OVERRIDE
+.Pq Vt str
+Set to a list of modules to build instead of all of them.
.It Va NO_KERNELCONFIG
.Pq Vt bool
Set this to skip running
@@ -286,9 +322,6 @@
.It Va NO_MODULES
.Pq Vt bool
Set to not build modules with the kernel.
-.It Va MODULES_OVERRIDE
-.Pq Vt str
-Set to a list of modules to build instead of all of them.
.El
.Pp
The following list provides a name and short description for variables
@@ -331,6 +364,11 @@
Command to use to fetch files.
Normally
.Xr fetch 1 .
+.It Va KRB5_HOME
+.Pq Vt str
+If you want to install the MIT Kerberos5 port somewhere other than
+.Pa /usr/local ,
+define this. This is also used to tell ssh1 that kerberos is needed).
.It Va MAKE_IDEA
.Pq Vt bool
Set to build the IDEA encryption code.
@@ -361,12 +399,22 @@
Otherwise,
.Xr newgrp 1
will not be able to change users' groups.
+.It Va ENABLE_SUID_SSH
+.Pq Vt bool
+Set this to insall
+.Xr ssh 1
+with the setuid bit turned on.
.It Va MODULES_WITH_WORLD
.Pq Vt bool
Set to build modules with the system instead of the kernel.
.It Va NO_CVS
.Pq Vt bool
Set to not build CVS.
+.It Va NO_CXX
+.Pq Vt bool
+Set to not build
+.Xr g++ 1
+and related libraries.
.It Va NO_BIND
.Pq Vt bool
Set to not build BIND.
@@ -375,6 +423,10 @@
Set to not build
.Xr g77 1
and related libraries.
+.It Va NO_GDB
+.Pq Vt bool
+Set to not build
+.Xr gdb 1
.It Va NO_I4B
.Pq Vt bool
Set to not build isdn4bsd package.
@@ -596,6 +648,14 @@
Mode to use when generating alias and map database files using
.Pa /etc/mail/Makefile .
The default value is 0640.
+.It Va TOP_TABLE_SIZE
+.Pq Vt int
+.Xr top 1
+uses a hash table for the user names. The size of this hash can be tuned
+to match the number of local users. The table size should be a prime number
+approximately twice as large as the number of lines in
+.Pa /etc/passwd .
+The default number is 20011.
.It Va WANT_FORCE_OPTIMIZATION_DOWNGRADE
.Pq Vt int
Causes the system compiler to be built such that it forces high optimization
@@ -605,6 +665,15 @@
and above is known to trigger known optimizer bugs at various
times \(em this is worse on the Alpha platform.
The value assigned is the highest optimization value used.
+.It Va WANT_OPENSSL_MANPAGES
+.Pq Vt bool
+Set this to build the OpenSSL manual pages. These are not built by
+default because they clobber a number of system manual pages with
+manual pages describing parts of the OpenSSL toolkit, including
+.Xr passwd 1 ,
+.Xr err 3 ,
+.Xr md5 3 ,
+and others.
.El
.Pp
The following list provides a name and short description for variables
--- make.conf.5.diff ends here ---
--- make.conf.diff begins here ---
--- share/examples/etc/make.conf.old Mon Nov 18 20:24:03 2002
+++ share/examples/etc/make.conf Tue Nov 19 02:24:57 2002
@@ -31,7 +31,6 @@
# Intel ia64 architecture: itanium
#
# (?= allows to buildworld for a different CPUTYPE.)
-#
#CPUTYPE?=i686
#NO_CPU_CFLAGS= true # Don't add -march=<cpu> to CFLAGS automatically
#NO_CPU_COPTFLAGS=true # Don't add -march=<cpu> to COPTFLAGS automatically
@@ -43,28 +42,24 @@
# to the developers.
# Note also that at this time the -O2 setting is known to produce BROKEN
# CODE on the Alpha platform.
-#
#CFLAGS= -O -pipe
#
# CXXFLAGS controls the compiler settings used when compiling C++ code.
# Note that CXXFLAGS is initially set to the value of CFLAGS. If you wish
# to add to CXXFLAGS value, "+=" must be used rather than "=". Using "="
# alone will remove the often needed contents of CFLAGS from CXXFLAGS.
-#
#CXXFLAGS+= -fmemoize-lookups -fsave-memoized
#
# MAKE_SHELL controls the shell used internally by make(1) to process the
# command scripts in makefiles. Three shells are supported, sh, ksh, and
# csh. Using sh is most common, and advised. Using ksh *may* work, but is
# not guaranteed to. Using csh is absurd. The default is to use sh.
-#
#MAKE_SHELL?=sh
#
# 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. -Wconversion is not
# included here due to compiler bugs, e.g., mkdir()'s mode_t argument.
-#
#BDECFLAGS= -W -Wall -ansi -pedantic -Wbad-function-cast -Wcast-align \
# -Wcast-qual -Wchar-subscripts -Winline \
# -Wmissing-prototypes -Wnested-externs -Wpointer-arith \
@@ -74,7 +69,6 @@
# this instead of CFLAGS (which is not applicable to kernel builds anyway).
# There is very little to gain by using higher optimization levels, and doing
# so can cause problems.
-#
#COPTFLAGS= -O -pipe
#
# To build the system compiler such that it forces high optimization levels to
@@ -99,6 +93,13 @@
# Without the setuid bit, newgrp cannot change users' groups.
#ENABLE_SUID_NEWGRP= true
#
+# To disable cleaning during ``make buildworld''. This should not be set
+# unless you know what you are doing.
+#NOCLEAN= true
+#
+# To run ``${MAKE} clean'' instead of ``${MAKE} cleandir''.
+#NOCLEANDIR= true
+#
# To avoid building various parts of the base system:
#NO_CVS= true # do not build CVS
#NO_CXX= true # do not build C++ and friends
@@ -130,7 +131,6 @@
# built by default because they clobber a number of system manpages with
# manpages describing parts of the OpenSSL toolkit, including passwd(1),
# err(3), md5(3), and others.
-#
#WANT_OPENSSL_MANPAGES= true
#
# To build sys/modules when building the world (our old way of doing things)
@@ -157,13 +157,10 @@
#
# If you do not want unformatted manual pages to be compressed
# when they are installed:
-#
#NOMANCOMPRESS= true
#
-#
# If you want the "compat" shared libraries installed as part of your normal
# builds, uncomment these:
-#
#COMPAT1X= yes
#COMPAT20= yes
#COMPAT21= yes
@@ -171,18 +168,14 @@
#COMPAT3X= yes
#COMPAT4X= yes
#
-#
# Default format for system documentation, depends on your printer.
# Set this to "ascii" for simple printers or screen
-#
#PRINTERDEVICE= ps
#
-#
# How long to wait for a console keypress before booting the default kernel.
# This value is approximately in milliseconds. Keypresses are accepted by the
# BIOS before booting from disk, making it possible to give custom boot
# parameters even when this is set to 0.
-#
#BOOTWAIT=0
#BOOTWAIT=30000
#
@@ -194,31 +187,24 @@
# a serial port as our console at all. Alter as necessary.
#
# COM1: = 0x3F8, COM2: = 0x2F8, COM3: = 0x3E8, COM4: = 0x2E8
-#
#BOOT_COMCONSOLE_PORT= 0x3F8
#
# The default serial console speed is 9600. Set the speed to a larger value
# for better interactive response.
-#
#BOOT_COMCONSOLE_SPEED= 115200
#
# By default the 'pxeboot' loader retrieves the kernel via NFS. Defining
# this and recompiling /usr/src/sys/boot will cause it to retrieve the kernel
# via TFTP. This allows pxeboot to load a custom BOOTP diskless kernel yet
# still mount the server's '/' (i.e. rather than load the server's kernel).
-#
#LOADER_TFTP_SUPPORT= YES
#
-#
# Kerberos IV
# If you want KerberosIV (KTH eBones), define this:
-#
#MAKE_KERBEROS4= yes
#
-#
# Kerberos 5
# If you want Kerberos 5 (KTH Heimdal), define this:
-#
#MAKE_KERBEROS5= yes
#
# Kerberos 5 su (k5su)
@@ -230,34 +216,31 @@
# Kerberos5
# If you want to install MIT Kerberos5 port somewhere other than /usr/local,
# define this (this is also used to tell ssh1 that kerberos is needed):
-#
#KRB5_HOME= /usr/local
#
#
# CVSup update flags. Edit SUPFILE settings to reflect whichever distribution
# file(s) you use on your site (see /usr/share/examples/cvsup/README for more
# information on CVSup and these files). To use, do "make update" in /usr/src.
-#
#SUP_UPDATE= yes
-#
#SUP= /usr/local/bin/cvsup
#SUPFLAGS= -g -L 2
#SUPHOST= cvsup.uk.FreeBSD.org
#SUPFILE= /usr/share/examples/cvsup/standard-supfile
#PORTSSUPFILE= /usr/share/examples/cvsup/ports-supfile
#DOCSUPFILE= /usr/share/examples/cvsup/doc-supfile
+#SUPFILE1= /usr/share/examples/cvsup/cvs-supfile
+#SUPFILE2= /usr/share/examples/cvsup/gnats-supfile
#
# top(1) uses a hash table for the user names. The size of this hash
# can be tuned to match the number of local users. The table size should
# be a prime number approximately twice as large as the number of lines in
# /etc/passwd. The default number is 20011.
-#
#TOP_TABLE_SIZE= 101
#
# Documentation
#
# The list of languages and encodings to build and install
-#
#DOC_LANG= en_US.ISO8859-1 ru_RU.KOI8-R
#
#
@@ -270,7 +253,6 @@
# Avoid using a value of /etc/mail/sendmail.mc as a buildworld will
# create /etc/mail/sendmail.cf before installworld installs an
# updated sendmail binary.
-#
#SENDMAIL_MC=/etc/mail/myconfig.mc
#
# The following sets the default m4 configuration file for mail
@@ -280,7 +262,6 @@
# Avoid using a value of /etc/mail/submit.mc as a buildworld will
# create /etc/mail/submit.cf before installworld installs an
# updated sendmail binary.
-#
#SENDMAIL_SUBMIT_MC=/etc/mail/mysubmit.mc
#
# If you need to build additional .cf files during a make buildworld,
@@ -288,13 +269,11 @@
# Avoid using a value of /etc/mail/sendmail.mc as a buildworld will
# create /etc/mail/sendmail.cf before installworld installs an
# updated sendmail binary.
-#
#SENDMAIL_ADDITIONAL_MC=/etc/mail/foo.mc /etc/mail/bar.mc
#
# Setting the following variable modifies the flags passed to m4 when
# building a .cf file from a .mc file. It can be used to enable
# features disabled by default.
-#
#SENDMAIL_M4_FLAGS=
#
# Setting the following variables modifies the build environment for
@@ -316,7 +295,6 @@
# sendmail.mc file:
#
# define(`confDONT_BLAME_SENDMAIL',`GroupReadableSASLDBFile')
-#
#SENDMAIL_CFLAGS=
#SENDMAIL_LDFLAGS=
#SENDMAIL_LDADD=
@@ -327,10 +305,8 @@
# prevent the installation of /etc/mail/submit.cf.
# This is a deprecated mode of operation. See etc/mail/README for more
# information.
-#
#SENDMAIL_SET_USER_ID=
#
# The permissions to use on alias and map databases generated using
# /etc/mail/Makefile. Defaults to 0640.
-#
#SENDMAIL_MAP_PERMS=
--- make.conf.diff ends here ---
>Release-Note:
>Audit-Trail:
>Unformatted:
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?20021119084449.DB2F641BA>