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