UPDATING revision 166834
1Updating Information for FreeBSD current users
2
3This file is maintained and copyrighted by M. Warner Losh
4<imp@village.org>.  See end of file for further details.  For commonly
5done items, please see the COMMON ITEMS: section later in the file.
6
7Items affecting the ports and packages system can be found in
8/usr/ports/UPDATING.  Please read that file before running
9portupgrade.
10
11NOTE TO PEOPLE WHO THINK THAT FreeBSD 7.x IS SLOW:
12	FreeBSD 7.x has many debugging features turned on, in
13	both the kernel and userland.  These features attempt to detect
14	incorrect use of system primitives, and encourage loud failure
15	through extra sanity checking and fail stop semantics.  They
16	also substantially impact system performance.  If you want to
17	do performance measurement, benchmarking, and optimization,
18	you'll want to turn them off.  This includes various WITNESS-
19	related kernel options, INVARIANTS, malloc debugging flags
20	in userland, and various verbose features in the kernel.  Many
21	developers choose to disable these features on build machines
22	to maximize performance.
23
2420070218:
25	The following build error may appear when upgrading from an old
26	-current (usr.sbin/bsnmpd/modules/snmp_bridge, depend stage):
27		line 31: '(' expected at begin of node
28		context: " TruthValue ENUM (
29		*** Error code 1
30	If so, run "make install" in usr.sbin/bsnmpd/gensnmptree.  (It
31	should probably be a build tool).  In the same module, you may
32	also get the error:
33		...snmp_bridge/bridge_sys.c:39:27:
34		net/bridgestp.h: No such file or directory
35	If so, run "cp src/sys/net/bridgestp.h /usr/include/net".
36
3720070214:
38	The output of netstat -r has changed. Without -n, we now only
39	print a "network name" without the prefix length if the network
40	address and mask exactly match a Class A/B/C network, and an entry
41	exists in the nsswitch "networks" map.
42	With -n, we print the full unabbreviated CIDR network prefix in
43	the form "a.b.c.d/p". 0.0.0.0/0 is always printed as "default".
44	This change is in preparation for changes such as equal-cost
45	multipath, and to more generally assist operational deployment
46	of FreeBSD as a modern IPv4 router.
47
4820070210:
49	PIM has been turned on by default in the IPv4 multicast
50	routing code. The kernel option 'PIM' has now been removed.
51	PIM is now built by default if option 'MROUTING' is specified.
52	It may now be loaded into GENERIC kernels by loading the
53	ip_mroute.ko module.
54
5520070207:
56	Support for IPIP tunnels (VIFF_TUNNEL) in IPv4 multicast routing
57	has been removed. Its functionality may be achieved by explicitly
58	configuring gif(4) interfaces and using the 'phyint' keyword in
59	mrouted.conf.
60	XORP does not support source-routed IPv4 multicast tunnels nor the
61	integrated IPIP tunneling, therefore it is not affected by this
62	change. The __FreeBSD_version macro has been bumped to 700030.
63
6420061221:
65	Support for PCI Message Signalled Interrupts has been
66	re-enabled in the bge driver, only for those chips which are
67	believed to support it properly.  If there are any problems,
68	MSI can be disabled completely by setting the
69	'hw.pci.enable_msi' and 'hw.pci.enable_msix' tunables to 0
70	in the loader.
71
7220061214:
73	Support for PCI Message Signalled Interrupts has been
74	disabled again in the bge driver.  Many revisions of the
75	hardware fail to support it properly.  Support can be
76	re-enabled by removing the #define of BGE_DISABLE_MSI in
77	"src/sys/dev/bge/if_bge.c".
78
7920061214:
80	Support for PCI Message Signalled Interrupts has been added
81	to the bge driver.  If there are any problems, MSI can be
82	disabled completely by setting the 'hw.pci.enable_msi' and
83	'hw.pci.enable_msix' tunables to 0 in the loader.
84
8520061205:
86	The removal of several facets of the experimental Threading 
87	system from the kernel means that the proc and thread structures 
88	have changed quite a bit. I suggest all kernel modules that might
89	reference these structures be recompiled.. Especially the
90	linux module.
91
9220061126:
93	Sound infrastructure has been updated with various fixes and
94	improvements. Most of the changes are pretty much transparent,
95	with exceptions of followings:
96	1) All sound driver specific sysctls (hw.snd.pcm%d.*) have been
97	   moved to their own dev sysctl nodes, for example:
98		hw.snd.pcm0.vchans -> dev.pcm.0.vchans
99	2) /dev/dspr%d.%d has been deprecated. Each channel now has its
100	   own chardev in the form of "dsp%d.<function>%d", where <function>
101	   is p = playback, r = record and v = virtual, respectively. Users
102	   are encouraged to use these devs instead of (old) "/dev/dsp%d.%d".
103	   This does not affect those who are using "/dev/dsp".
104
10520061122:
106	The following binaries have been disconnected from the build:
107	mount_devfs, mount_ext2fs, mount_fdescfs, mount_procfs, mount_linprocfs,
108	and mount_std.  The functionality of these programs has been
109	moved into the mount program.  For example, to mount a devfs
110	filesystem, instead of using mount_devfs, use: "mount -t devfs".
111	This does not affect entries in /etc/fstab, since entries in
112	/etc/fstab are always processed with "mount -t fstype".
113
11420061113:
115	Support for PCI Message Signalled Interrupts on i386 and amd64
116	has been added to the kernel and various drivers will soon be
117	updated to use MSI when it is available.  If there are any problems,
118	MSI can be disabled completely by setting the 'hw.pci.enable_msi'
119	and 'hw.pci.enable_msix' tunables to 0 in the loader.
120
12120061110:
122	The MUTEX_PROFILING option has been renamed to LOCK_PROFILING.
123	The lockmgr object layout has been changed as a result of having
124	a lock_object embedded in it. As a consequence all file system
125	kernel modules must be re-compiled. The mutex profiling man page 
126	has not yet been updated to reflect this change.
127
12820061026:
129	KSE in the kernel has now been made optional and turned on by
130	default. Use 'nooption KSE' in your kernel config to turn it
131	off. All kernel modules *must* be recompiled after this change.
132	There-after, modules from a KSE kernel should be compatible with
133	modules from a NOKSE kernel due to the temporary padding fields
134	added to 'struct proc'.
135
13620060929:
137	mrouted and its utilities have been removed from the base system.
138
13920060927:
140	Some ioctl(2) command codes have changed.  Full backward ABI
141	compatibility is provided if the "options COMPAT_FREEBSD6" is
142	present in the kernel configuration file.  Make sure to add
143	this option to your kernel config file, or recompile X.Org
144	and the rest of ports; otherwise they may refuse to work.
145
14620060924:
147	tcpslice has been removed from the base system.
148
14920060913:
150	The sizes of struct tcpcb (and struct xtcpcb) have changed due to
151	the rewrite of TCP syncookies.  Tools like netstat, sockstat, and
152	systat needs to be rebuilt.
153
15420060903:
155	libpcap updated to v0.9.4 and tcpdump to v3.9.4
156
15720060816:
158	The IPFIREWALL_FORWARD_EXTENDED option is gone and the behaviour
159	for IPFIREWALL_FORWARD is now as it was before when it was first
160	committed and for years after. The behaviour is now ON.
161
16220060725:
163	enigma(1)/crypt(1) utility has been changed on 64 bit architectures.
164	Now it can decrypt files created from different architectures.
165	Unfortunately, it is no longer able to decrypt a cipher text
166	generated with an older version on 64 bit architectures.
167	If you have such a file, you need old utility to decrypt it.
168
16920060709:
170 	The interface version of the i4b kernel part has changed. So
171 	after updating the kernel sources and compiling a new kernel,
172 	the i4b user space tools in "/usr/src/usr.sbin/i4b" must also
173 	be rebuilt, and vice versa.
174 
17520060627:
176	The XBOX kernel now defaults to the nfe(4) driver instead of
177	the nve(4) driver. Please update your configuration
178	accordingly.
179
18020060514:
181	The i386-only lnc(4) driver for the AMD Am7900 LANCE and Am79C9xx
182	PCnet family of NICs has been removed. The new le(4) driver serves
183	as an equivalent but cross-platform replacement with the pcn(4)
184	driver still providing performance-optimized support for the subset
185	of AMD Am79C971 PCnet-FAST and greater chips as before.
186
18720060511:
188	The machdep.* sysctls and the adjkerntz utility have been
189	modified a bit.  The new adjkerntz utility uses the new
190	sysctl names and sysctlbyname() calls, so it may be impossible
191	to run an old /sbin/adjkerntz utility in single-user mode
192	with a new kernel.  Replace the `adjkerntz -i' step before
193	`make installworld' with:
194
195	    /usr/obj/usr/src/sbin/adjkerntz/adjkerntz -i
196
197	and proceed as usual with the rest of the installworld-stage
198	steps.  Otherwise, you risk installing binaries with their
199	timestamp set several hours in the future, especially if
200	you are running with local time set to GMT+X hours.
201
20220060412:
203	The ip6fw utility has been removed.  The behavior provided by
204	ip6fw has been in ipfw2 for a good while and the rc.d scripts
205	have been updated to deal with it.  There are some rules that
206	might not migrate cleanly.  Use rc.firewall6 as a template to
207	rewrite rules.
208
20920060428:
210	The puc(4) driver has been overhauled. The ebus(4) and sbus(4)
211	attachments have been removed. Make sure to configure scc(4)
212	on sparc64. Note also that by default puc(4) will use uart(4)
213	and not sio(4) for serial ports because interrupt handling has
214	been optimized for multi-port serial cards and only uart(4)
215	implements the interface to support it.
216
21720060330:
218	The scc(4) driver replaces puc(4) for Serial Communications
219	Controllers (SCCs) like the Siemens SAB82532 and the Zilog
220	Z8530. On sparc64, it is advised to add scc(4) to the kernel
221	configuration to make sure that the serial ports remain
222	functional.
223
22420060317:
225	Most world/kernel related NO_* build options changed names.
226	New knobs have common prefixes WITHOUT_*/WITH_* (modelled
227	after FreeBSD ports) and should be set in /etc/src.conf
228	(the src.conf(5) manpage is provided).  Full backwards
229	compatibility is maintained for the time being though it's
230	highly recommended to start moving old options out of the
231	system-wide /etc/make.conf file into the new /etc/src.conf
232	while also properly renaming them.  More conversions will
233	likely follow.  Posting to current@:
234
235	http://lists.freebsd.org/pipermail/freebsd-current/2006-March/061725.html
236
23720060305:
238	The NETSMBCRYPTO kernel option has been retired because its
239	functionality is always included in NETSMB and smbfs.ko now.
240
24120060303:
242	The TDFX_LINUX kernel option was retired and replaced by the
243	tdfx_linux device.  The latter can be loaded as the 3dfx_linux.ko
244	kernel module.  Loading it alone should suffice to get 3dfx support
245	for Linux apps because it will pull in 3dfx.ko and linux.ko through
246	its dependencies.
247
24820060204:
249	The 'audit' group was added to support the new auditing functionality
250	in the base system.  Be sure to follow the directions for updating,
251	including the requirement to run mergemaster -p.
252
25320060201:
254	The kernel ABI to file system modules was changed on i386.
255	Please make sure that your kernel and modules are in sync.
256	
25720060118:
258	This actually occured some time ago, but installing the kernel
259	now also installs a bunch of symbol files for the kernel modules.
260	This increases the size of /boot/kernel to about 67Mbytes. You
261	will need twice this if you will eventually back this up to kernel.old
262	on your next install.
263	If you have a shortage of room in your root partition, you should add
264	-DINSTALL_NODEBUG to your make arguments or add INSTALL_NODEBUG="yes"
265	to your /etc/make.conf.
266
26720060113:
268	libc's malloc implementation has been replaced.  This change has the
269	potential to uncover application bugs that previously went unnoticed.
270	See the malloc(3) manual page for more details.
271
27220060112:
273	The generic netgraph(4) cookie has been changed. If you upgrade
274	kernel passing this point, you also need to upgrade userland
275	and netgraph(4) utilities like ports/net/mpd or ports/net/mpd4.
276
27720060106:
278	si(4)'s device files now contain the unit number.
279	Uses of {cua,tty}A[0-9a-f] should be replaced by {cua,tty}A0[0-9a-f].
280
28120060106:
282	The kernel ABI was mostly destroyed due to a change in the size
283	of struct lock_object which is nested in other structures such
284	as mutexes which are nested in all sorts of other structures.
285	Make sure your kernel and modules are in sync.
286
28720051231:
288	The page coloring algorithm in the VM subsystem was converted
289	from tuning with kernel options to autotuning. Please remove
290	any PQ_* option except PQ_NOOPT from your kernel config.
291
29220051211:
293	The net80211-related tools in the tools/tools/ath directory
294	have been moved to tools/tools/net80211 and renamed with a
295	"wlan" prefix.  Scripts that use them should be adjusted
296	accordingly.
297
29820051202:
299	Scripts in the local_startup directories (as defined in
300	/etc/defaults/rc.conf) that have the new rc.d semantics will
301	now be run as part of the base system rcorder. If there are
302	errors or problems with one of these local scripts, it could
303	cause boot problems. If you encounter such problems, boot in
304	single user mode, remove that script from the */rc.d directory.
305	Please report the problem to the port's maintainer, and the
306	freebsd-ports@freebsd.org mailing list.
307
30820051129:
309	The nodev mount option was deprecated in RELENG_6 (where it
310	was a no-op), and is now unsupported.  If you have nodev or dev listed
311	in /etc/fstab, remove it, otherwise it will result in a mount error.
312
31320051129:
314	ABI between ipfw(4) and ipfw(8) has been changed. You need
315	to rebuild ipfw(8) when rebuilding kernel.
316
31720051108:
318	rp(4)'s device files now contain the unit number.
319	Uses of {cua,tty}R[0-9a-f] should be replaced by {cua,tty}R0[0-9a-f].
320
32120051029:
322	/etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp.
323	Its /etc/rc.conf.d configuration file has been `ppp' from
324	the beginning, and hence there is no need to touch it.
325
32620051014:
327	Now most modules get their build-time options from the kernel
328	configuration file.  A few modules still have fixed options
329	due to their non-conformant implementation, but they will be
330	corrected eventually.  You may need to review the options of
331	the modules in use, explicitly specify the non-default options
332	in the kernel configuration file, and rebuild the kernel and
333	modules afterwards.
334
33520051001:
336	kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8)
337	to turn polling(4) on your interfaces.
338
33920050927:
340	The old bridge(4) implementation was retired.  The new
341	if_bridge(4) serves as a full functional replacement.
342
34320050722:
344	The ai_addrlen of a struct addrinfo was changed to a socklen_t
345	to conform to POSIX-2001.  This change broke an ABI
346	compatibility on 64 bit architecture.  You have to recompile
347	userland programs that use getaddrinfo(3) on 64 bit
348	architecture.
349
35020050711:
351	RELENG_6 branched here.
352
35320050629:
354	The pccard_ifconfig rc.conf variable has been removed and a new
355	variable, ifconfig_DEFAULT has been introduced.  Unlike
356	pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that
357	do not have ifconfig_ifn entries rather than just those in
358	removable_interfaces.
359
36020050616:
361	Some previous versions of PAM have permitted the use of
362	non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring
363	to third party PAM modules in /usr/local/lib.  A change has been
364	made to require the use of absolute paths in order to avoid
365	ambiguity and dependence on library path configuration, which may
366	affect existing configurations.
367
36820050610:
369	Major changes to network interface API.  All drivers must be
370	recompiled.  Drivers not in the base system will need to be
371	updated to the new APIs.
372
37320050609:
374	Changes were made to kinfo_proc in sys/user.h.  Please recompile
375	userland, or commands like `fstat', `pkill', `ps', `top' and `w'
376	will not behave correctly.
377
378	The API and ABI for hwpmc(4) have changed with the addition
379	of sampling support.  Please recompile lib/libpmc(3) and
380	usr.sbin/{pmcstat,pmccontrol}.
381
38220050606:
383	The OpenBSD dhclient was imported in place of the ISC dhclient
384	and the network interface configuration scripts were updated
385	accordingly.  If you use DHCP to configure your interfaces, you
386	must now run devd.  Also, DNS updating was lost so you will need
387	to find a workaround if you use this feature.
388
389	The '_dhcp' user was added to support the OpenBSD dhclient.  Be
390	sure to run mergemaster -p (like you are supposed to do every time
391	anyway).
392
39320050605:
394	if_bridge was added to the tree. This has changed struct ifnet.
395	Please recompile userland and all network related modules.
396
39720050603:
398	The n_net of a struct netent was changed to an uint32_t, and
399	1st argument of getnetbyaddr() was changed to an uint32_t, to
400	conform to POSIX-2001.  These changes broke an ABI
401	compatibility on 64 bit architecture.  With these changes,
402	shlib major of libpcap was bumped.  You have to recompile
403	userland programs that use getnetbyaddr(3), getnetbyname(3),
404	getnetent(3) and/or libpcap on 64 bit architecture.
405
40620050528:
407	Kernel parsing of extra options on '#!' first lines of shell
408	scripts has changed.  Lines with multiple options likely will
409	fail after this date.  For full details, please see
410		http://people.freebsd.org/~gad/Updating-20050528.txt
411
41220050503:
413	The packet filter (pf) code has been updated to OpenBSD 3.7
414	Please note the changed anchor syntax and the fact that
415	authpf(8) now needs a mounted fdescfs(5) to function.
416
41720050415:
418	The NO_MIXED_MODE kernel option has been removed from the i386
419	amd64 platforms as its use has been superceded by the new local
420	APIC timer code.  Any kernel config files containing this option
421	should be updated.
422
42320050227:
424	The on-disk format of LC_CTYPE files was changed to be machine
425	independent.  Please make sure NOT to use NO_CLEAN buildworld
426	when crossing this point. Crossing this point also requires
427	recompile or reinstall of all locale depended packages.
428
42920050225:
430	The ifi_epoch member of struct if_data has been changed to
431	contain the uptime at which the interface was created or the
432	statistics zeroed rather then the wall clock time because
433	wallclock time may go backwards.  This should have no impact
434	unless an snmp implementation is using this value (I know of
435	none at this point.)
436
43720050224:
438	The acpi_perf and acpi_throttle drivers are now part of the
439	acpi(4) main module.  They are no longer built separately.
440
44120050223:
442	The layout of struct image_params has changed. You have to
443	recompile all compatibility modules (linux, svr4, etc) for use
444	with the new kernel.
445
44620050223:
447	The p4tcc driver has been merged into cpufreq(4).  This makes
448	"options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
449	compile in "device cpufreq" to restore this functionality.
450
45120050220:
452	The responsibility of recomputing the file system summary of
453	a SoftUpdates-enabled dirty volume has been transferred to the
454	background fsck.  A rebuild of fsck(8) utility is recommended
455	if you have updated the kernel.
456
457	To get the old behavior (recompute file system summary at mount
458	time), you can set vfs.ffs.compute_summary_at_mount=1 before
459	mounting the new volume.
460
46120050206:
462	The cpufreq import is complete.  As part of this, the sysctls for
463	acpi(4) throttling have been removed.  The power_profile script
464	has been updated, so you can use performance/economy_cpu_freq in
465	rc.conf(5) to set AC on/offline cpu frequencies.
466
46720050206:
468	NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
469	requires recompiling libnetgraph and userland netgraph utilities.
470
47120050114:
472	Support for abbreviated forms of a number of ipfw options is
473	now deprecated.  Warnings are printed to stderr indicating the
474	correct full form when a match occurs.  Some abbreviations may
475	be supported at a later date based on user feedback.  To be
476	considered for support, abbreviations must be in use prior to
477	this commit and unlikely to be confused with current key words.
478
47920041221:
480	By a popular demand, a lot of NOFOO options were renamed
481	to NO_FOO (see bsd.compat.mk for a full list).  The old
482	spellings are still supported, but will cause annoying
483	warnings on stderr.  Make sure you upgrade properly (see
484	the COMMON ITEMS: section later in this file).
485
48620041219:
487	Auto-loading of ancillary wlan modules such as wlan_wep has
488	been temporarily disabled; you need to statically configure
489	the modules you need into your kernel or explicitly load them
490	prior to use.  Specifically, if you intend to use WEP encryption
491	with an 802.11 device load/configure wlan_wep; if you want to
492	use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
493	and wlan_xauth as required.
494
49520041213:
496	The behaviour of ppp(8) has changed slightly.  If lqr is enabled
497	(``enable lqr''), older versions would revert to LCP ECHO mode on
498	negotiation failure.  Now, ``enable echo'' is required for this
499	behaviour.  The ppp version number has been bumped to 3.4.2 to
500	reflect the change.
501
50220041201:
503	The wlan support has been updated to split the crypto support
504	into separate modules.  For static WEP you must configure the
505	wlan_wep module in your system or build and install the module
506	in place where it can be loaded (the kernel will auto-load
507	the module when a wep key is configured).
508
50920041201:
510	The ath driver has been updated to split the tx rate control
511	algorithm into a separate module.  You need to include either
512	ath_rate_onoe or ath_rate_amrr when configuring the kernel.
513
51420041116:
515	Support for systems with an 80386 CPU has been removed.  Please
516	use FreeBSD 5.x or earlier on systems with an 80386.
517
51820041110:
519	We have had a hack which would mount the root filesystem
520	R/W if the device were named 'md*'.  As part of the vnode
521	work I'm doing I have had to remove this hack.  People
522	building systems which use preloaded MD root filesystems
523	may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
524	their /etc/rc scripts.
525
52620041104:
527	FreeBSD 5.3 shipped here.
528
52920041102:
530	The size of struct tcpcb has changed again due to the removal
531	of RFC1644 T/TCP.  You have to recompile userland programs that
532	read kmem for tcp sockets directly (netstat, sockstat, etc.)
533
53420041022:
535	The size of struct tcpcb has changed.  You have to recompile
536	userland programs that read kmem for tcp sockets directly
537	(netstat, sockstat, etc.)
538
53920041016:
540	RELENG_5 branched here.  For older entries, please see updating
541	in the RELENG_5 branch.
542
543COMMON ITEMS:
544
545	General Notes
546	-------------
547	Avoid using make -j when upgrading.  From time to time in the
548	past there have been problems using -j with buildworld and/or
549	installworld.  This is especially true when upgrading between
550	"distant" versions (eg one that cross a major release boundary
551	or several minor releases, or when several months have passed
552	on the -current branch).
553
554	Sometimes, obscure build problems are the result of environment
555	poisoning.  This can happen because the make utility reads its
556	environment when searching for values for global variables.
557	To run your build attempts in an "environmental clean room",
558	prefix all make commands with 'env -i '.  See the env(1) manual
559	page for more details.
560
561	When upgrading from one major version to another it is generally
562	best to upgrade to the latest code in the currently installed branch
563	first, then do an upgrade to the new branch. This is the best-tested
564	upgrade path, and has the highest probability of being successful.
565	Please try this approach before reporting problems with a major
566	version upgrade.
567
568	To build a kernel
569	-----------------
570	If you are updating from a prior version of FreeBSD (even one just
571	a few days old), you should follow this procedure.  It is the most
572	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
573
574	make kernel-toolchain
575	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
576	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
577
578	To test a kernel once
579	---------------------
580	If you just want to boot a kernel once (because you are not sure
581	if it works, or if you want to boot a known bad kernel to provide
582	debugging information) run
583	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
584	nextboot -k testkernel
585
586	To just build a kernel when you know that it won't mess you up
587	--------------------------------------------------------------
588	This assumes you are already running a 5.X system.  Replace
589	${arch} with the architecture of your machine (e.g. "i386",
590	"alpha", "amd64", "ia64", "pc98", "sparc64", etc).
591
592	cd src/sys/${arch}/conf
593	config KERNEL_NAME_HERE
594	cd ../compile/KERNEL_NAME_HERE
595	make depend
596	make
597	make install
598
599	If this fails, go to the "To build a kernel" section.
600
601	To rebuild everything and install it on the current system.
602	-----------------------------------------------------------
603	# Note: sometimes if you are running current you gotta do more than
604	# is listed here if you are upgrading from a really old current.
605
606	<make sure you have good level 0 dumps>
607	make buildworld
608	make kernel KERNCONF=YOUR_KERNEL_HERE
609							[1]
610	<reboot in single user>				[3]
611	mergemaster -p					[5]
612	make installworld
613	make delete-old
614	mergemaster					[4]
615	<reboot>
616
617
618	To cross-install current onto a separate partition
619	--------------------------------------------------
620	# In this approach we use a separate partition to hold
621	# current's root, 'usr', and 'var' directories.   A partition
622	# holding "/", "/usr" and "/var" should be about 2GB in
623	# size.
624
625	<make sure you have good level 0 dumps>
626	<boot into -stable>
627	make buildworld
628	make buildkernel KERNCONF=YOUR_KERNEL_HERE
629	<maybe newfs current's root partition>
630	<mount current's root partition on directory ${CURRENT_ROOT}>
631	make installworld DESTDIR=${CURRENT_ROOT}
632	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
633	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
634	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
635	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
636	<reboot into current>
637	<do a "native" rebuild/install as described in the previous section>
638	<maybe install compatibility libraries from src/lib/compat>
639 	<reboot>
640
641
642	To upgrade in-place from 5.x-stable to current
643	----------------------------------------------
644	<make sure you have good level 0 dumps>
645	make buildworld					[9]
646	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
647							[1]
648	<reboot in single user>				[3]
649	mergemaster -p					[5]
650	make installworld
651	make delete-old
652	mergemaster -i					[4]
653	<reboot>
654
655	Make sure that you've read the UPDATING file to understand the
656	tweaks to various things you need.  At this point in the life
657	cycle of current, things change often and you are on your own
658	to cope.  The defaults can also change, so please read ALL of
659	the UPDATING entries.
660
661	Also, if you are tracking -current, you must be subscribed to
662	freebsd-current@freebsd.org.  Make sure that before you update
663	your sources that you have read and understood all the recent
664	messages there.  If in doubt, please track -stable which has
665	much fewer pitfalls.
666
667	[1] If you have third party modules, such as vmware, you
668	should disable them at this point so they don't crash your
669	system on reboot.
670
671	[3] From the bootblocks, boot -s, and then do
672		fsck -p
673		mount -u /
674		mount -a
675		cd src
676		adjkerntz -i		# if CMOS is wall time
677	Also, when doing a major release upgrade, it is required that
678	you boot into single user mode to do the installworld.
679
680	[4] Note: This step is non-optional.  Failure to do this step
681	can result in a significant reduction in the functionality of the
682	system.  Attempting to do it by hand is not recommended and those
683	that pursue this avenue should read this file carefully, as well
684	as the archives of freebsd-current and freebsd-hackers mailing lists
685	for potential gotchas.
686
687	[5] Usually this step is a noop.  However, from time to time
688	you may need to do this if you get unknown user in the following
689	step.  It never hurts to do it all the time.  You may need to
690	install a new mergemaster (cd src/usr.sbin/mergemaster && make
691	install) after the buildworld before this step if you last updated
692	from current before 20020224 or from -stable before 20020408.
693
694	[8] In order to have a kernel that can run the 4.x binaries
695	needed to do an installworld, you must include the COMPAT_FREEBSD4
696	option in your kernel.  Failure to do so may leave you with a system
697	that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5
698	is required to run the 5.x binaries on more recent kernels.
699
700	Make sure that you merge any new devices from GENERIC since the
701	last time you updated your kernel config file.
702
703	[9] When checking out sources, you must include the -P flag to have
704	cvs prune empty directories.
705
706	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
707	"?=" instead of the "=" assignment operator, so that buildworld can
708	override the CPUTYPE if it needs to.
709
710	MAKEOBJDIRPREFIX must be defined in an environment variable, and
711	not on the command line, or in /etc/make.conf.  buildworld will
712	warn if it is improperly defined.
713FORMAT:
714
715This file contains a list, in reverse chronological order, of major
716breakages in tracking -current.  Not all things will be listed here,
717and it only starts on October 16, 2004.  Updating files can found in
718previous releases if your system is older than this.
719
720Copyright information:
721
722Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
723
724Redistribution, publication, translation and use, with or without
725modification, in full or in part, in any form or format of this
726document are permitted without further permission from the author.
727
728THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
729IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
730WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
731DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
732INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
733(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
734SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
735HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
736STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
737IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
738POSSIBILITY OF SUCH DAMAGE.
739
740If you find this document useful, and you want to, you may buy the
741author a beer.
742
743Contact Warner Losh if you have any questions about your use of
744this document.
745
746$FreeBSD: head/UPDATING 166834 2007-02-19 22:49:43Z njl $
747