Bug 95975

Summary: Documentation in /usr/src/Makefile out of date
Product: Documentation Reporter: David Kirchner <dpk>
Component: Books & ArticlesAssignee: Tom Rhodes <trhodes>
Status: Closed FIXED    
Severity: Affects Only Me    
Priority: Normal    
Version: Latest   
Hardware: Any   
OS: Any   

Description David Kirchner 2006-04-18 00:10:15 UTC
	The README file in /usr/src suggests that the most commonly used
target for 'make' is 'world', and instructs the user to read the Makefile
to learn how to rebuild their world.

The Makefile then suggests that the user simply run:

cd /usr/src
make world

However, this bails with an error suggesting that they're going about this
the wrong way:

bash-2.05b# make world
WARNING: make world will overwrite your existing FreeBSD
installation without also building and installing a new
kernel.  This can be dangerous.  Please read the handbook,
'Rebuilding world', for how to upgrade your system.
Define DESTDIR to where you want to install FreeBSD,
including /, to override this warning and proceed as usual.
You may get the historical 'make world' behavior by defining
HISTORICAL_MAKE_WORLD.  You should understand the implications
before doing this.

Bailing out now...
*** Error code 1

Fix: 

The documentation in README and Makefile should probably include
the URL to the handbook section that describes "Rebuilding world":

http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html

or simply not mention the "world" target at all.
How-To-Repeat: 	NA
Comment 1 Tom Rhodes freebsd_committer freebsd_triage 2006-06-06 20:44:20 UTC
Responsible Changed
From-To: freebsd-doc->trhodes

Mine!
Comment 2 Tom Rhodes freebsd_committer freebsd_triage 2006-06-07 05:01:01 UTC
State Changed
From-To: open->patched

Made some changes to the README and Makefile, should be good. 
Thanks.
Comment 3 Tom Rhodes freebsd_committer freebsd_triage 2006-11-03 10:46:24 UTC
State Changed
From-To: patched->closed

This was handled by myself and one of our senior developers, 
Warner.  Thanks!