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