Bug 18810

Summary: Handbook 18.4.2 should refer to /etc/defaults/make.conf
Product: Documentation Reporter: jpmg <jpmg>
Component: Books & ArticlesAssignee: freebsd-doc (Nobody) <doc>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description jpmg 2000-05-25 16:40:01 UTC
The handbook, chapter 18.4.2 refers to /etc/make.conf as if it
contains all the possible configuration options, whereas in fact
for some time, the file /etc/defaults/make.conf has contained such
information, and /etc/make.conf only contains over-rides.

Fix: 

The first two paragraphs of 18.4.2 need rewriting.  Something like
-------snip--------
Examine the file /etc/make.conf , which contains the
default defines for make which will be used when you rebuild your
source.  They are also used every time you use make, so it is a 
good idea to make sure they are set to something sensible for 
your system.

To find out what you can usefully put in this file, look in 
/etc/defaults/make.conf .  Everything in here is by default
commented out.  If you see something that looks useful, then
copy it into /etc/make.conf and remove the comment character.
For a typical user (not a FreeBSD developer), you will probably
want to use the CFLAGS and NOPROFILE lines.
----------snip----------
How-To-Repeat: Read the handbook while trying to update your machine.
Look at /etc/make.conf .
Feel confused.
8-)
Comment 1 alex 2000-06-10 12:39:26 UTC
Thus spake jpmg@eng.cam.ac.uk (jpmg@eng.cam.ac.uk):

> The first two paragraphs of 18.4.2 need rewriting.  Something like
> -------snip--------
> Examine the file /etc/make.conf , which contains the
> default defines for make which will be used when you rebuild your
> source.  They are also used every time you use make, so it is a 
> good idea to make sure they are set to something sensible for 
> your system.
> 
> To find out what you can usefully put in this file, look in 
> /etc/defaults/make.conf .  Everything in here is by default
> commented out.  If you see something that looks useful, then
> copy it into /etc/make.conf and remove the comment character.
> For a typical user (not a FreeBSD developer), you will probably
> want to use the CFLAGS and NOPROFILE lines.
> ----------snip----------

I suggest something different, such as:

Examine the file /etc/defaults/make.conf, which contains the default
defines for make which will be used when you rebuild your source.
They are also used every time you use make, so it is a good idea to
make sure they are set to something sensible for your system.

If you want to change one or more of the values that are used by make,
edit the file /etc/make.conf and add the variables with the new values
here. All variables, that are listed in /etc/make.conf overwrite the
default values found in /etc/defaults/make.conf.

For a typical user (not a FreeBSD developer), you will probably want
to use the CFLAGS and NOPROFILE lines.

Example: Add

NOPROFILE=true

to your /etc/make.conf file.

Alex
-- 
(Imagine a big "FreeBSD - The Power To Serve" sticker here)
Comment 2 jpmg 2000-06-12 10:02:34 UTC
> I suggest something different, such as:
> 
> Examine the file /etc/defaults/make.conf, which contains the default
> defines for make which will be used when you rebuild your source.
> They are also used every time you use make, so it is a good idea to
> make sure they are set to something sensible for your system.
> 
> If you want to change one or more of the values that are used by make,
> edit the file /etc/make.conf and add the variables with the new values
> here. All variables, that are listed in /etc/make.conf overwrite the
> default values found in /etc/defaults/make.conf.
> 
> For a typical user (not a FreeBSD developer), you will probably want
> to use the CFLAGS and NOPROFILE lines.
> 
> Example: Add
> 
> NOPROFILE=true
> 
> to your /etc/make.conf file.

Although I can see why you want to change it to that, I think that I
disagree with it, since:

1) the first paragraph of your suggestion implies (until one has read
   the next paragraph) that the place that one should "set the defines
   to something sensible for your system" is in /etc/defaults/make.conf ,
   since that's all that's been mentioned so far.

2) /etc/defaults/make.conf contains very little that affects the
   behaviour of make, since it's all commented out.  As far as I can
   tell, it is there purely as a form of documentation of what might
   make sense to change.  This isn't what your version implies ...

-patrick.
Comment 3 Jim Mock freebsd_committer freebsd_triage 2000-06-16 23:02:30 UTC
State Changed
From-To: open->closed

Committed with minor changes.  Thanks!