xref: /freebsd/UPDATING (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
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.
23
2420071128:
25	The ADAPTIVE_GIANT kernel option has been retired because its
26	functionality is the default now.
27
2820071118:
29	The AT keyboard emulation of sunkbd(4) has been turned on
30	by default. In order to make the special symbols of the Sun
31	keyboards driven by sunkbd(4) work under X these now have
32	to be configured the same way as Sun USB keyboards driven
33	by ukbd(4) (which also does AT keyboard emulation), f.e.:
34
35	Option	"XkbLayout" "us"
36	Option	"XkbRules" "xorg"
37	Option	"XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
38
3920071024:
40	It has been decided that it is desirable to provide ABI
41	backwards compatibility to the FreeBSD 4/5/6 versions of the
42	PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
43	broken with the introduction of PCI domain support (see the
44	20070930 entry). Unfortunately, this required the ABI of
45	PCIOCGETCONF to be broken again in order to be able to
46	provide backwards compatibility to the old version of that
47	IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
48	again. As for prominent ports this affects neither pciutils
49	nor xorg-server this time, the hal port needs to be rebuilt
50	however.
51
5220071020:
53	The misnamed kthread_create() and friends have been renamed
54	to kproc_create() etc. Many of the callers already
55	used kproc_start()..
56	I will return kthread_create() and friends in a while
57	with implementations that actually create threads, not procs.
58	Renaming corresponds with version 800002.
59
6020071010:
61	RELENG_7 branched.
62
6320071009:
64	Setting WITHOUT_LIBPTHREAD now means WITHOUT_LIBKSE and
65	WITHOUT_LIBTHR are set.
66
6720070930:
68	The PCI code has been made aware of PCI domains. This means that
69	the location strings as used by pciconf(8) etc are now in the
70	following format: pci<domain>:<bus>:<device>[:<function>]. It
71	also means that consumers of <sys/pciio.h> potentially need to
72	be recompiled; this includes the hal and xorg-server ports.
73
7420070928:
75        The caching daemon (cached) was renamed to nscd. nscd.conf
76        configuration file should be used instead of cached.conf and
77        nscd_enable, nscd_pidfile and nscd_flags options should be used
78        instead of cached_enable, cached_pidfile and cached_flags in
79        rc.conf.
80
8120070921:
82	The getfacl(1) utility now prints owning user and group name
83	instead of owning uid and gid in the three line comment header.
84	This is the same behavior as getfacl(1) on Solaris and Linux.
85
8620070704:
87        The new IPsec code is now compiled in using the IPSEC option.  The
88	IPSEC option now requires "device crypto" be defined in your kernel
89	configuration.  The FAST_IPSEC kernel option is now deprecated.
90
9120070702:
92	The packet filter (pf) code has been updated to OpenBSD 4.1 Please
93	note the changed syntax - keep state is now on by default.  Also
94	note the fact that ftp-proxy(8) has been changed from bottom up and
95	has been moved from libexec to usr/sbin.  Changes in the ALTQ
96	handling also affect users of IPFW's ALTQ capabilities.
97
9820070701:
99	Remove KAME IPsec in favor of FAST_IPSEC, which is now the
100	only IPsec supported by FreeBSD.  The new IPsec stack
101	supports both IPv4 and IPv6. The kernel option will change
102	after the code changes have settled in.  For now the kernel
103	option IPSEC is deprecated and FAST_IPSEC is the only option, that
104	will change after some settling time.
105
10620070701:
107	The wicontrol(8) utility has been removed from the base system. wi(4)
108	cards should be configured using ifconfig(8), see the man page for more
109	information.
110
11120070612:
112	The i386/amd64 GENERIC kernel now defaults to the nfe(4) driver
113	instead of the nve(4) driver. Please update your configuration
114	accordingly.
115
11620070612:
117	By default, /etc/rc.d/sendmail no longer rebuilds the aliases
118	database if it is missing or older than the aliases file.  If
119	desired, set the new rc.conf option sendmail_rebuild_aliases
120	to "YES" to restore that functionality.
121
12220070612:
123	The IPv4 multicast socket code has been considerably modified, and
124	moved to the file sys/netinet/in_mcast.c. Initial support for the
125	RFC 3678 Source-Specific Multicast Socket API has been added to
126	the IPv4 network stack.
127
128	Strict multicast and broadcast reception is now the default for
129	UDP/IPv4 sockets; the net.inet.udp.strict_mcast_mship sysctl variable
130	has now been removed.
131
132	The RFC 1724 hack for interface selection has been removed; the use
133	of the Linux-derived ip_mreqn structure with IP_MULTICAST_IF has
134	been added to replace it. Consumers such as routed will soon be
135	updated to reflect this.
136
137	These changes affect users who are running routed(8) or rdisc(8)
138	from the FreeBSD base system on point-to-point or unnumbered
139	interfaces.
140
14120070610:
142	The net80211 layer has changed significantly and all wireless
143	drivers that depend on it need to be recompiled.  Further these
144	changes require that any program that interacts with the wireless
145	support in the kernel be recompiled; this includes: ifconfig,
146	wpa_supplicant, hostapd, and wlanstats.  Users must also, for
147	the moment, kldload the wlan_scan_sta and/or wlan_scan_ap modules
148	if they use modules for wireless support.  These modules implement
149	scanning support for station and ap modes, respectively.  Failure
150	to load the appropriate module before marking a wireless interface
151	up will result in a message to the console and the device not
152	operating properly.
153
15420070610:
155	The pam_nologin(8) module ceases to provide an authentication
156	function and starts providing an account management function.
157	Consequent changes to /etc/pam.d should be brought in using
158	mergemaster(8).  Third-party files in /usr/local/etc/pam.d may
159	need manual editing as follows.  Locate this line (or similar):
160
161		auth	required	pam_nologin.so	no_warn
162
163	and change it according to this example:
164
165		account	required	pam_nologin.so	no_warn
166
167	That is, the first word needs to be changed from "auth" to
168	"account".  The new line can be moved to the account section
169	within the file for clarity.  Not updating pam.conf(5) files
170	will result in nologin(5) ignored by the respective services.
171
17220070529:
173	The ether_ioctl() function has been synchronized with ioctl(2)
174	and ifnet.if_ioctl.  Due to that, the size of one of its arguments
175	has changed on 64-bit architectures.  All kernel modules using
176	ether_ioctl() need to be rebuilt on such architectures.
177
17820070516:
179	Improved INCLUDE_CONFIG_FILE support has been introduced to the
180	config(8) utility. In order to take advantage of this new
181	functionality, you are expected to recompile and install
182	src/usr.sbin/config. If you don't rebuild config(8), and your
183	kernel configuration depends on INCLUDE_CONFIG_FILE, the kernel
184	build will be broken because of a missing "kernconfstring"
185	symbol.
186
18720070513:
188	Symbol versioning is enabled by default.  To disable it, use
189	option WITHOUT_SYMVER.  It is not advisable to attempt to
190	disable symbol versioning once it is enabled; your installworld
191	will break because a symbol version-less libc will get installed
192	before the install tools.  As a result, the old install tools,
193	which previously had symbol dependencies to FBSD_1.0, will fail
194	because the freshly installed libc will not have them.
195
196	The default threading library (providing "libpthread") has been
197	changed to libthr.  If you wish to have libkse as your default,
198	use option DEFAULT_THREAD_LIB=libkse for the buildworld.
199
20020070423:
201	The ABI breakage in sendmail(8)'s libmilter has been repaired
202	so it is no longer necessary to recompile mail filters (aka,
203	milters).  If you recompiled mail filters after the 20070408
204	note, it is not necessary to recompile them again.
205
20620070417:
207	The new trunk(4) driver has been renamed to lagg(4) as it better
208	reflects its purpose. ifconfig will need to be recompiled.
209
21020070408:
211	sendmail(8) has been updated to version 8.14.1.  Mail filters
212	(aka, milters) compiled against the libmilter included in the
213	base operating system should be recompiled.
214
21520070302:
216	Firmwares for ipw(4) and iwi(4) are now included in the base tree.
217	In order to use them one must agree to the respective LICENSE in
218	share/doc/legal and define legal.intel_<name>.license_ack=1 via
219	loader.conf(5) or kenv(1).  Make sure to deinstall the now
220	deprecated modules from the respective firmware ports.
221
22220070228:
223	The name resolution/mapping functions addr2ascii(3) and ascii2addr(3)
224	were removed from FreeBSD's libc. These originally came from INRIA
225	IPv6. Nothing in FreeBSD ever used them. They may be regarded as
226	deprecated in previous releases.
227	The AF_LINK support for getnameinfo(3) was merged from NetBSD to
228	replace it as a more portable (and re-entrant) API.
229
23020070224:
231	To support interrupt filtering a modification to the newbus API
232	has occurred, ABI was broken and __FreeBSD_version was bumped
233	to 700031. Please make sure that your kernel and modules are in
234	sync. For more info:
235	http://docs.freebsd.org/cgi/mid.cgi?20070221233124.GA13941
236
23720070224:
238	The IPv6 multicast forwarding code may now be loaded into GENERIC
239	kernels by loading the ip_mroute.ko module. This is built into the
240	module unless WITHOUT_INET6 or WITHOUT_INET6_SUPPORT options are
241	set; see src.conf(5) for more information.
242
24320070214:
244	The output of netstat -r has changed. Without -n, we now only
245	print a "network name" without the prefix length if the network
246	address and mask exactly match a Class A/B/C network, and an entry
247	exists in the nsswitch "networks" map.
248	With -n, we print the full unabbreviated CIDR network prefix in
249	the form "a.b.c.d/p". 0.0.0.0/0 is always printed as "default".
250	This change is in preparation for changes such as equal-cost
251	multipath, and to more generally assist operational deployment
252	of FreeBSD as a modern IPv4 router.
253
25420070210:
255	PIM has been turned on by default in the IPv4 multicast
256	routing code. The kernel option 'PIM' has now been removed.
257	PIM is now built by default if option 'MROUTING' is specified.
258	It may now be loaded into GENERIC kernels by loading the
259	ip_mroute.ko module.
260
26120070207:
262	Support for IPIP tunnels (VIFF_TUNNEL) in IPv4 multicast routing
263	has been removed. Its functionality may be achieved by explicitly
264	configuring gif(4) interfaces and using the 'phyint' keyword in
265	mrouted.conf.
266	XORP does not support source-routed IPv4 multicast tunnels nor the
267	integrated IPIP tunneling, therefore it is not affected by this
268	change. The __FreeBSD_version macro has been bumped to 700030.
269
27020061221:
271	Support for PCI Message Signalled Interrupts has been
272	re-enabled in the bge driver, only for those chips which are
273	believed to support it properly.  If there are any problems,
274	MSI can be disabled completely by setting the
275	'hw.pci.enable_msi' and 'hw.pci.enable_msix' tunables to 0
276	in the loader.
277
27820061214:
279	Support for PCI Message Signalled Interrupts has been
280	disabled again in the bge driver.  Many revisions of the
281	hardware fail to support it properly.  Support can be
282	re-enabled by removing the #define of BGE_DISABLE_MSI in
283	"src/sys/dev/bge/if_bge.c".
284
28520061214:
286	Support for PCI Message Signalled Interrupts has been added
287	to the bge driver.  If there are any problems, MSI can be
288	disabled completely by setting the 'hw.pci.enable_msi' and
289	'hw.pci.enable_msix' tunables to 0 in the loader.
290
29120061205:
292	The removal of several facets of the experimental Threading
293	system from the kernel means that the proc and thread structures
294	have changed quite a bit. I suggest all kernel modules that might
295	reference these structures be recompiled.. Especially the
296	linux module.
297
29820061126:
299	Sound infrastructure has been updated with various fixes and
300	improvements. Most of the changes are pretty much transparent,
301	with exceptions of followings:
302	1) All sound driver specific sysctls (hw.snd.pcm%d.*) have been
303	   moved to their own dev sysctl nodes, for example:
304		hw.snd.pcm0.vchans -> dev.pcm.0.vchans
305	2) /dev/dspr%d.%d has been deprecated. Each channel now has its
306	   own chardev in the form of "dsp%d.<function>%d", where <function>
307	   is p = playback, r = record and v = virtual, respectively. Users
308	   are encouraged to use these devs instead of (old) "/dev/dsp%d.%d".
309	   This does not affect those who are using "/dev/dsp".
310
31120061122:
312	The following binaries have been disconnected from the build:
313	mount_devfs, mount_ext2fs, mount_fdescfs, mount_procfs, mount_linprocfs,
314	and mount_std.  The functionality of these programs has been
315	moved into the mount program.  For example, to mount a devfs
316	filesystem, instead of using mount_devfs, use: "mount -t devfs".
317	This does not affect entries in /etc/fstab, since entries in
318	/etc/fstab are always processed with "mount -t fstype".
319
32020061113:
321	Support for PCI Message Signalled Interrupts on i386 and amd64
322	has been added to the kernel and various drivers will soon be
323	updated to use MSI when it is available.  If there are any problems,
324	MSI can be disabled completely by setting the 'hw.pci.enable_msi'
325	and 'hw.pci.enable_msix' tunables to 0 in the loader.
326
32720061110:
328	The MUTEX_PROFILING option has been renamed to LOCK_PROFILING.
329	The lockmgr object layout has been changed as a result of having
330	a lock_object embedded in it. As a consequence all file system
331	kernel modules must be re-compiled. The mutex profiling man page
332	has not yet been updated to reflect this change.
333
33420061026:
335	KSE in the kernel has now been made optional and turned on by
336	default. Use 'nooption KSE' in your kernel config to turn it
337	off. All kernel modules *must* be recompiled after this change.
338	There-after, modules from a KSE kernel should be compatible with
339	modules from a NOKSE kernel due to the temporary padding fields
340	added to 'struct proc'.
341
34220060929:
343	mrouted and its utilities have been removed from the base system.
344
34520060927:
346	Some ioctl(2) command codes have changed.  Full backward ABI
347	compatibility is provided if the "options COMPAT_FREEBSD6" is
348	present in the kernel configuration file.  Make sure to add
349	this option to your kernel config file, or recompile X.Org
350	and the rest of ports; otherwise they may refuse to work.
351
35220060924:
353	tcpslice has been removed from the base system.
354
35520060913:
356	The sizes of struct tcpcb (and struct xtcpcb) have changed due to
357	the rewrite of TCP syncookies.  Tools like netstat, sockstat, and
358	systat needs to be rebuilt.
359
36020060903:
361	libpcap updated to v0.9.4 and tcpdump to v3.9.4
362
36320060816:
364	The IPFIREWALL_FORWARD_EXTENDED option is gone and the behaviour
365	for IPFIREWALL_FORWARD is now as it was before when it was first
366	committed and for years after. The behaviour is now ON.
367
36820060725:
369	enigma(1)/crypt(1) utility has been changed on 64 bit architectures.
370	Now it can decrypt files created from different architectures.
371	Unfortunately, it is no longer able to decrypt a cipher text
372	generated with an older version on 64 bit architectures.
373	If you have such a file, you need old utility to decrypt it.
374
37520060709:
376 	The interface version of the i4b kernel part has changed. So
377 	after updating the kernel sources and compiling a new kernel,
378 	the i4b user space tools in "/usr/src/usr.sbin/i4b" must also
379 	be rebuilt, and vice versa.
380
38120060627:
382	The XBOX kernel now defaults to the nfe(4) driver instead of
383	the nve(4) driver. Please update your configuration
384	accordingly.
385
38620060514:
387	The i386-only lnc(4) driver for the AMD Am7900 LANCE and Am79C9xx
388	PCnet family of NICs has been removed. The new le(4) driver serves
389	as an equivalent but cross-platform replacement with the pcn(4)
390	driver still providing performance-optimized support for the subset
391	of AMD Am79C971 PCnet-FAST and greater chips as before.
392
39320060511:
394	The machdep.* sysctls and the adjkerntz utility have been
395	modified a bit.  The new adjkerntz utility uses the new
396	sysctl names and sysctlbyname() calls, so it may be impossible
397	to run an old /sbin/adjkerntz utility in single-user mode
398	with a new kernel.  Replace the `adjkerntz -i' step before
399	`make installworld' with:
400
401	    /usr/obj/usr/src/sbin/adjkerntz/adjkerntz -i
402
403	and proceed as usual with the rest of the installworld-stage
404	steps.  Otherwise, you risk installing binaries with their
405	timestamp set several hours in the future, especially if
406	you are running with local time set to GMT+X hours.
407
40820060412:
409	The ip6fw utility has been removed.  The behavior provided by
410	ip6fw has been in ipfw2 for a good while and the rc.d scripts
411	have been updated to deal with it.  There are some rules that
412	might not migrate cleanly.  Use rc.firewall6 as a template to
413	rewrite rules.
414
41520060428:
416	The puc(4) driver has been overhauled. The ebus(4) and sbus(4)
417	attachments have been removed. Make sure to configure scc(4)
418	on sparc64. Note also that by default puc(4) will use uart(4)
419	and not sio(4) for serial ports because interrupt handling has
420	been optimized for multi-port serial cards and only uart(4)
421	implements the interface to support it.
422
42320060330:
424	The scc(4) driver replaces puc(4) for Serial Communications
425	Controllers (SCCs) like the Siemens SAB82532 and the Zilog
426	Z8530. On sparc64, it is advised to add scc(4) to the kernel
427	configuration to make sure that the serial ports remain
428	functional.
429
43020060317:
431	Most world/kernel related NO_* build options changed names.
432	New knobs have common prefixes WITHOUT_*/WITH_* (modelled
433	after FreeBSD ports) and should be set in /etc/src.conf
434	(the src.conf(5) manpage is provided).  Full backwards
435	compatibility is maintained for the time being though it's
436	highly recommended to start moving old options out of the
437	system-wide /etc/make.conf file into the new /etc/src.conf
438	while also properly renaming them.  More conversions will
439	likely follow.  Posting to current@:
440
441	http://lists.freebsd.org/pipermail/freebsd-current/2006-March/061725.html
442
44320060305:
444	The NETSMBCRYPTO kernel option has been retired because its
445	functionality is always included in NETSMB and smbfs.ko now.
446
44720060303:
448	The TDFX_LINUX kernel option was retired and replaced by the
449	tdfx_linux device.  The latter can be loaded as the 3dfx_linux.ko
450	kernel module.  Loading it alone should suffice to get 3dfx support
451	for Linux apps because it will pull in 3dfx.ko and linux.ko through
452	its dependencies.
453
45420060204:
455	The 'audit' group was added to support the new auditing functionality
456	in the base system.  Be sure to follow the directions for updating,
457	including the requirement to run mergemaster -p.
458
45920060201:
460	The kernel ABI to file system modules was changed on i386.
461	Please make sure that your kernel and modules are in sync.
462
46320060118:
464	This actually occured some time ago, but installing the kernel
465	now also installs a bunch of symbol files for the kernel modules.
466	This increases the size of /boot/kernel to about 67Mbytes. You
467	will need twice this if you will eventually back this up to kernel.old
468	on your next install.
469	If you have a shortage of room in your root partition, you should add
470	-DINSTALL_NODEBUG to your make arguments or add INSTALL_NODEBUG="yes"
471	to your /etc/make.conf.
472
47320060113:
474	libc's malloc implementation has been replaced.  This change has the
475	potential to uncover application bugs that previously went unnoticed.
476	See the malloc(3) manual page for more details.
477
47820060112:
479	The generic netgraph(4) cookie has been changed. If you upgrade
480	kernel passing this point, you also need to upgrade userland
481	and netgraph(4) utilities like ports/net/mpd or ports/net/mpd4.
482
48320060106:
484	si(4)'s device files now contain the unit number.
485	Uses of {cua,tty}A[0-9a-f] should be replaced by {cua,tty}A0[0-9a-f].
486
48720060106:
488	The kernel ABI was mostly destroyed due to a change in the size
489	of struct lock_object which is nested in other structures such
490	as mutexes which are nested in all sorts of other structures.
491	Make sure your kernel and modules are in sync.
492
49320051231:
494	The page coloring algorithm in the VM subsystem was converted
495	from tuning with kernel options to autotuning. Please remove
496	any PQ_* option except PQ_NOOPT from your kernel config.
497
49820051211:
499	The net80211-related tools in the tools/tools/ath directory
500	have been moved to tools/tools/net80211 and renamed with a
501	"wlan" prefix.  Scripts that use them should be adjusted
502	accordingly.
503
50420051202:
505	Scripts in the local_startup directories (as defined in
506	/etc/defaults/rc.conf) that have the new rc.d semantics will
507	now be run as part of the base system rcorder. If there are
508	errors or problems with one of these local scripts, it could
509	cause boot problems. If you encounter such problems, boot in
510	single user mode, remove that script from the */rc.d directory.
511	Please report the problem to the port's maintainer, and the
512	freebsd-ports@freebsd.org mailing list.
513
51420051129:
515	The nodev mount option was deprecated in RELENG_6 (where it
516	was a no-op), and is now unsupported.  If you have nodev or dev listed
517	in /etc/fstab, remove it, otherwise it will result in a mount error.
518
51920051129:
520	ABI between ipfw(4) and ipfw(8) has been changed. You need
521	to rebuild ipfw(8) when rebuilding kernel.
522
52320051108:
524	rp(4)'s device files now contain the unit number.
525	Uses of {cua,tty}R[0-9a-f] should be replaced by {cua,tty}R0[0-9a-f].
526
52720051029:
528	/etc/rc.d/ppp-user has been renamed to /etc/rc.d/ppp.
529	Its /etc/rc.conf.d configuration file has been `ppp' from
530	the beginning, and hence there is no need to touch it.
531
53220051014:
533	Now most modules get their build-time options from the kernel
534	configuration file.  A few modules still have fixed options
535	due to their non-conformant implementation, but they will be
536	corrected eventually.  You may need to review the options of
537	the modules in use, explicitly specify the non-default options
538	in the kernel configuration file, and rebuild the kernel and
539	modules afterwards.
540
54120051001:
542	kern.polling.enable sysctl MIB is now deprecated. Use ifconfig(8)
543	to turn polling(4) on your interfaces.
544
54520050927:
546	The old bridge(4) implementation was retired.  The new
547	if_bridge(4) serves as a full functional replacement.
548
54920050722:
550	The ai_addrlen of a struct addrinfo was changed to a socklen_t
551	to conform to POSIX-2001.  This change broke an ABI
552	compatibility on 64 bit architecture.  You have to recompile
553	userland programs that use getaddrinfo(3) on 64 bit
554	architecture.
555
55620050711:
557	RELENG_6 branched here.
558
55920050629:
560	The pccard_ifconfig rc.conf variable has been removed and a new
561	variable, ifconfig_DEFAULT has been introduced.  Unlike
562	pccard_ifconfig, ifconfig_DEFAULT applies to ALL interfaces that
563	do not have ifconfig_ifn entries rather than just those in
564	removable_interfaces.
565
56620050616:
567	Some previous versions of PAM have permitted the use of
568	non-absolute paths in /etc/pam.conf or /etc/pam.d/* when referring
569	to third party PAM modules in /usr/local/lib.  A change has been
570	made to require the use of absolute paths in order to avoid
571	ambiguity and dependence on library path configuration, which may
572	affect existing configurations.
573
57420050610:
575	Major changes to network interface API.  All drivers must be
576	recompiled.  Drivers not in the base system will need to be
577	updated to the new APIs.
578
57920050609:
580	Changes were made to kinfo_proc in sys/user.h.  Please recompile
581	userland, or commands like `fstat', `pkill', `ps', `top' and `w'
582	will not behave correctly.
583
584	The API and ABI for hwpmc(4) have changed with the addition
585	of sampling support.  Please recompile lib/libpmc(3) and
586	usr.sbin/{pmcstat,pmccontrol}.
587
58820050606:
589	The OpenBSD dhclient was imported in place of the ISC dhclient
590	and the network interface configuration scripts were updated
591	accordingly.  If you use DHCP to configure your interfaces, you
592	must now run devd.  Also, DNS updating was lost so you will need
593	to find a workaround if you use this feature.
594
595	The '_dhcp' user was added to support the OpenBSD dhclient.  Be
596	sure to run mergemaster -p (like you are supposed to do every time
597	anyway).
598
59920050605:
600	if_bridge was added to the tree. This has changed struct ifnet.
601	Please recompile userland and all network related modules.
602
60320050603:
604	The n_net of a struct netent was changed to an uint32_t, and
605	1st argument of getnetbyaddr() was changed to an uint32_t, to
606	conform to POSIX-2001.  These changes broke an ABI
607	compatibility on 64 bit architecture.  With these changes,
608	shlib major of libpcap was bumped.  You have to recompile
609	userland programs that use getnetbyaddr(3), getnetbyname(3),
610	getnetent(3) and/or libpcap on 64 bit architecture.
611
61220050528:
613	Kernel parsing of extra options on '#!' first lines of shell
614	scripts has changed.  Lines with multiple options likely will
615	fail after this date.  For full details, please see
616		http://people.freebsd.org/~gad/Updating-20050528.txt
617
61820050503:
619	The packet filter (pf) code has been updated to OpenBSD 3.7
620	Please note the changed anchor syntax and the fact that
621	authpf(8) now needs a mounted fdescfs(5) to function.
622
62320050415:
624	The NO_MIXED_MODE kernel option has been removed from the i386
625	amd64 platforms as its use has been superceded by the new local
626	APIC timer code.  Any kernel config files containing this option
627	should be updated.
628
62920050227:
630	The on-disk format of LC_CTYPE files was changed to be machine
631	independent.  Please make sure NOT to use NO_CLEAN buildworld
632	when crossing this point. Crossing this point also requires
633	recompile or reinstall of all locale depended packages.
634
63520050225:
636	The ifi_epoch member of struct if_data has been changed to
637	contain the uptime at which the interface was created or the
638	statistics zeroed rather then the wall clock time because
639	wallclock time may go backwards.  This should have no impact
640	unless an snmp implementation is using this value (I know of
641	none at this point.)
642
64320050224:
644	The acpi_perf and acpi_throttle drivers are now part of the
645	acpi(4) main module.  They are no longer built separately.
646
64720050223:
648	The layout of struct image_params has changed. You have to
649	recompile all compatibility modules (linux, svr4, etc) for use
650	with the new kernel.
651
65220050223:
653	The p4tcc driver has been merged into cpufreq(4).  This makes
654	"options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
655	compile in "device cpufreq" to restore this functionality.
656
65720050220:
658	The responsibility of recomputing the file system summary of
659	a SoftUpdates-enabled dirty volume has been transferred to the
660	background fsck.  A rebuild of fsck(8) utility is recommended
661	if you have updated the kernel.
662
663	To get the old behavior (recompute file system summary at mount
664	time), you can set vfs.ffs.compute_summary_at_mount=1 before
665	mounting the new volume.
666
66720050206:
668	The cpufreq import is complete.  As part of this, the sysctls for
669	acpi(4) throttling have been removed.  The power_profile script
670	has been updated, so you can use performance/economy_cpu_freq in
671	rc.conf(5) to set AC on/offline cpu frequencies.
672
67320050206:
674	NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
675	requires recompiling libnetgraph and userland netgraph utilities.
676
67720050114:
678	Support for abbreviated forms of a number of ipfw options is
679	now deprecated.  Warnings are printed to stderr indicating the
680	correct full form when a match occurs.  Some abbreviations may
681	be supported at a later date based on user feedback.  To be
682	considered for support, abbreviations must be in use prior to
683	this commit and unlikely to be confused with current key words.
684
68520041221:
686	By a popular demand, a lot of NOFOO options were renamed
687	to NO_FOO (see bsd.compat.mk for a full list).  The old
688	spellings are still supported, but will cause annoying
689	warnings on stderr.  Make sure you upgrade properly (see
690	the COMMON ITEMS: section later in this file).
691
69220041219:
693	Auto-loading of ancillary wlan modules such as wlan_wep has
694	been temporarily disabled; you need to statically configure
695	the modules you need into your kernel or explicitly load them
696	prior to use.  Specifically, if you intend to use WEP encryption
697	with an 802.11 device load/configure wlan_wep; if you want to
698	use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
699	and wlan_xauth as required.
700
70120041213:
702	The behaviour of ppp(8) has changed slightly.  If lqr is enabled
703	(``enable lqr''), older versions would revert to LCP ECHO mode on
704	negotiation failure.  Now, ``enable echo'' is required for this
705	behaviour.  The ppp version number has been bumped to 3.4.2 to
706	reflect the change.
707
70820041201:
709	The wlan support has been updated to split the crypto support
710	into separate modules.  For static WEP you must configure the
711	wlan_wep module in your system or build and install the module
712	in place where it can be loaded (the kernel will auto-load
713	the module when a wep key is configured).
714
71520041201:
716	The ath driver has been updated to split the tx rate control
717	algorithm into a separate module.  You need to include either
718	ath_rate_onoe or ath_rate_amrr when configuring the kernel.
719
72020041116:
721	Support for systems with an 80386 CPU has been removed.  Please
722	use FreeBSD 5.x or earlier on systems with an 80386.
723
72420041110:
725	We have had a hack which would mount the root filesystem
726	R/W if the device were named 'md*'.  As part of the vnode
727	work I'm doing I have had to remove this hack.  People
728	building systems which use preloaded MD root filesystems
729	may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
730	their /etc/rc scripts.
731
73220041104:
733	FreeBSD 5.3 shipped here.
734
73520041102:
736	The size of struct tcpcb has changed again due to the removal
737	of RFC1644 T/TCP.  You have to recompile userland programs that
738	read kmem for tcp sockets directly (netstat, sockstat, etc.)
739
74020041022:
741	The size of struct tcpcb has changed.  You have to recompile
742	userland programs that read kmem for tcp sockets directly
743	(netstat, sockstat, etc.)
744
74520041016:
746	RELENG_5 branched here.  For older entries, please see updating
747	in the RELENG_5 branch.
748
749COMMON ITEMS:
750
751	General Notes
752	-------------
753	Avoid using make -j when upgrading.  From time to time in the
754	past there have been problems using -j with buildworld and/or
755	installworld.  This is especially true when upgrading between
756	"distant" versions (eg one that cross a major release boundary
757	or several minor releases, or when several months have passed
758	on the -current branch).
759
760	Sometimes, obscure build problems are the result of environment
761	poisoning.  This can happen because the make utility reads its
762	environment when searching for values for global variables.
763	To run your build attempts in an "environmental clean room",
764	prefix all make commands with 'env -i '.  See the env(1) manual
765	page for more details.
766
767	When upgrading from one major version to another it is generally
768	best to upgrade to the latest code in the currently installed branch
769	first, then do an upgrade to the new branch. This is the best-tested
770	upgrade path, and has the highest probability of being successful.
771	Please try this approach before reporting problems with a major
772	version upgrade.
773
774	To build a kernel
775	-----------------
776	If you are updating from a prior version of FreeBSD (even one just
777	a few days old), you should follow this procedure.  It is the most
778	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
779
780	make kernel-toolchain
781	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
782	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
783
784	To test a kernel once
785	---------------------
786	If you just want to boot a kernel once (because you are not sure
787	if it works, or if you want to boot a known bad kernel to provide
788	debugging information) run
789	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
790	nextboot -k testkernel
791
792	To just build a kernel when you know that it won't mess you up
793	--------------------------------------------------------------
794	This assumes you are already running a 5.X system.  Replace
795	${arch} with the architecture of your machine (e.g. "i386",
796	"alpha", "amd64", "ia64", "pc98", "sparc64", etc).
797
798	cd src/sys/${arch}/conf
799	config KERNEL_NAME_HERE
800	cd ../compile/KERNEL_NAME_HERE
801	make depend
802	make
803	make install
804
805	If this fails, go to the "To build a kernel" section.
806
807	To rebuild everything and install it on the current system.
808	-----------------------------------------------------------
809	# Note: sometimes if you are running current you gotta do more than
810	# is listed here if you are upgrading from a really old current.
811
812	<make sure you have good level 0 dumps>
813	make buildworld
814	make kernel KERNCONF=YOUR_KERNEL_HERE
815							[1]
816	<reboot in single user>				[3]
817	mergemaster -p					[5]
818	make installworld
819	make delete-old
820	mergemaster					[4]
821	<reboot>
822
823
824	To cross-install current onto a separate partition
825	--------------------------------------------------
826	# In this approach we use a separate partition to hold
827	# current's root, 'usr', and 'var' directories.   A partition
828	# holding "/", "/usr" and "/var" should be about 2GB in
829	# size.
830
831	<make sure you have good level 0 dumps>
832	<boot into -stable>
833	make buildworld
834	make buildkernel KERNCONF=YOUR_KERNEL_HERE
835	<maybe newfs current's root partition>
836	<mount current's root partition on directory ${CURRENT_ROOT}>
837	make installworld DESTDIR=${CURRENT_ROOT}
838	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
839	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
840	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
841	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
842	<reboot into current>
843	<do a "native" rebuild/install as described in the previous section>
844	<maybe install compatibility libraries from src/lib/compat>
845 	<reboot>
846
847
848	To upgrade in-place from 5.x-stable to current
849	----------------------------------------------
850	<make sure you have good level 0 dumps>
851	make buildworld					[9]
852	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
853							[1]
854	<reboot in single user>				[3]
855	mergemaster -p					[5]
856	make installworld
857	make delete-old
858	mergemaster -i					[4]
859	<reboot>
860
861	Make sure that you've read the UPDATING file to understand the
862	tweaks to various things you need.  At this point in the life
863	cycle of current, things change often and you are on your own
864	to cope.  The defaults can also change, so please read ALL of
865	the UPDATING entries.
866
867	Also, if you are tracking -current, you must be subscribed to
868	freebsd-current@freebsd.org.  Make sure that before you update
869	your sources that you have read and understood all the recent
870	messages there.  If in doubt, please track -stable which has
871	much fewer pitfalls.
872
873	[1] If you have third party modules, such as vmware, you
874	should disable them at this point so they don't crash your
875	system on reboot.
876
877	[3] From the bootblocks, boot -s, and then do
878		fsck -p
879		mount -u /
880		mount -a
881		cd src
882		adjkerntz -i		# if CMOS is wall time
883	Also, when doing a major release upgrade, it is required that
884	you boot into single user mode to do the installworld.
885
886	[4] Note: This step is non-optional.  Failure to do this step
887	can result in a significant reduction in the functionality of the
888	system.  Attempting to do it by hand is not recommended and those
889	that pursue this avenue should read this file carefully, as well
890	as the archives of freebsd-current and freebsd-hackers mailing lists
891	for potential gotchas.
892
893	[5] Usually this step is a noop.  However, from time to time
894	you may need to do this if you get unknown user in the following
895	step.  It never hurts to do it all the time.  You may need to
896	install a new mergemaster (cd src/usr.sbin/mergemaster && make
897	install) after the buildworld before this step if you last updated
898	from current before 20020224 or from -stable before 20020408.
899
900	[8] In order to have a kernel that can run the 4.x binaries
901	needed to do an installworld, you must include the COMPAT_FREEBSD4
902	option in your kernel.  Failure to do so may leave you with a system
903	that is hard to boot to recover. A similar kernel option COMPAT_FREEBSD5
904	is required to run the 5.x binaries on more recent kernels.
905
906	Make sure that you merge any new devices from GENERIC since the
907	last time you updated your kernel config file.
908
909	[9] When checking out sources, you must include the -P flag to have
910	cvs prune empty directories.
911
912	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
913	"?=" instead of the "=" assignment operator, so that buildworld can
914	override the CPUTYPE if it needs to.
915
916	MAKEOBJDIRPREFIX must be defined in an environment variable, and
917	not on the command line, or in /etc/make.conf.  buildworld will
918	warn if it is improperly defined.
919FORMAT:
920
921This file contains a list, in reverse chronological order, of major
922breakages in tracking -current.  Not all things will be listed here,
923and it only starts on October 16, 2004.  Updating files can found in
924previous releases if your system is older than this.
925
926Copyright information:
927
928Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
929
930Redistribution, publication, translation and use, with or without
931modification, in full or in part, in any form or format of this
932document are permitted without further permission from the author.
933
934THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
935IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
936WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
937DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
938INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
939(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
940SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
941HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
942STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
943IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
944POSSIBILITY OF SUCH DAMAGE.
945
946If you find this document useful, and you want to, you may buy the
947author a beer.
948
949Contact Warner Losh if you have any questions about your use of
950this document.
951
952$FreeBSD$
953