Bug 45470

Summary: Document everything in make.conf(5) and make.conf.
Product: Documentation Reporter: Carl Schmidt <carl>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   
Attachments:
Description Flags
make.conf.5.diff
none
file.diff none

Description Carl Schmidt 2002-11-19 08:50:01 UTC
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.
Comment 1 Carl Schmidt 2002-11-19 20:23:59 UTC
There is a typo in the first patch.  A corrected patch follows:

--- 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/etc/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
Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2002-11-20 00:41:36 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

I'll grab this one on up.
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2002-11-22 18:31:37 UTC
State Changed
From-To: open->patched

A slightly different version of your patch committed, thanks for the 
submission!
Comment 4 Tom Rhodes freebsd_committer freebsd_triage 2002-12-12 23:00:31 UTC
State Changed
From-To: patched->closed

All required changes committed!  Thanks alot for your submission!