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