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