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