UPDATING revision 191080
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 8.x IS SLOW:
12	FreeBSD 8.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.  (To disable malloc debugging, run
23	ln -s aj /etc/malloc.conf.)
24
2520090414:
26	The size of rt_metrics_lite and by extension rtentry has changed.
27	Networking administration apps will need to be recompiled.
28	The route command now supports show as an alias for get, weighting 
29	of routes, sticky and nostick flags to alter the behavior of stateful
30	load balancing.
31	Bump __FreeBSD_version to 800078.
3220090408:
33	Do not use Giant for kbdmux(4) locking. This is wrong and
34	apparently causing more problems than it solves. This will
35	re-open the issue where interrupt handlers may race with
36	kbdmux(4) in polling mode. Typical symptoms include (but
37	not limited to) duplicated and/or missing characters when
38	low level console functions (such as gets) are used while
39	interrupts are enabled (for example geli password prompt,
40	mountroot prompt etc.). Disabling kbdmux(4) may help.
41
4220090407:
43	The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
44	kernel modules referencing any of the above need to be recompiled.
45	Bump __FreeBSD_version to 800075.
46
4720090320:
48	GEOM_PART has become the default partition slicer for storage devices,
49	replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
50	introduces some changes:
51	
52	MSDOS/EBR: the devices created from MSDOS extended partition entries
53	(EBR) can be named differently than with GEOM_MBR and are now symlinks
54	to devices with offset-based names. fstabs may need to be modified.
55
56	BSD: the "geometry does not match label" warning is harmless in most
57	cases but it points to problems in file system misalignment with
58	disk geometry. The "c" partition is now implicit, covers the whole
59	top-level drive and cannot be (mis)used by users.
60	
61	General: Kernel dumps are now not allowed to be written to devices
62	whose partition types indicate they are meant to be used for file
63	systems (or, in case of MSDOS partitions, as something else than
64	the "386BSD" type).
65
66	Most of these changes date approximately from 200812.
67
6820090319:
69	The uscanner(4) driver has been removed from the kernel. This follows
70	Linux removing theirs in 2.6 and making libusb the default interface
71	(supported by sane).
72
7320090319:
74	The multicast forwarding code has been cleaned up. netstat(1)
75	only relies on KVM now for printing bandwidth upcall meters.
76	The IPv4 and IPv6 modules are split into ip_mroute_mod and
77	ip6_mroute_mod respectively. The config(5) options for statically
78	compiling this code remain the same, i.e. 'options MROUTING'.
79
8020090315:
81	Support for the IFF_NEEDSGIANT network interface flag has been
82	removed, which means that non-MPSAFE network device drivers are no
83	longer supported.  In particular, if_ar, if_sr, and network device
84	drivers from the old (legacy) USB stack can no longer be built or
85	used.
86
8720090313:
88	POSIX.1 Native Language Support (NLS) has been enabled in libc and
89	a bunch of new language catalog files have also been added.
90	This means that some common libc messages are now localized and
91	they depend on the LC_MESSAGES environmental variable.
92
9320090313:
94	The k8temp(4) driver has been renamed to amdtemp(4) since
95	support for K10 and K11 CPU families was added.
96
9720090309:
98	IGMPv3 and Source-Specific Multicast (SSM) have been merged
99	to the IPv4 stack. VIMAGE hooks are in but not yet used.
100
101	For kernel developers, the most important changes are that the
102	ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
103	and this lock has been downgraded to a non-recursive mutex.
104
105	Transport protocols (UDP, Raw IP) are now responsible for filtering
106	inbound multicast traffic according to group membership and source
107	filters. The imo_multicast_filter() KPI exists for this purpose.
108	Transports which do not use multicast (SCTP, TCP) already reject
109	multicast by default. Forwarding and receive performance may improve
110	as a mutex acquisition is no longer needed in the ip_input()
111	low-level input path.  in_addmulti() and in_delmulti() are shimmed
112	to new KPIs which exist to support SSM in-kernel.
113
114	For application developers, it is recommended that loopback of
115	multicast datagrams be disabled for best performance, as this
116	will still cause the lock to be taken for each looped-back
117	datagram transmission. The net.inet.ip.mcast.loop sysctl may
118	be tuned to 0 to disable loopback by default; it defaults to 1
119	to preserve the existing behaviour.
120
121	For systems administrators, to obtain best performance with
122	multicast reception and multiple groups, it is always recommended
123	that a card with a suitably precise hash filter is used. Hash
124	collisions will still result in the lock being taken within the
125	transport protocol input path to check group membership.
126
127	If deploying FreeBSD in an environment with IGMP snooping switches,
128	it is recommended that the net.inet.igmp.sendlocal sysctl remain
129	enabled; this forces 224.0.0.0/24 group membership to be announced
130	via IGMP.
131
132	The size of 'struct igmpstat' has changed; netstat needs to be
133	recompiled to reflect this.
134	Bump __FreeBSD_version to 800070.
135
13620090309:
137	libusb20.so.1 is now installed as libusb.so.1 and the ports system
138	updated to use it. This requires a buildworld/installworld in order to
139	update the library and dependencies (usbconfig, etc). Its advisable to
140	rebuild all ports which uses libusb. More specific directions are given
141	in the ports collection UPDATING file. Any /etc/libmap.conf entries for
142	libusb are no longer required and can be removed.
143
14420090302:
145	A workaround is committed to allow the creation of System V shared
146	memory segment of size > 2 GB on the 64-bit architectures.
147	Due to a limitation of the existing ABI, the shm_segsz member
148	of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
149	wrong for large segments. Note that limits must be explicitely
150	raised to allow such segments to be created.
151
15220090301:
153	The layout of struct ifnet has changed, requiring a rebuild of all
154	network device driver modules.
155
15620090227:
157	The /dev handling for the new USB stack has changed, a
158	buildworld/installworld is required for libusb20.
159
16020090223:
161	The new USB2 stack has now been permanently moved in and all kernel and
162	module names reverted to their previous values (eg, usb, ehci, ohci,
163	ums, ...).  The old usb stack can be compiled in by prefixing the name
164	with the letter 'o', the old usb modules have been removed.
165	Updating entry 20090216 for xorg and 20090215 for libmap may still
166	apply.
167
16820090217:
169	The rc.conf(5) option if_up_delay has been renamed to
170	defaultroute_delay to better reflect its purpose. If you have
171	customized this setting in /etc/rc.conf you need to update it to
172	use the new name.
173
17420090216:
175	xorg 7.4 wants to configure its input devices via hald which does not
176	yet work with USB2. If the keyboard/mouse does not work in xorg then
177	add
178		Option "AllowEmptyInput" "off"
179	to your ServerLayout section.  This will cause X to use the configured
180	kbd and mouse sections from your xorg.conf.
181
18220090215:
183	The GENERIC kernels for all architectures now default to the new USB2
184	stack. No kernel config options or code have been removed so if a
185	problem arises please report it and optionally revert to the old USB
186	stack. If you are loading USB kernel modules or have a custom kernel
187	that includes GENERIC then ensure that usb names are also changed over,
188	eg uftdi -> usb2_serial_ftdi.
189
190	Older programs linked against the ports libusb 0.1 need to be
191	redirected to the new stack's libusb20.  /etc/libmap.conf can
192	be used for this:
193		# Map old usb library to new one for usb2 stack
194		libusb-0.1.so.8	libusb20.so.1
195
19620090203:
197	The ichsmb(4) driver has been changed to require SMBus slave
198	addresses be left-justified (xxxxxxx0b) rather than right-justified.
199	All of the other SMBus controller drivers require left-justified
200	slave addresses, so this change makes all the drivers provide the
201	same interface.
202
20320090201:
204	INET6 statistics (struct ip6stat) was updated.
205	netstat(1) needs to be recompiled.
206
20720090119:
208	NTFS has been removed from GENERIC kernel on amd64 to match
209	GENERIC on i386. Should not cause any issues since mount_ntfs(8)
210	will load ntfs.ko module automatically when NTFS support is
211	actually needed, unless ntfs.ko is not installed or security
212	level prohibits loading kernel modules. If either is the case,
213	"options NTFS" has to be added into kernel config.
214
21520090115:
216	TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
217	New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
218	800061. User space tools that rely on the size of struct tcpcb in
219	tcp_var.h (e.g. sockstat) need to be recompiled.
220
22120081225:
222	ng_tty(4) module updated to match the new TTY subsystem.
223	Due to API change, user-level applications must be updated.
224	New API support added to mpd5 CVS and expected to be present
225	in next mpd5.3 release.
226
22720081219:
228	With __FreeBSD_version 800060 the makefs tool is part of
229	the base system (it was a port).
230
23120081216:
232	The afdata and ifnet locks have been changed from mutexes to
233	rwlocks, network modules will need to be re-compiled.
234
23520081214:
236	__FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
237	RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
238	The new code reduced struct rtentry{} by 16 bytes on 32-bit
239	architecture and 40 bytes on 64-bit architecture. The userland
240	applications "arp" and "ndp" have been updated accordingly.
241	The output from "netstat -r" shows only routing entries and
242	none of the L2 information.
243
24420081130:
245	__FreeBSD_version 800057 marks the switchover from the
246	binary ath hal to source code. Users must add the line:
247
248	options	AH_SUPPORT_AR5416
249
250	to their kernel config files when specifying:
251
252	device	ath_hal
253
254	The ath_hal module no longer exists; the code is now compiled
255	together with the driver in the ath module.  It is now
256	possible to tailor chip support (i.e. reduce the set of chips
257	and thereby the code size); consult ath_hal(4) for details.
258
25920081121:
260	__FreeBSD_version 800054 adds memory barriers to
261	<machine/atomic.h>, new interfaces to ifnet to facilitate
262	multiple hardware transmit queues for cards that support
263	them, and a lock-less ring-buffer implementation to
264	enable drivers to more efficiently manage queueing of
265	packets.
266
26720081117:
268	A new version of ZFS (version 13) has been merged to -HEAD.
269	This version has zpool attribute "listsnapshots" off by
270	default, which means "zfs list" does not show snapshots,
271	and is the same as Solaris behavior.
272
27320081028:
274	dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
275
27620081009:
277	The uhci, ohci, ehci and slhci USB Host controller drivers have
278	been put into separate modules. If you load the usb module
279	separately through loader.conf you will need to load the
280	appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
281	controller add the following to loader.conf:
282
283		uhci_load="YES"
284		ehci_load="YES"
285
28620081009:
287	The ABI used by the PMC toolset has changed.  Please keep
288	userland (libpmc(3)) and the kernel module (hwpmc(4)) in
289	sync.
290
29120080820:
292	The TTY subsystem of the kernel has been replaced by a new
293	implementation, which provides better scalability and an
294	improved driver model. Most common drivers have been migrated to
295	the new TTY subsystem, while others have not. The following
296	drivers have not yet been ported to the new TTY layer:
297
298	PCI/ISA:
299		cy, digi, rc, rp, sio
300
301	USB:
302		ubser, ucycom
303
304	Line disciplines:
305		ng_h4, ng_tty, ppp, sl, snp
306
307	Adding these drivers to your kernel configuration file shall
308	cause compilation to fail.
309
31020080818:
311	ntpd has been upgraded to 4.2.4p5.
312
31320080801:
314	OpenSSH has been upgraded to 5.1p1.
315
316	For many years, FreeBSD's version of OpenSSH preferred DSA
317	over RSA for host and user authentication keys.  With this
318	upgrade, we've switched to the vendor's default of RSA over
319	DSA.  This may cause upgraded clients to warn about unknown
320	host keys even for previously known hosts.  Users should
321	follow the usual procedure for verifying host keys before
322	accepting the RSA key.
323
324	This can be circumvented by setting the "HostKeyAlgorithms"
325	option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
326	command line.
327
328	Please note that the sequence of keys offered for
329	authentication has been changed as well.  You may want to
330	specify IdentityFile in a different order to revert this
331	behavior.
332
33320080713:
334	The sio(4) driver has been removed from the i386 and amd64
335	kernel configuration files. This means uart(4) is now the
336	default serial port driver on those platforms as well.
337
338	To prevent collisions with the sio(4) driver, the uart(4) driver
339	uses different names for its device nodes. This means the
340	onboard serial port will now most likely be called "ttyu0"
341	instead of "ttyd0". You may need to reconfigure applications to
342	use the new device names.
343
344	When using the serial port as a boot console, be sure to update
345	/boot/device.hints and /etc/ttys before booting the new kernel.
346	If you forget to do so, you can still manually specify the hints
347	at the loader prompt:
348
349		set hint.uart.0.at="isa"
350		set hint.uart.0.port="0x3F8"
351		set hint.uart.0.flags="0x10"
352		set hint.uart.0.irq="4"
353		boot -s
354
35520080609:
356	The gpt(8) utility has been removed. Use gpart(8) to partition
357	disks instead.
358
35920080603:
360	The version that Linuxulator emulates was changed from 2.4.2
361	to 2.6.16. If you experience any problems with Linux binaries
362	please try to set sysctl compat.linux.osrelease to 2.4.2 and
363	if it fixes the problem contact emulation mailing list.
364
36520080525:
366	ISDN4BSD (I4B) was removed from the src tree. You may need to
367	update a your kernel configuration and remove relevant entries.
368
36920080509:
370	I have checked in code to support multiple routing tables.
371	See the man pages setfib(1) and setfib(2).
372	This is a hopefully backwards compatible version,
373	but to make use of it you need to compile your kernel
374	with options ROUTETABLES=2 (or more up to 16).
375
37620080420:
377	The 802.11 wireless support was redone to enable multi-bss
378	operation on devices that are capable.  The underlying device
379	is no longer used directly but instead wlanX devices are
380	cloned with ifconfig.  This requires changes to rc.conf files.
381	For example, change:
382		ifconfig_ath0="WPA DHCP"
383	to
384		wlans_ath0=wlan0
385		ifconfig_wlan0="WPA DHCP"
386	see rc.conf(5) for more details.  In addition, mergemaster of
387	/etc/rc.d is highly recommended.  Simultaneous update of userland
388	and kernel wouldn't hurt either.
389
390	As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
391	modules were merged into the base wlan module.  All references
392	to these modules (e.g. in kernel config files) must be removed.
393
39420080408:
395	psm(4) has gained write(2) support in native operation level.
396	Arbitrary commands can be written to /dev/psm%d and status can
397	be read back from it.  Therefore, an application is responsible
398	for status validation and error recovery.  It is a no-op in
399	other operation levels.
400
40120080312:
402	Support for KSE threading has been removed from the kernel.  To
403	run legacy applications linked against KSE libmap.conf may
404	be used.  The following libmap.conf may be used to ensure
405	compatibility with any prior release:
406
407	libpthread.so.1 libthr.so.1
408	libpthread.so.2 libthr.so.2
409	libkse.so.3 libthr.so.3
410
41120080301:
412	The layout of struct vmspace has changed. This affects libkvm
413	and any executables that link against libkvm and use the
414	kvm_getprocs() function. In particular, but not exclusively,
415	it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
416	The effects are minimal, but it's advisable to upgrade world
417	nonetheless.
418
41920080229:
420	The latest em driver no longer has support in it for the
421	82575 adapter, this is now moved to the igb driver. The
422	split was done to make new features that are incompatible
423	with older hardware easier to do.
424
42520080220:
426	The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
427	likewise the kernel option is now GEOM_LINUX_LVM.
428
42920080211:
430	The default NFS mount mode has changed from UDP to TCP for
431	increased reliability.  If you rely on (insecurely) NFS
432	mounting across a firewall you may need to update your
433	firewall rules.
434
43520080208:
436	Belatedly note the addition of m_collapse for compacting
437	mbuf chains.
438
43920080126:
440	The fts(3) structures have been changed to use adequate
441	integer types for their members and so to be able to cope
442	with huge file trees.  The old fts(3) ABI is preserved
443	through symbol versioning in libc, so third-party binaries
444	using fts(3) should still work, although they will not take
445	advantage of the extended types.  At the same time, some
446	third-party software might fail to build after this change
447	due to unportable assumptions made in its source code about
448	fts(3) structure members.  Such software should be fixed
449	by its vendor or, in the worst case, in the ports tree.
450	FreeBSD_version 800015 marks this change for the unlikely
451	case that a portable fix is impossible.
452
45320080123:
454	To upgrade to -current after this date, you must be running
455	FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
456	from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
457
45820071128:
459	The ADAPTIVE_GIANT kernel option has been retired because its
460	functionality is the default now.
461
46220071118:
463	The AT keyboard emulation of sunkbd(4) has been turned on
464	by default. In order to make the special symbols of the Sun
465	keyboards driven by sunkbd(4) work under X these now have
466	to be configured the same way as Sun USB keyboards driven
467	by ukbd(4) (which also does AT keyboard emulation), f.e.:
468
469	Option	"XkbLayout" "us"
470	Option	"XkbRules" "xorg"
471	Option	"XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
472
47320071024:
474	It has been decided that it is desirable to provide ABI
475	backwards compatibility to the FreeBSD 4/5/6 versions of the
476	PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
477	broken with the introduction of PCI domain support (see the
478	20070930 entry). Unfortunately, this required the ABI of
479	PCIOCGETCONF to be broken again in order to be able to
480	provide backwards compatibility to the old version of that
481	IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
482	again. As for prominent ports this affects neither pciutils
483	nor xorg-server this time, the hal port needs to be rebuilt
484	however.
485
48620071020:
487	The misnamed kthread_create() and friends have been renamed
488	to kproc_create() etc. Many of the callers already
489	used kproc_start()..
490	I will return kthread_create() and friends in a while
491	with implementations that actually create threads, not procs.
492	Renaming corresponds with version 800002.
493
49420071010:
495	RELENG_7 branched.
496
49720071009:
498	Setting WITHOUT_LIBPTHREAD now means WITHOUT_LIBKSE and
499	WITHOUT_LIBTHR are set.
500
50120070930:
502	The PCI code has been made aware of PCI domains. This means that
503	the location strings as used by pciconf(8) etc are now in the
504	following format: pci<domain>:<bus>:<device>[:<function>]. It
505	also means that consumers of <sys/pciio.h> potentially need to
506	be recompiled; this includes the hal and xorg-server ports.
507
50820070928:
509	The caching daemon (cached) was renamed to nscd. nscd.conf
510	configuration file should be used instead of cached.conf and
511	nscd_enable, nscd_pidfile and nscd_flags options should be used
512	instead of cached_enable, cached_pidfile and cached_flags in
513	rc.conf.
514
51520070921:
516	The getfacl(1) utility now prints owning user and group name
517	instead of owning uid and gid in the three line comment header.
518	This is the same behavior as getfacl(1) on Solaris and Linux.
519
52020070704:
521	The new IPsec code is now compiled in using the IPSEC option.  The
522	IPSEC option now requires "device crypto" be defined in your kernel
523	configuration.  The FAST_IPSEC kernel option is now deprecated.
524
52520070702:
526	The packet filter (pf) code has been updated to OpenBSD 4.1 Please
527	note the changed syntax - keep state is now on by default.  Also
528	note the fact that ftp-proxy(8) has been changed from bottom up and
529	has been moved from libexec to usr/sbin.  Changes in the ALTQ
530	handling also affect users of IPFW's ALTQ capabilities.
531
53220070701:
533	Remove KAME IPsec in favor of FAST_IPSEC, which is now the
534	only IPsec supported by FreeBSD.  The new IPsec stack
535	supports both IPv4 and IPv6. The kernel option will change
536	after the code changes have settled in.  For now the kernel
537	option IPSEC is deprecated and FAST_IPSEC is the only option, that
538	will change after some settling time.
539
54020070701:
541	The wicontrol(8) utility has been removed from the base system. wi(4)
542	cards should be configured using ifconfig(8), see the man page for more
543	information.
544
54520070612:
546	The i386/amd64 GENERIC kernel now defaults to the nfe(4) driver
547	instead of the nve(4) driver. Please update your configuration
548	accordingly.
549
55020070612:
551	By default, /etc/rc.d/sendmail no longer rebuilds the aliases
552	database if it is missing or older than the aliases file.  If
553	desired, set the new rc.conf option sendmail_rebuild_aliases
554	to "YES" to restore that functionality.
555
55620070612:
557	The IPv4 multicast socket code has been considerably modified, and
558	moved to the file sys/netinet/in_mcast.c. Initial support for the
559	RFC 3678 Source-Specific Multicast Socket API has been added to
560	the IPv4 network stack.
561
562	Strict multicast and broadcast reception is now the default for
563	UDP/IPv4 sockets; the net.inet.udp.strict_mcast_mship sysctl variable
564	has now been removed.
565
566	The RFC 1724 hack for interface selection has been removed; the use
567	of the Linux-derived ip_mreqn structure with IP_MULTICAST_IF has
568	been added to replace it. Consumers such as routed will soon be
569	updated to reflect this.
570
571	These changes affect users who are running routed(8) or rdisc(8)
572	from the FreeBSD base system on point-to-point or unnumbered
573	interfaces.
574
57520070610:
576	The net80211 layer has changed significantly and all wireless
577	drivers that depend on it need to be recompiled.  Further these
578	changes require that any program that interacts with the wireless
579	support in the kernel be recompiled; this includes: ifconfig,
580	wpa_supplicant, hostapd, and wlanstats.  Users must also, for
581	the moment, kldload the wlan_scan_sta and/or wlan_scan_ap modules
582	if they use modules for wireless support.  These modules implement
583	scanning support for station and ap modes, respectively.  Failure
584	to load the appropriate module before marking a wireless interface
585	up will result in a message to the console and the device not
586	operating properly.
587
58820070610:
589	The pam_nologin(8) module ceases to provide an authentication
590	function and starts providing an account management function.
591	Consequent changes to /etc/pam.d should be brought in using
592	mergemaster(8).  Third-party files in /usr/local/etc/pam.d may
593	need manual editing as follows.  Locate this line (or similar):
594
595		auth	required	pam_nologin.so	no_warn
596
597	and change it according to this example:
598
599		account	required	pam_nologin.so	no_warn
600
601	That is, the first word needs to be changed from "auth" to
602	"account".  The new line can be moved to the account section
603	within the file for clarity.  Not updating pam.conf(5) files
604	will result in nologin(5) ignored by the respective services.
605
60620070529:
607	The ether_ioctl() function has been synchronized with ioctl(2)
608	and ifnet.if_ioctl.  Due to that, the size of one of its arguments
609	has changed on 64-bit architectures.  All kernel modules using
610	ether_ioctl() need to be rebuilt on such architectures.
611
61220070516:
613	Improved INCLUDE_CONFIG_FILE support has been introduced to the
614	config(8) utility. In order to take advantage of this new
615	functionality, you are expected to recompile and install
616	src/usr.sbin/config. If you don't rebuild config(8), and your
617	kernel configuration depends on INCLUDE_CONFIG_FILE, the kernel
618	build will be broken because of a missing "kernconfstring"
619	symbol.
620
62120070513:
622	Symbol versioning is enabled by default.  To disable it, use
623	option WITHOUT_SYMVER.  It is not advisable to attempt to
624	disable symbol versioning once it is enabled; your installworld
625	will break because a symbol version-less libc will get installed
626	before the install tools.  As a result, the old install tools,
627	which previously had symbol dependencies to FBSD_1.0, will fail
628	because the freshly installed libc will not have them.
629
630	The default threading library (providing "libpthread") has been
631	changed to libthr.  If you wish to have libkse as your default,
632	use option DEFAULT_THREAD_LIB=libkse for the buildworld.
633
63420070423:
635	The ABI breakage in sendmail(8)'s libmilter has been repaired
636	so it is no longer necessary to recompile mail filters (aka,
637	milters).  If you recompiled mail filters after the 20070408
638	note, it is not necessary to recompile them again.
639
64020070417:
641	The new trunk(4) driver has been renamed to lagg(4) as it better
642	reflects its purpose. ifconfig will need to be recompiled.
643
64420070408:
645	sendmail(8) has been updated to version 8.14.1.  Mail filters
646	(aka, milters) compiled against the libmilter included in the
647	base operating system should be recompiled.
648
64920070302:
650	Firmwares for ipw(4) and iwi(4) are now included in the base tree.
651	In order to use them one must agree to the respective LICENSE in
652	share/doc/legal and define legal.intel_<name>.license_ack=1 via
653	loader.conf(5) or kenv(1).  Make sure to deinstall the now
654	deprecated modules from the respective firmware ports.
655
65620070228:
657	The name resolution/mapping functions addr2ascii(3) and ascii2addr(3)
658	were removed from FreeBSD's libc. These originally came from INRIA
659	IPv6. Nothing in FreeBSD ever used them. They may be regarded as
660	deprecated in previous releases.
661	The AF_LINK support for getnameinfo(3) was merged from NetBSD to
662	replace it as a more portable (and re-entrant) API.
663
66420070224:
665	To support interrupt filtering a modification to the newbus API
666	has occurred, ABI was broken and __FreeBSD_version was bumped
667	to 700031. Please make sure that your kernel and modules are in
668	sync. For more info:
669	http://docs.freebsd.org/cgi/mid.cgi?20070221233124.GA13941
670
67120070224:
672	The IPv6 multicast forwarding code may now be loaded into GENERIC
673	kernels by loading the ip_mroute.ko module. This is built into the
674	module unless WITHOUT_INET6 or WITHOUT_INET6_SUPPORT options are
675	set; see src.conf(5) for more information.
676
67720070214:
678	The output of netstat -r has changed. Without -n, we now only
679	print a "network name" without the prefix length if the network
680	address and mask exactly match a Class A/B/C network, and an entry
681	exists in the nsswitch "networks" map.
682	With -n, we print the full unabbreviated CIDR network prefix in
683	the form "a.b.c.d/p". 0.0.0.0/0 is always printed as "default".
684	This change is in preparation for changes such as equal-cost
685	multipath, and to more generally assist operational deployment
686	of FreeBSD as a modern IPv4 router.
687
68820070210:
689	PIM has been turned on by default in the IPv4 multicast
690	routing code. The kernel option 'PIM' has now been removed.
691	PIM is now built by default if option 'MROUTING' is specified.
692	It may now be loaded into GENERIC kernels by loading the
693	ip_mroute.ko module.
694
69520070207:
696	Support for IPIP tunnels (VIFF_TUNNEL) in IPv4 multicast routing
697	has been removed. Its functionality may be achieved by explicitly
698	configuring gif(4) interfaces and using the 'phyint' keyword in
699	mrouted.conf.
700	XORP does not support source-routed IPv4 multicast tunnels nor the
701	integrated IPIP tunneling, therefore it is not affected by this
702	change. The __FreeBSD_version macro has been bumped to 700030.
703
70420061221:
705	Support for PCI Message Signalled Interrupts has been
706	re-enabled in the bge driver, only for those chips which are
707	believed to support it properly.  If there are any problems,
708	MSI can be disabled completely by setting the
709	'hw.pci.enable_msi' and 'hw.pci.enable_msix' tunables to 0
710	in the loader.
711
71220061214:
713	Support for PCI Message Signalled Interrupts has been
714	disabled again in the bge driver.  Many revisions of the
715	hardware fail to support it properly.  Support can be
716	re-enabled by removing the #define of BGE_DISABLE_MSI in
717	"src/sys/dev/bge/if_bge.c".
718
71920061214:
720	Support for PCI Message Signalled Interrupts has been added
721	to the bge driver.  If there are any problems, MSI can be
722	disabled completely by setting the 'hw.pci.enable_msi' and
723	'hw.pci.enable_msix' tunables to 0 in the loader.
724
72520061205:
726	The removal of several facets of the experimental Threading
727	system from the kernel means that the proc and thread structures
728	have changed quite a bit. I suggest all kernel modules that might
729	reference these structures be recompiled.. Especially the
730	linux module.
731
73220061126:
733	Sound infrastructure has been updated with various fixes and
734	improvements. Most of the changes are pretty much transparent,
735	with exceptions of followings:
736	1) All sound driver specific sysctls (hw.snd.pcm%d.*) have been
737	   moved to their own dev sysctl nodes, for example:
738		hw.snd.pcm0.vchans -> dev.pcm.0.vchans
739	2) /dev/dspr%d.%d has been deprecated. Each channel now has its
740	   own chardev in the form of "dsp%d.<function>%d", where <function>
741	   is p = playback, r = record and v = virtual, respectively. Users
742	   are encouraged to use these devs instead of (old) "/dev/dsp%d.%d".
743	   This does not affect those who are using "/dev/dsp".
744
74520061122:
746	geom(4)'s gmirror(8) class metadata structure has been
747	rev'd from v3 to v4. If you update across this point and
748	your metadata is converted for you, you will not be easily
749	able to downgrade since the /boot/kernel.old/geom_mirror.ko
750	kernel module will be unable to read the v4 metadata.  You
751	can resolve this by doing from the loader(8) prompt:
752
753		set vfs.root.mountfrom="ufs:/dev/XXX"
754
755	where XXX is the root slice of one of the disks that composed
756	the mirror (i.e.: /dev/ad0s1a). You can then rebuild
757	the array the same way you built it originally.
758
75920061122:
760	The following binaries have been disconnected from the build:
761	mount_devfs, mount_ext2fs, mount_fdescfs, mount_procfs, mount_linprocfs,
762	and mount_std.  The functionality of these programs has been
763	moved into the mount program.  For example, to mount a devfs
764	filesystem, instead of using mount_devfs, use: "mount -t devfs".
765	This does not affect entries in /etc/fstab, since entries in
766	/etc/fstab are always processed with "mount -t fstype".
767
76820061113:
769	Support for PCI Message Signalled Interrupts on i386 and amd64
770	has been added to the kernel and various drivers will soon be
771	updated to use MSI when it is available.  If there are any problems,
772	MSI can be disabled completely by setting the 'hw.pci.enable_msi'
773	and 'hw.pci.enable_msix' tunables to 0 in the loader.
774
77520061110:
776	The MUTEX_PROFILING option has been renamed to LOCK_PROFILING.
777	The lockmgr object layout has been changed as a result of having
778	a lock_object embedded in it. As a consequence all file system
779	kernel modules must be re-compiled. The mutex profiling man page
780	has not yet been updated to reflect this change.
781
78220061026:
783	KSE in the kernel has now been made optional and turned on by
784	default. Use 'nooption KSE' in your kernel config to turn it
785	off. All kernel modules *must* be recompiled after this change.
786	There-after, modules from a KSE kernel should be compatible with
787	modules from a NOKSE kernel due to the temporary padding fields
788	added to 'struct proc'.
789
79020060929:
791	mrouted and its utilities have been removed from the base system.
792
79320060927:
794	Some ioctl(2) command codes have changed.  Full backward ABI
795	compatibility is provided if the "options COMPAT_FREEBSD6" is
796	present in the kernel configuration file.  Make sure to add
797	this option to your kernel config file, or recompile X.Org
798	and the rest of ports; otherwise they may refuse to work.
799
80020060924:
801	tcpslice has been removed from the base system.
802
80320060913:
804	The sizes of struct tcpcb (and struct xtcpcb) have changed due to
805	the rewrite of TCP syncookies.  Tools like netstat, sockstat, and
806	systat needs to be rebuilt.
807
80820060903:
809	libpcap updated to v0.9.4 and tcpdump to v3.9.4
810
81120060816:
812	The IPFIREWALL_FORWARD_EXTENDED option is gone and the behaviour
813	for IPFIREWALL_FORWARD is now as it was before when it was first
814	committed and for years after. The behaviour is now ON.
815
81620060725:
817	enigma(1)/crypt(1) utility has been changed on 64 bit architectures.
818	Now it can decrypt files created from different architectures.
819	Unfortunately, it is no longer able to decrypt a cipher text
820	generated with an older version on 64 bit architectures.
821	If you have such a file, you need old utility to decrypt it.
822
82320060709:
824	The interface version of the i4b kernel part has changed. So
825	after updating the kernel sources and compiling a new kernel,
826	the i4b user space tools in "/usr/src/usr.sbin/i4b" must also
827	be rebuilt, and vice versa.
828
82920060627:
830	The XBOX kernel now defaults to the nfe(4) driver instead of
831	the nve(4) driver. Please update your configuration
832	accordingly.
833
83420060514:
835	The i386-only lnc(4) driver for the AMD Am7900 LANCE and Am79C9xx
836	PCnet family of NICs has been removed. The new le(4) driver serves
837	as an equivalent but cross-platform replacement with the pcn(4)
838	driver still providing performance-optimized support for the subset
839	of AMD Am79C971 PCnet-FAST and greater chips as before.
840
84120060511:
842	The machdep.* sysctls and the adjkerntz utility have been
843	modified a bit.  The new adjkerntz utility uses the new
844	sysctl names and sysctlbyname() calls, so it may be impossible
845	to run an old /sbin/adjkerntz utility in single-user mode
846	with a new kernel.  Replace the `adjkerntz -i' step before
847	`make installworld' with:
848
849	    /usr/obj/usr/src/sbin/adjkerntz/adjkerntz -i
850
851	and proceed as usual with the rest of the installworld-stage
852	steps.  Otherwise, you risk installing binaries with their
853	timestamp set several hours in the future, especially if
854	you are running with local time set to GMT+X hours.
855
85620060412:
857	The ip6fw utility has been removed.  The behavior provided by
858	ip6fw has been in ipfw2 for a good while and the rc.d scripts
859	have been updated to deal with it.  There are some rules that
860	might not migrate cleanly.  Use rc.firewall6 as a template to
861	rewrite rules.
862
86320060428:
864	The puc(4) driver has been overhauled. The ebus(4) and sbus(4)
865	attachments have been removed. Make sure to configure scc(4)
866	on sparc64. Note also that by default puc(4) will use uart(4)
867	and not sio(4) for serial ports because interrupt handling has
868	been optimized for multi-port serial cards and only uart(4)
869	implements the interface to support it.
870
87120060330:
872	The scc(4) driver replaces puc(4) for Serial Communications
873	Controllers (SCCs) like the Siemens SAB82532 and the Zilog
874	Z8530. On sparc64, it is advised to add scc(4) to the kernel
875	configuration to make sure that the serial ports remain
876	functional.
877
87820060317:
879	Most world/kernel related NO_* build options changed names.
880	New knobs have common prefixes WITHOUT_*/WITH_* (modelled
881	after FreeBSD ports) and should be set in /etc/src.conf
882	(the src.conf(5) manpage is provided).  Full backwards
883	compatibility is maintained for the time being though it's
884	highly recommended to start moving old options out of the
885	system-wide /etc/make.conf file into the new /etc/src.conf
886	while also properly renaming them.  More conversions will
887	likely follow.  Posting to current@:
888
889	http://lists.freebsd.org/pipermail/freebsd-current/2006-March/061725.html
890
89120060305:
892	The NETSMBCRYPTO kernel option has been retired because its
893	functionality is always included in NETSMB and smbfs.ko now.
894
89520060303:
896	The TDFX_LINUX kernel option was retired and replaced by the
897	tdfx_linux device.  The latter can be loaded as the 3dfx_linux.ko
898	kernel module.  Loading it alone should suffice to get 3dfx support
899	for Linux apps because it will pull in 3dfx.ko and linux.ko through
900	its dependencies.
901
90220060204:
903	The 'audit' group was added to support the new auditing functionality
904	in the base system.  Be sure to follow the directions for updating,
905	including the requirement to run mergemaster -p.
906
90720060201:
908	The kernel ABI to file system modules was changed on i386.
909	Please make sure that your kernel and modules are in sync.
910
91120060118:
912	This actually occured some time ago, but installing the kernel
913	now also installs a bunch of symbol files for the kernel modules.
914	This increases the size of /boot/kernel to about 67Mbytes. You
915	will need twice this if you will eventually back this up to kernel.old
916	on your next install.
917	If you have a shortage of room in your root partition, you should add
918	-DINSTALL_NODEBUG to your make arguments or add INSTALL_NODEBUG="yes"
919	to your /etc/make.conf.
920
92120060113:
922	libc's malloc implementation has been replaced.  This change has the
923	potential to uncover application bugs that previously went unnoticed.
924	See the malloc(3) manual page for more details.
925
92620060112:
927	The generic netgraph(4) cookie has been changed. If you upgrade
928	kernel passing this point, you also need to upgrade userland
929	and netgraph(4) utilities like ports/net/mpd or ports/net/mpd4.
930
93120060106:
932	si(4)'s device files now contain the unit number.
933	Uses of {cua,tty}A[0-9a-f] should be replaced by {cua,tty}A0[0-9a-f].
934
93520060106:
936	The kernel ABI was mostly destroyed due to a change in the size
937	of struct lock_object which is nested in other structures such
938	as mutexes which are nested in all sorts of other structures.
939	Make sure your kernel and modules are in sync.
940
94120051231:
942	The page coloring algorithm in the VM subsystem was converted
943	from tuning with kernel options to autotuning. Please remove
944	any PQ_* option except PQ_NOOPT from your kernel config.
945
94620051211:
947	The net80211-related tools in the tools/tools/ath directory
948	have been moved to tools/tools/net80211 and renamed with a
949	"wlan" prefix.  Scripts that use them should be adjusted
950	accordingly.
951
95220051202:
953	Scripts in the local_startup directories (as defined in
954	/etc/defaults/rc.conf) that have the new rc.d semantics will
955	now be run as part of the base system rcorder. If there are
956	errors or problems with one of these local scripts, it could
957	cause boot problems. If you encounter such problems, boot in
958	single user mode, remove that script from the */rc.d directory.
959	Please report the problem to the port's maintainer, and the
960	freebsd-ports@freebsd.org mailing list.
961
96220051129:
963	The nodev mount option was deprecated in RELENG_6 (where it
964	was a no-op), and is now unsupported.  If you have nodev or dev listed
965	in /etc/fstab, remove it, otherwise it will result in a mount error.
966
96720051129:
968	ABI between ipfw(4) and ipfw(8) has been changed. You need
969	to rebuild ipfw(8) when rebuilding kernel.
970
97120051108:
972	rp(4)'s device files now contain the unit number.
973	Uses of {cua,tty}R[0-9a-f] should be replaced by {cua,tty}R0[0-9a-f].
974
97520051029:
976	/etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp.
977	Its /etc/rc.conf.d configuration file has been `ppp' from
978	the beginning, and hence there is no need to touch it.
979
98020051014:
981	Now most modules get their build-time options from the kernel
982	configuration file.  A few modules still have fixed options
983	due to their non-conformant implementation, but they will be
984	corrected eventually.  You may need to review the options of
985	the modules in use, explicitly specify the non-default options
986	in the kernel configuration file, and rebuild the kernel and
987	modules afterwards.
988
98920051001:
990	kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8)
991	to turn polling(4) on your interfaces.
992
99320050927:
994	The old bridge(4) implementation was retired.  The new
995	if_bridge(4) serves as a full functional replacement.
996
99720050722:
998	The ai_addrlen of a struct addrinfo was changed to a socklen_t
999	to conform to POSIX-2001.  This change broke an ABI
1000	compatibility on 64 bit architecture.  You have to recompile
1001	userland programs that use getaddrinfo(3) on 64 bit
1002	architecture.
1003
100420050711:
1005	RELENG_6 branched here.
1006
100720050629:
1008	The pccard_ifconfig rc.conf variable has been removed and a new
1009	variable, ifconfig_DEFAULT has been introduced.  Unlike
1010	pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that
1011	do not have ifconfig_ifn entries rather than just those in
1012	removable_interfaces.
1013
101420050616:
1015	Some previous versions of PAM have permitted the use of
1016	non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring
1017	to third party PAM modules in /usr/local/lib.  A change has been
1018	made to require the use of absolute paths in order to avoid
1019	ambiguity and dependence on library path configuration, which may
1020	affect existing configurations.
1021
102220050610:
1023	Major changes to network interface API.  All drivers must be
1024	recompiled.  Drivers not in the base system will need to be
1025	updated to the new APIs.
1026
102720050609:
1028	Changes were made to kinfo_proc in sys/user.h.  Please recompile
1029	userland, or commands like `fstat', `pkill', `ps', `top' and `w'
1030	will not behave correctly.
1031
1032	The API and ABI for hwpmc(4) have changed with the addition
1033	of sampling support.  Please recompile lib/libpmc(3) and
1034	usr.sbin/{pmcstat,pmccontrol}.
1035
103620050606:
1037	The OpenBSD dhclient was imported in place of the ISC dhclient
1038	and the network interface configuration scripts were updated
1039	accordingly.  If you use DHCP to configure your interfaces, you
1040	must now run devd.  Also, DNS updating was lost so you will need
1041	to find a workaround if you use this feature.
1042
1043	The '_dhcp' user was added to support the OpenBSD dhclient.  Be
1044	sure to run mergemaster -p (like you are supposed to do every time
1045	anyway).
1046
104720050605:
1048	if_bridge was added to the tree. This has changed struct ifnet.
1049	Please recompile userland and all network related modules.
1050
105120050603:
1052	The n_net of a struct netent was changed to an uint32_t, and
1053	1st argument of getnetbyaddr() was changed to an uint32_t, to
1054	conform to POSIX-2001.  These changes broke an ABI
1055	compatibility on 64 bit architecture.  With these changes,
1056	shlib major of libpcap was bumped.  You have to recompile
1057	userland programs that use getnetbyaddr(3), getnetbyname(3),
1058	getnetent(3) and/or libpcap on 64 bit architecture.
1059
106020050528:
1061	Kernel parsing of extra options on '#!' first lines of shell
1062	scripts has changed.  Lines with multiple options likely will
1063	fail after this date.  For full details, please see
1064		http://people.freebsd.org/~gad/Updating-20050528.txt
1065
106620050503:
1067	The packet filter (pf) code has been updated to OpenBSD 3.7
1068	Please note the changed anchor syntax and the fact that
1069	authpf(8) now needs a mounted fdescfs(5) to function.
1070
107120050415:
1072	The NO_MIXED_MODE kernel option has been removed from the i386
1073	amd64 platforms as its use has been superceded by the new local
1074	APIC timer code.  Any kernel config files containing this option
1075	should be updated.
1076
107720050227:
1078	The on-disk format of LC_CTYPE files was changed to be machine
1079	independent.  Please make sure NOT to use NO_CLEAN buildworld
1080	when crossing this point. Crossing this point also requires
1081	recompile or reinstall of all locale depended packages.
1082
108320050225:
1084	The ifi_epoch member of struct if_data has been changed to
1085	contain the uptime at which the interface was created or the
1086	statistics zeroed rather then the wall clock time because
1087	wallclock time may go backwards.  This should have no impact
1088	unless an snmp implementation is using this value (I know of
1089	none at this point.)
1090
109120050224:
1092	The acpi_perf and acpi_throttle drivers are now part of the
1093	acpi(4) main module.  They are no longer built separately.
1094
109520050223:
1096	The layout of struct image_params has changed. You have to
1097	recompile all compatibility modules (linux, svr4, etc) for use
1098	with the new kernel.
1099
110020050223:
1101	The p4tcc driver has been merged into cpufreq(4).  This makes
1102	"options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
1103	compile in "device cpufreq" to restore this functionality.
1104
110520050220:
1106	The responsibility of recomputing the file system summary of
1107	a SoftUpdates-enabled dirty volume has been transferred to the
1108	background fsck.  A rebuild of fsck(8) utility is recommended
1109	if you have updated the kernel.
1110
1111	To get the old behavior (recompute file system summary at mount
1112	time), you can set vfs.ffs.compute_summary_at_mount=1 before
1113	mounting the new volume.
1114
111520050206:
1116	The cpufreq import is complete.  As part of this, the sysctls for
1117	acpi(4) throttling have been removed.  The power_profile script
1118	has been updated, so you can use performance/economy_cpu_freq in
1119	rc.conf(5) to set AC on/offline cpu frequencies.
1120
112120050206:
1122	NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
1123	requires recompiling libnetgraph and userland netgraph utilities.
1124
112520050114:
1126	Support for abbreviated forms of a number of ipfw options is
1127	now deprecated.  Warnings are printed to stderr indicating the
1128	correct full form when a match occurs.  Some abbreviations may
1129	be supported at a later date based on user feedback.  To be
1130	considered for support, abbreviations must be in use prior to
1131	this commit and unlikely to be confused with current key words.
1132
113320041221:
1134	By a popular demand, a lot of NOFOO options were renamed
1135	to NO_FOO (see bsd.compat.mk for a full list).  The old
1136	spellings are still supported, but will cause annoying
1137	warnings on stderr.  Make sure you upgrade properly (see
1138	the COMMON ITEMS: section later in this file).
1139
114020041219:
1141	Auto-loading of ancillary wlan modules such as wlan_wep has
1142	been temporarily disabled; you need to statically configure
1143	the modules you need into your kernel or explicitly load them
1144	prior to use.  Specifically, if you intend to use WEP encryption
1145	with an 802.11 device load/configure wlan_wep; if you want to
1146	use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
1147	and wlan_xauth as required.
1148
114920041213:
1150	The behaviour of ppp(8) has changed slightly.  If lqr is enabled
1151	(``enable lqr''), older versions would revert to LCP ECHO mode on
1152	negotiation failure.  Now, ``enable echo'' is required for this
1153	behaviour.  The ppp version number has been bumped to 3.4.2 to
1154	reflect the change.
1155
115620041201:
1157	The wlan support has been updated to split the crypto support
1158	into separate modules.  For static WEP you must configure the
1159	wlan_wep module in your system or build and install the module
1160	in place where it can be loaded (the kernel will auto-load
1161	the module when a wep key is configured).
1162
116320041201:
1164	The ath driver has been updated to split the tx rate control
1165	algorithm into a separate module.  You need to include either
1166	ath_rate_onoe or ath_rate_amrr when configuring the kernel.
1167
116820041116:
1169	Support for systems with an 80386 CPU has been removed.  Please
1170	use FreeBSD 5.x or earlier on systems with an 80386.
1171
117220041110:
1173	We have had a hack which would mount the root filesystem
1174	R/W if the device were named 'md*'.  As part of the vnode
1175	work I'm doing I have had to remove this hack.  People
1176	building systems which use preloaded MD root filesystems
1177	may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
1178	their /etc/rc scripts.
1179
118020041104:
1181	FreeBSD 5.3 shipped here.
1182
118320041102:
1184	The size of struct tcpcb has changed again due to the removal
1185	of RFC1644 T/TCP.  You have to recompile userland programs that
1186	read kmem for tcp sockets directly (netstat, sockstat, etc.)
1187
118820041022:
1189	The size of struct tcpcb has changed.  You have to recompile
1190	userland programs that read kmem for tcp sockets directly
1191	(netstat, sockstat, etc.)
1192
119320041016:
1194	RELENG_5 branched here.  For older entries, please see updating
1195	in the RELENG_5 branch.
1196
1197COMMON ITEMS:
1198
1199	General Notes
1200	-------------
1201	Avoid using make -j when upgrading.  From time to time in the
1202	past there have been problems using -j with buildworld and/or
1203	installworld.  This is especially true when upgrading between
1204	"distant" versions (eg one that cross a major release boundary
1205	or several minor releases, or when several months have passed
1206	on the -current branch).
1207
1208	Sometimes, obscure build problems are the result of environment
1209	poisoning.  This can happen because the make utility reads its
1210	environment when searching for values for global variables.
1211	To run your build attempts in an "environmental clean room",
1212	prefix all make commands with 'env -i '.  See the env(1) manual
1213	page for more details.
1214
1215	When upgrading from one major version to another it is generally
1216	best to upgrade to the latest code in the currently installed branch
1217	first, then do an upgrade to the new branch. This is the best-tested
1218	upgrade path, and has the highest probability of being successful.
1219	Please try this approach before reporting problems with a major
1220	version upgrade.
1221
1222	To build a kernel
1223	-----------------
1224	If you are updating from a prior version of FreeBSD (even one just
1225	a few days old), you should follow this procedure.  It is the most
1226	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1227
1228	make kernel-toolchain
1229	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1230	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1231
1232	To test a kernel once
1233	---------------------
1234	If you just want to boot a kernel once (because you are not sure
1235	if it works, or if you want to boot a known bad kernel to provide
1236	debugging information) run
1237	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1238	nextboot -k testkernel
1239
1240	To just build a kernel when you know that it won't mess you up
1241	--------------------------------------------------------------
1242	This assumes you are already running a 5.X system.  Replace
1243	${arch} with the architecture of your machine (e.g. "i386",
1244	"alpha", "amd64", "ia64", "pc98", "sparc64", etc).
1245
1246	cd src/sys/${arch}/conf
1247	config KERNEL_NAME_HERE
1248	cd ../compile/KERNEL_NAME_HERE
1249	make depend
1250	make
1251	make install
1252
1253	If this fails, go to the "To build a kernel" section.
1254
1255	To rebuild everything and install it on the current system.
1256	-----------------------------------------------------------
1257	# Note: sometimes if you are running current you gotta do more than
1258	# is listed here if you are upgrading from a really old current.
1259
1260	<make sure you have good level 0 dumps>
1261	make buildworld
1262	make kernel KERNCONF=YOUR_KERNEL_HERE
1263							[1]
1264	<reboot in single user>				[3]
1265	mergemaster -p					[5]
1266	make installworld
1267	make delete-old
1268	mergemaster					[4]
1269	<reboot>
1270
1271
1272	To cross-install current onto a separate partition
1273	--------------------------------------------------
1274	# In this approach we use a separate partition to hold
1275	# current's root, 'usr', and 'var' directories.   A partition
1276	# holding "/", "/usr" and "/var" should be about 2GB in
1277	# size.
1278
1279	<make sure you have good level 0 dumps>
1280	<boot into -stable>
1281	make buildworld
1282	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1283	<maybe newfs current's root partition>
1284	<mount current's root partition on directory ${CURRENT_ROOT}>
1285	make installworld DESTDIR=${CURRENT_ROOT}
1286	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1287	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1288	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1289	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1290	<reboot into current>
1291	<do a "native" rebuild/install as described in the previous section>
1292	<maybe install compatibility libraries from ports/misc/compat*>
1293	<reboot>
1294
1295
1296	To upgrade in-place from 5.x-stable to current
1297	----------------------------------------------
1298	<make sure you have good level 0 dumps>
1299	make buildworld					[9]
1300	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
1301							[1]
1302	<reboot in single user>				[3]
1303	mergemaster -p					[5]
1304	make installworld
1305	make delete-old
1306	mergemaster -i					[4]
1307	<reboot>
1308
1309	Make sure that you've read the UPDATING file to understand the
1310	tweaks to various things you need.  At this point in the life
1311	cycle of current, things change often and you are on your own
1312	to cope.  The defaults can also change, so please read ALL of
1313	the UPDATING entries.
1314
1315	Also, if you are tracking -current, you must be subscribed to
1316	freebsd-current@freebsd.org.  Make sure that before you update
1317	your sources that you have read and understood all the recent
1318	messages there.  If in doubt, please track -stable which has
1319	much fewer pitfalls.
1320
1321	[1] If you have third party modules, such as vmware, you
1322	should disable them at this point so they don't crash your
1323	system on reboot.
1324
1325	[3] From the bootblocks, boot -s, and then do
1326		fsck -p
1327		mount -u /
1328		mount -a
1329		cd src
1330		adjkerntz -i		# if CMOS is wall time
1331	Also, when doing a major release upgrade, it is required that
1332	you boot into single user mode to do the installworld.
1333
1334	[4] Note: This step is non-optional.  Failure to do this step
1335	can result in a significant reduction in the functionality of the
1336	system.  Attempting to do it by hand is not recommended and those
1337	that pursue this avenue should read this file carefully, as well
1338	as the archives of freebsd-current and freebsd-hackers mailing lists
1339	for potential gotchas.
1340
1341	[5] Usually this step is a noop.  However, from time to time
1342	you may need to do this if you get unknown user in the following
1343	step.  It never hurts to do it all the time.  You may need to
1344	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1345	install) after the buildworld before this step if you last updated
1346	from current before 20020224 or from -stable before 20020408.
1347
1348	[8] In order to have a kernel that can run the 4.x binaries
1349	needed to do an installworld, you must include the COMPAT_FREEBSD4
1350	option in your kernel.  Failure to do so may leave you with a system
1351	that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5
1352	is required to run the 5.x binaries on more recent kernels.
1353
1354	Make sure that you merge any new devices from GENERIC since the
1355	last time you updated your kernel config file.
1356
1357	[9] When checking out sources, you must include the -P flag to have
1358	cvs prune empty directories.
1359
1360	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1361	"?=" instead of the "=" assignment operator, so that buildworld can
1362	override the CPUTYPE if it needs to.
1363
1364	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1365	not on the command line, or in /etc/make.conf.  buildworld will
1366	warn if it is improperly defined.
1367FORMAT:
1368
1369This file contains a list, in reverse chronological order, of major
1370breakages in tracking -current.  Not all things will be listed here,
1371and it only starts on October 16, 2004.  Updating files can found in
1372previous releases if your system is older than this.
1373
1374Copyright information:
1375
1376Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
1377
1378Redistribution, publication, translation and use, with or without
1379modification, in full or in part, in any form or format of this
1380document are permitted without further permission from the author.
1381
1382THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1383IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1384WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1385DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1386INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1387(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1388SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1389HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1390STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1391IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1392POSSIBILITY OF SUCH DAMAGE.
1393
1394If you find this document useful, and you want to, you may buy the
1395author a beer.
1396
1397Contact Warner Losh if you have any questions about your use of
1398this document.
1399
1400$FreeBSD: head/UPDATING 191080 2009-04-14 23:05:36Z kmacy $
1401