UPDATING revision 220770
1Updating Information for FreeBSD current users
2
3This file is maintained and copyrighted by M. Warner Losh <imp@freebsd.org>.
4See end of file for further details.  For commonly done items, please see the
5COMMON ITEMS: section later in the file.  These instructions assume that you
6basically know what you are doing.  If not, then please consult the FreeBSD
7handbook.
8
9Items affecting the ports and packages system can be found in
10/usr/ports/UPDATING.  Please read that file before running portupgrade.
11
12NOTE TO PEOPLE WHO THINK THAT FreeBSD 9.x IS SLOW:
13	FreeBSD 9.x has many debugging features turned on, in both the kernel
14	and userland.  These features attempt to detect incorrect use of
15	system primitives, and encourage loud failure through extra sanity
16	checking and fail stop semantics.  They also substantially impact
17	system performance.  If you want to do performance measurement,
18	benchmarking, and optimization, you'll want to turn them off.  This
19	includes various WITNESS- related kernel options, INVARIANTS, malloc
20	debugging flags in userland, and various verbose features in the
21	kernel.  Many developers choose to disable these features on build
22	machines to maximize performance.  (To disable malloc debugging, run
23	ln -s aj /etc/malloc.conf.)
24
2520110418:
26	The GNU Objective-C runtime library (libobjc), and other Objective-C
27	related components have been removed from the base system.  If you
28	require an Objective-C library, please use one of the available ports.
29
3020110331:
31	ath(4) has been split into bus- and device- modules. if_ath contains
32	the HAL, the TX rate control and the network device code. if_ath_pci
33	contains the PCI bus glue. For Atheros MIPS embedded systems, if_ath_ahb
34	contains the AHB glue. Users need to load both if_ath_pci and if_ath
35	in order to use ath on everything else.
36
37	TO REPEAT: if_ath_ahb is not needed for normal users. Normal users only
38	need to load if_ath and if_ath_pci for ath(4) operation.
39
4020110314:
41	As part of the replacement of sysinstall, the process of building
42	release media has changed significantly. For details, please re-read
43	release(7), which has been updated to reflect the new build process.
44
4520110218:
46	GNU binutils 2.17.50 (as of 2007-07-03) has been merged to -HEAD.  This
47	is the last available version under GPLv2.  It brings a number of new
48	features, such as support for newer x86 CPU's (with SSE-3, SSSE-3, SSE
49	4.1 and SSE 4.2), better support for powerpc64, a number of new
50	directives, and lots of other small improvements.  See the ChangeLog
51	file in contrib/binutils for the full details.
52
5320110218:
54	IPsec's HMAC_SHA256-512 support has been fixed to be RFC4868
55	compliant, and will now use half of hash for authentication.
56	This will break interoperability with all stacks (including all
57	actual FreeBSD versions) who implement
58	draft-ietf-ipsec-ciph-sha-256-00 (they use 96 bits of hash for
59	authentication).
60	The only workaround with such peers is to use another HMAC
61	algorithm for IPsec ("phase 2") authentication.
62
6320110207:
64	Remove the uio_yield prototype and symbol.  This function has
65	been misnamed since it was introduced and should not be
66	globally exposed with this name.  The equivalent functionality
67	is now available using kern_yield(curthread->td_user_pri).
68	The function remains undocumented.
69
7020110112:
71	A SYSCTL_[ADD_]UQUAD was added for unsigned uint64_t pointers,
72	symmetric with the existing SYSCTL_[ADD_]QUAD.  Type checking
73	for scalar sysctls is defined but disabled.  Code that needs
74	UQUAD to pass the type checking that must compile on older
75	systems where the define is not present can check against
76	__FreeBSD_version >= 900030.
77
78	The system dialog(1) has been replaced with a new version previously
79	in ports as devel/cdialog. dialog(1) is mostly command-line compatible
80	with the previous version, but the libdialog associated with it has
81	a largely incompatible API. As such, the original version of libdialog
82	will be kept temporarily as libodialog, until its base system consumers
83	are replaced or updated. Bump __FreeBSD_version to 900030.
84
8520110103:
86	If you are trying to run make universe on a -stable system, and you get
87	the following warning:
88	"Makefile", line 356: "Target architecture for i386/conf/GENERIC 
89	unknown.  config(8) likely too old."
90	or something similar to it, then you must upgrade your -stable system
91	to 8.2-Release or newer (really, any time after r210146 7/15/2010 in
92	stable/8) or build the config from the latest stable/8 branch and
93	install it on your system.
94
95	Prior to this date, building a current universe on 8-stable system from
96	between 7/15/2010 and 1/2/2011 would result in a weird shell parsing
97	error in the first kernel build phase.  A new config on those old 
98	systems will fix that problem for older versions of -current.
99
10020101228:
101	The TCP stack has been modified to allow Khelp modules to interact with
102	it via helper hook points and store per-connection data in the TCP
103	control block. Bump __FreeBSD_version to 900029. User space tools that
104	rely on the size of struct tcpcb in tcp_var.h (e.g. sockstat) need to
105	be recompiled.
106
10720101114:
108	Generic IEEE 802.3 annex 31B full duplex flow control support has been
109	added to mii(4) and bge(4), bce(4), msk(4), nfe(4) and stge(4) along
110	with brgphy(4), e1000phy(4) as well as ip1000phy() have been converted
111	to take advantage of it instead of using custom implementations.  This
112	means that these drivers now no longer unconditionally advertise
113	support for flow control but only do so if flow control is a selected
114	media option.  This was implemented in the generic support that way in
115	order to allow flow control to be switched on and off via ifconfig(8)
116	with the PHY specific default to typically off in order to protect
117	from unwanted effects.  Consequently, if you used flow control with
118	one of the above mentioned drivers you now need to explicitly enable
119	it, for example via:
120		ifconfig bge0 media auto mediaopt flowcontrol
121
122	Along with the above mentioned changes generic support for setting
123	1000baseT master mode also has been added and brgphy(4), ciphy(4),
124	e1000phy(4) as well as ip1000phy(4) have been converted to take
125	advantage of it.  This means that these drivers now no longer take the
126	link0 parameter for selecting master mode but the master media option
127	has to be used instead, for example like in the following:
128		ifconfig bge0 media 1000baseT mediaopt full-duplex,master
129
130	Selection of master mode now is also available with all other PHY
131	drivers supporting 1000baseT.
132
13320101111:
134	The TCP stack has received a significant update to add support for
135	modularised congestion control and generally improve the clarity of
136	congestion control decisions. Bump __FreeBSD_version to 900025. User
137	space tools that rely on the size of struct tcpcb in tcp_var.h (e.g.
138	sockstat) need to be recompiled.
139
14020101002:
141	The man(1) utility has been replaced by a new version that no longer
142	uses /etc/manpath.config. Please consult man.conf(5) for how to
143	migrate local entries to the new format.
144
14520100928:
146	The copyright strings printed by login(1) and sshd(8) at the time of a
147	new connection have been removed to follow other operating systems and
148	upstream sshd.
149
15020100915:
151	A workaround for a fixed ld bug has been removed in kernel code,
152	so make sure that your system ld is built from sources after
153	revision 210245 from 2010-07-19 (r211583 if building head kernel
154	on stable/8, r211584 for stable/7; both from 2010-08-21).
155	A symptom of incorrect ld version is different addresses for
156	set_pcpu section and __start_set_pcpu symbol in kernel and/or modules.
157
15820100913:
159	The $ipv6_prefer variable in rc.conf(5) has been split into
160	$ip6addrctl_policy and $ipv6_activate_all_interfaces.
161
162	The $ip6addrctl_policy is a variable to choose a pre-defined
163	address selection policy set by ip6addrctl(8).  A value
164	"ipv4_prefer", "ipv6_prefer" or "AUTO" can be specified.  The
165	default is "AUTO".
166
167	The $ipv6_activate_all_interfaces specifies whether IFDISABLED
168	flag (see an entry of 20090926) is set on an interface with no
169	corresponding $ifconfig_IF_ipv6 line.  The default is "NO" for
170	security reason.  If you want IPv6 link-local address on all
171	interfaces by default, set this to "YES".
172
173	The old ipv6_prefer="YES" is equivalent to
174	ipv6_activate_all_interfaces="YES" and
175	ip6addrctl_policy="ipv6_prefer".
176
17720100913:
178	DTrace has grown support for userland tracing. Due to this, DTrace is
179	now i386 and amd64 only.
180	dtruss(1) is now installed by default on those systems and a new
181	kernel module is needed for userland tracing: fasttrap.
182	No changes to your kernel config file are necessary to enable
183	userland tracing, but you might consider adding 'STRIP=' and
184	'CFLAGS+=-fno-omit-frame-pointer' to your make.conf if you want
185	to have informative userland stack traces in DTrace (ustack).
186
18720100725:
188	The acpi_aiboost(4) driver has been removed in favor of the new
189	aibs(4) driver. You should update your kernel configuration file.
190
19120100722:
192	BSD grep has been imported to the base system and it is built by
193	default.  It is completely BSD licensed, highly GNU-compatible, uses
194	less memory than its GNU counterpart and has a small codebase.
195	However, it is slower than its GNU counterpart, which is mostly
196	noticeable for larger searches, for smaller ones it is measurable
197	but not significant.  The reason is complex, the most important factor
198	is that we lack a modern and efficient regex library and GNU
199	overcomes this by optimizing the searches internally.  Future work
200	on improving the regex performance is planned, for the meantime,
201	users that need better performance, can build GNU grep instead by
202	setting the WITH_GNU_GREP knob.
203
20420100713:
205	Due to the import of powerpc64 support, all existing powerpc kernel
206	configuration files must be updated with a machine directive like this:
207	    machine powerpc powerpc
208
209	In addition, an updated config(8) is required to build powerpc kernels
210	after this change.
211
21220100713:
213	A new version of ZFS (version 15) has been merged to -HEAD.
214	This version uses a python library for the following subcommands:
215	zfs allow, zfs unallow, zfs groupspace, zfs userspace.
216	For full functionality of these commands the following port must
217	be installed: sysutils/py-zfs
218
21920100429:
220	'vm_page's are now hashed by physical address to an array of mutexes.
221	Currently this is only used to serialize access to hold_count. Over 
222	time the page queue mutex will be peeled away. This changes the size
223	of pmap on every architecture. And requires all callers of vm_page_hold
224	and vm_page_unhold to be updated. 
225 
22620100402:
227	WITH_CTF can now be specified in src.conf (not recommended, there
228	are some problems with static executables), make.conf (would also
229	affect ports which do not use GNU make and do not override the
230	compile targets) or in the kernel config (via "makeoptions
231	WITH_CTF=yes").
232	When WITH_CTF was specified there before this was silently ignored,
233	so make sure that WITH_CTF is not used in places which could lead
234	to unwanted behavior.
235
23620100311:
237	The kernel option COMPAT_IA32 has been replaced with COMPAT_FREEBSD32
238	to allow 32-bit compatibility on non-x86 platforms. All kernel
239	configurations on amd64 and ia64 platforms using these options must
240	be modified accordingly.
241
24220100113:
243	The utmp user accounting database has been replaced with utmpx,
244	the user accounting interface standardized by POSIX.
245	Unfortunately the semantics of utmp and utmpx don't match,
246	making it practically impossible to support both interfaces.
247	The user accounting database is used by tools like finger(1),
248	last(1), talk(1), w(1) and ac(8).
249
250	All applications in the base system use utmpx.  This means only
251	local binaries (e.g. from the ports tree) may still use these
252	utmp database files.  These applications must be rebuilt to make
253	use of utmpx.
254
255	After the system has been upgraded, it is safe to remove the old
256	log files (/var/run/utmp, /var/log/lastlog and /var/log/wtmp*),
257	assuming their contents is of no importance anymore.  Old wtmp
258	databases can only be used by last(1) and ac(8) after they have
259	been converted to the new format using wtmpcvt(1).
260
26120100108:
262	Introduce the kernel thread "deadlock resolver" (which can be enabled
263	via the DEADLKRES option, see NOTES for more details) and the
264	sleepq_type() function for sleepqueues.
265
26620091202:
267	The rc.firewall and rc.firewall6 were unified, and
268	rc.firewall6 and rc.d/ip6fw were removed.
269	According to the removal of rc.d/ip6fw, ipv6_firewall_* rc
270	variables are obsoleted.  Instead, the following new rc
271	variables are added to rc.d/ipfw:
272
273		firewall_client_net_ipv6, firewall_simple_iif_ipv6,
274		firewall_simple_inet_ipv6, firewall_simple_oif_ipv6,
275		firewall_simple_onet_ipv6, firewall_trusted_ipv6
276
277	The meanings correspond to the relevant IPv4 variables.
278
27920091125:
280	8.0-RELEASE.
281
28220091113:
283	The default terminal emulation for syscons(4) has been changed
284	from cons25 to xterm on all platforms except pc98.  This means
285	that the /etc/ttys file needs to be updated to ensure correct
286	operation of applications on the console.
287
288	The terminal emulation style can be toggled per window by using
289	vidcontrol(1)'s -T flag.  The TEKEN_CONS25 kernel configuration
290	options can be used to change the compile-time default back to
291	cons25.
292
293	To prevent graphical artifacts, make sure the TERM environment
294	variable is set to match the terminal emulation that is being
295	performed by syscons(4).
296
29720091109:
298	The layout of the structure ieee80211req_scan_result has changed.
299	Applications that require wireless scan results (e.g. ifconfig(8))
300	from net80211 need to be recompiled.
301
302	Applications such as wpa_supplicant(8) may require a full world
303	build without using NO_CLEAN in order to get synchronized with the
304	new structure.
305
30620091025:
307	The iwn(4) driver has been updated to support the 5000 and 5150 series.
308	There's one kernel module for each firmware. Adding "device iwnfw"
309	to the kernel configuration file means including all three firmware
310	images inside the kernel. If you want to include just the one for
311	your wireless card, use the the devices iwn4965fw, iwn5000fw or
312	iwn5150fw.
313
31420090926:
315	The rc.d/network_ipv6, IPv6 configuration script has been integrated
316	into rc.d/netif.  The changes are the following:
317
318	1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF
319	   for IPv4.  For aliases, $ifconfig_IF_aliasN should be used.
320	   Note that both variables need the "inet6" keyword at the head.
321
322	   Do not set $ipv6_network_interfaces manually if you do not
323	   understand what you are doing.  It is not needed in most cases. 
324
325	   $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but
326	   they are obsolete.
327
328	2. $ipv6_enable is obsolete.  Use $ipv6_prefer and
329	   "inet6 accept_rtadv" keyword in ifconfig(8) instead.
330
331	   If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and
332	   all configured interfaces have "inet6 accept_rtadv" in the
333	   $ifconfig_IF_ipv6.  These are for backward compatibility.
334
335	3. A new variable $ipv6_prefer has been added.  If NO, IPv6
336	   functionality of interfaces with no corresponding
337	   $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag,
338	   and the default address selection policy of ip6addrctl(8) 
339	   is the IPv4-preferred one (see rc.d/ip6addrctl for more details).
340	   Note that if you want to configure IPv6 functionality on the
341	   disabled interfaces after boot, first you need to clear the flag by
342	   using ifconfig(8) like:
343
344		ifconfig em0 inet6 -ifdisabled
345
346	   If YES, the default address selection policy is set as
347	   IPv6-preferred.
348
349	   The default value of $ipv6_prefer is NO.
350
351	4. If your system need to receive Router Advertisement messages,
352	   define "inet6 accept_rtadv" in $ifconfig_IF_ipv6.  The rc(8)
353	   scripts automatically invoke rtsol(8) when the interface becomes
354	   UP.  The Router Advertisement messages are used for SLAAC
355	   (State-Less Address AutoConfiguration).
356
35720090922:
358	802.11s D3.03 support was committed. This is incompatible with the
359	previous code, which was based on D3.0.
360
36120090912:
362	A sysctl variable net.inet6.ip6.accept_rtadv now sets the default value
363	of a per-interface flag ND6_IFF_ACCEPT_RTADV, not a global knob to
364	control whether accepting Router Advertisement messages or not.
365	Also, a per-interface flag ND6_IFF_AUTO_LINKLOCAL has been added and
366	a sysctl variable net.inet6.ip6.auto_linklocal is its default value.
367	The ifconfig(8) utility now supports these flags.
368
36920090910:
370	ZFS snapshots are now mounted with MNT_IGNORE flag. Use -v option for
371	mount(8) and -a option for df(1) to see them.
372
37320090825:
374	The old tunable hw.bus.devctl_disable has been superseded by
375	hw.bus.devctl_queue.  hw.bus.devctl_disable=1 in loader.conf should be
376	replaced by hw.bus.devctl_queue=0.  The default for this new tunable
377	is 1000.
378
37920090813:
380	Remove the option STOP_NMI.  The default action is now to use NMI only
381	for KDB via the newly introduced function stop_cpus_hard() and
382	maintain stop_cpus() to just use a normal IPI_STOP on ia32 and amd64.
383
38420090803:
385	The stable/8 branch created in subversion.  This corresponds to the
386	RELENG_8 branch in CVS.
387
38820090719:
389	Bump the shared library version numbers for all libraries that do not
390	use symbol versioning as part of the 8.0-RELEASE cycle.  Bump
391	__FreeBSD_version to 800105.
392
39320090714:
394	Due to changes in the implementation of virtual network stack support,
395	all network-related kernel modules must be recompiled.  As this change
396	breaks the ABI, bump __FreeBSD_version to 800104.
397
39820090713:
399	The TOE interface to the TCP syncache has been modified to remove
400	struct tcpopt (<netinet/tcp_var.h>) from the ABI of the network stack.
401	The cxgb driver is the only TOE consumer affected by this change, and
402	needs to be recompiled along with the kernel. As this change breaks
403	the ABI, bump __FreeBSD_version to 800103.
404
40520090712: 
406	Padding has been added to struct tcpcb, sackhint and tcpstat in
407	<netinet/tcp_var.h> to facilitate future MFCs and bug fixes whilst
408	maintaining the ABI. However, this change breaks the ABI, so bump
409	__FreeBSD_version to 800102. User space tools that rely on the size of
410	any of these structs (e.g. sockstat) need to be recompiled.
411
41220090630:
413	The NFS_LEGACYRPC option has been removed along with the old kernel
414	RPC implementation that this option selected. Kernel configurations
415	may need to be adjusted.
416
41720090629:
418	The network interface device nodes at /dev/net/<interface> have been
419	removed.  All ioctl operations can be performed the normal way using
420	routing sockets.  The kqueue functionality can generally be replaced
421	with routing sockets.
422
42320090628:
424	The documentation from the FreeBSD Documentation Project (Handbook,
425	FAQ, etc.) is now installed via packages by sysinstall(8) and under
426	the /usr/local/share/doc/freebsd directory instead of /usr/share/doc.
427
42820090624:
429	The ABI of various structures related to the SYSV IPC API have been
430	changed.  As a result, the COMPAT_FREEBSD[456] and COMPAT_43 kernel
431	options now all require COMPAT_FREEBSD7.  Bump __FreeBSD_version to
432	800100.
433
43420090622:
435	Layout of struct vnet has changed as routing related variables were
436	moved to their own Vimage module. Modules need to be recompiled.  Bump
437	__FreeBSD_version to 800099.
438
43920090619:
440	NGROUPS_MAX and NGROUPS have been increased from 16 to 1023 and 1024
441	respectively.  As long as no more than 16 groups per process are used,
442	no changes should be visible.  When more than 16 groups are used, old
443	binaries may fail if they call getgroups() or getgrouplist() with
444	statically sized storage.  Recompiling will work around this, but
445	applications should be modified to use dynamically allocated storage
446	for group arrays as POSIX.1-2008 does not cap an implementation's
447	number of supported groups at NGROUPS_MAX+1 as previous versions did.
448
449	NFS and portalfs mounts may also be affected as the list of groups is
450	truncated to 16.  Users of NFS who use more than 16 groups, should
451	take care that negative group permissions are not used on the exported
452	file systems as they will not be reliable unless a GSSAPI based
453	authentication method is used.
454
45520090616: 
456	The compiling option ADAPTIVE_LOCKMGRS has been introduced.  This
457	option compiles in the support for adaptive spinning for lockmgrs
458	which want to enable it.  The lockinit() function now accepts the flag
459	LK_ADAPTIVE in order to make the lock object subject to adaptive
460	spinning when both held in write and read mode.
461
46220090613:
463	The layout of the structure returned by IEEE80211_IOC_STA_INFO has
464	changed.  User applications that use this ioctl need to be rebuilt.
465
46620090611:
467	The layout of struct thread has changed.  Kernel and modules need to
468	be rebuilt.
469
47020090608:
471	The layout of structs ifnet, domain, protosw and vnet_net has changed.
472	Kernel modules need to be rebuilt.  Bump __FreeBSD_version to 800097.
473
47420090602:
475	window(1) has been removed from the base system. It can now be
476	installed from ports. The port is called misc/window.
477
47820090601:
479	The way we are storing and accessing `routing table' entries has
480	changed. Programs reading the FIB, like netstat, need to be
481	re-compiled.
482
48320090601:
484	A new netisr implementation has been added for FreeBSD 8.  Network
485	file system modules, such as igmp, ipdivert, and others, should be
486	rebuilt.
487	Bump __FreeBSD_version to 800096.
488
48920090530:
490	Remove the tunable/sysctl debug.mpsafevfs as its initial purpose is no
491	more valid.
492
49320090530:
494	Add VOP_ACCESSX(9).  File system modules need to be rebuilt.
495	Bump __FreeBSD_version to 800094.
496
49720090529:
498	Add mnt_xflag field to 'struct mount'.  File system modules need to be
499	rebuilt.
500	Bump __FreeBSD_version to 800093.
501
50220090528:
503	The compiling option ADAPTIVE_SX has been retired while it has been
504	introduced the option NO_ADAPTIVE_SX which handles the reversed logic.
505	The KPI for sx_init_flags() changes as accepting flags:
506	SX_ADAPTIVESPIN flag has been retired while the SX_NOADAPTIVE flag has
507	been introduced in order to handle the reversed logic.
508	Bump __FreeBSD_version to 800092.
509
51020090527:
511	Add support for hierarchical jails.  Remove global securelevel.
512	Bump __FreeBSD_version to 800091.
513
51420090523:
515	The layout of struct vnet_net has changed, therefore modules
516	need to be rebuilt.
517	Bump __FreeBSD_version to 800090.
518
51920090523:
520	The newly imported zic(8) produces a new format in the output. Please
521	run tzsetup(8) to install the newly created data to /etc/localtime.
522
52320090520:
524	The sysctl tree for the usb stack has renamed from hw.usb2.* to
525	hw.usb.* and is now consistent again with previous releases.
526
52720090520:
528	802.11 monitor mode support was revised and driver api's were changed.
529	Drivers dependent on net80211 now support DLT_IEEE802_11_RADIO instead
530	of DLT_IEEE802_11.  No user-visible data structures were changed but
531	applications that use DLT_IEEE802_11 may require changes.
532	Bump __FreeBSD_version to 800088.
533
53420090430:
535	The layout of the following structs has changed: sysctl_oid,
536	socket, ifnet, inpcbinfo, tcpcb, syncache_head, vnet_inet,
537	vnet_inet6 and vnet_ipfw.  Most modules need to be rebuild or
538	panics may be experienced.  World rebuild is required for
539	correctly checking networking state from userland.
540	Bump __FreeBSD_version to 800085.
541
54220090429:
543	MLDv2 and Source-Specific Multicast (SSM) have been merged
544	to the IPv6 stack. VIMAGE hooks are in but not yet used.
545	The implementation of SSM within FreeBSD's IPv6 stack closely
546	follows the IPv4 implementation.
547
548	For kernel developers:
549
550	* The most important changes are that the ip6_output() and
551	  ip6_input() paths no longer take the IN6_MULTI_LOCK,
552	  and this lock has been downgraded to a non-recursive mutex.
553
554	* As with the changes to the IPv4 stack to support SSM, filtering
555	  of inbound multicast traffic must now be performed by transport
556	  protocols within the IPv6 stack. This does not apply to TCP and
557	  SCTP, however, it does apply to UDP in IPv6 and raw IPv6.
558
559	* The KPIs used by IPv6 multicast are similar to those used by
560	  the IPv4 stack, with the following differences:
561	   * im6o_mc_filter() is analogous to imo_multicast_filter().
562	   * The legacy KAME entry points in6_joingroup and in6_leavegroup()
563	     are shimmed to in6_mc_join() and in6_mc_leave() respectively.
564	   * IN6_LOOKUP_MULTI() has been deprecated and removed.
565	   * IPv6 relies on MLD for the DAD mechanism. KAME's internal KPIs
566	     for MLDv1 have an additional 'timer' argument which is used to
567	     jitter the initial membership report for the solicited-node
568	     multicast membership on-link.
569	   * This is not strictly needed for MLDv2, which already jitters
570	     its report transmissions.  However, the 'timer' argument is
571	     preserved in case MLDv1 is active on the interface.
572
573	* The KAME linked-list based IPv6 membership implementation has
574	  been refactored to use a vector similar to that used by the IPv4
575	  stack.
576	  Code which maintains a list of its own multicast memberships
577	  internally, e.g. carp, has been updated to reflect the new
578	  semantics.
579
580	* There is a known Lock Order Reversal (LOR) due to in6_setscope()
581	  acquiring the IF_AFDATA_LOCK and being called within ip6_output().
582	  Whilst MLDv2 tries to avoid this otherwise benign LOR, it is an
583	  implementation constraint which needs to be addressed in HEAD.
584
585	For application developers:
586
587	* The changes are broadly similar to those made for the IPv4
588	  stack.
589
590	* The use of IPv4 and IPv6 multicast socket options on the same
591	  socket, using mapped addresses, HAS NOT been tested or supported.
592
593	* There are a number of issues with the implementation of various
594	  IPv6 multicast APIs which need to be resolved in the API surface
595	  before the implementation is fully compatible with KAME userland
596	  use, and these are mostly to do with interface index treatment.
597
598	* The literature available discusses the use of either the delta / ASM
599	  API with setsockopt(2)/getsockopt(2), or the full-state / ASM API
600	  using setsourcefilter(3)/getsourcefilter(3). For more information
601	  please refer to RFC 3768, 'Socket Interface Extensions for
602	  Multicast Source Filters'.
603
604	* Applications which use the published RFC 3678 APIs should be fine.
605
606	For systems administrators:
607
608	* The mtest(8) utility has been refactored to support IPv6, in
609	  addition to IPv4. Interface addresses are no longer accepted
610	  as arguments, their names must be used instead. The utility
611	  will map the interface name to its first IPv4 address as
612	  returned by getifaddrs(3).
613
614	* The ifmcstat(8) utility has also been updated to print the MLDv2
615	  endpoint state and source filter lists via sysctl(3).
616
617	* The net.inet6.ip6.mcast.loop sysctl may be tuned to 0 to disable
618	  loopback of IPv6 multicast datagrams by default; it defaults to 1
619	  to preserve the existing behaviour. Disabling multicast loopback is
620	  recommended for optimal system performance.
621
622	* The IPv6 MROUTING code has been changed to examine this sysctl
623	  instead of attempting to perform a group lookup before looping
624	  back forwarded datagrams.
625
626	Bump __FreeBSD_version to 800084.
627
62820090422:
629	Implement low-level Bluetooth HCI API.
630	Bump __FreeBSD_version to 800083.
631
63220090419:
633	The layout of struct malloc_type, used by modules to register new
634	memory allocation types, has changed.  Most modules will need to
635	be rebuilt or panics may be experienced.
636	Bump __FreeBSD_version to 800081.
637
63820090415:
639	Anticipate overflowing inp_flags - add inp_flags2.
640	This changes most offsets in inpcb, so checking v4 connection
641	state will require a world rebuild.
642	Bump __FreeBSD_version to 800080.
643
64420090415:
645	Add an llentry to struct route and struct route_in6. Modules
646	embedding a struct route will need to be recompiled.
647	Bump __FreeBSD_version to 800079.
648
64920090414:
650	The size of rt_metrics_lite and by extension rtentry has changed.
651	Networking administration apps will need to be recompiled.
652	The route command now supports show as an alias for get, weighting
653	of routes, sticky and nostick flags to alter the behavior of stateful
654	load balancing.
655	Bump __FreeBSD_version to 800078.
656
65720090408:
658	Do not use Giant for kbdmux(4) locking. This is wrong and
659	apparently causing more problems than it solves. This will
660	re-open the issue where interrupt handlers may race with
661	kbdmux(4) in polling mode. Typical symptoms include (but
662	not limited to) duplicated and/or missing characters when
663	low level console functions (such as gets) are used while
664	interrupts are enabled (for example geli password prompt,
665	mountroot prompt etc.). Disabling kbdmux(4) may help.
666
66720090407:
668	The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
669	kernel modules referencing any of the above need to be recompiled.
670	Bump __FreeBSD_version to 800075.
671
67220090320:
673	GEOM_PART has become the default partition slicer for storage devices,
674	replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
675	introduces some changes:
676
677	MSDOS/EBR: the devices created from MSDOS extended partition entries
678	(EBR) can be named differently than with GEOM_MBR and are now symlinks
679	to devices with offset-based names. fstabs may need to be modified.
680
681	BSD: the "geometry does not match label" warning is harmless in most
682	cases but it points to problems in file system misalignment with
683	disk geometry. The "c" partition is now implicit, covers the whole
684	top-level drive and cannot be (mis)used by users.
685
686	General: Kernel dumps are now not allowed to be written to devices
687	whose partition types indicate they are meant to be used for file
688	systems (or, in case of MSDOS partitions, as something else than
689	the "386BSD" type).
690
691	Most of these changes date approximately from 200812.
692
69320090319:
694	The uscanner(4) driver has been removed from the kernel. This follows
695	Linux removing theirs in 2.6 and making libusb the default interface
696	(supported by sane).
697
69820090319:
699	The multicast forwarding code has been cleaned up. netstat(1)
700	only relies on KVM now for printing bandwidth upcall meters.
701	The IPv4 and IPv6 modules are split into ip_mroute_mod and
702	ip6_mroute_mod respectively. The config(5) options for statically
703	compiling this code remain the same, i.e. 'options MROUTING'.
704
70520090315:
706	Support for the IFF_NEEDSGIANT network interface flag has been
707	removed, which means that non-MPSAFE network device drivers are no
708	longer supported.  In particular, if_ar, if_sr, and network device
709	drivers from the old (legacy) USB stack can no longer be built or
710	used.
711
71220090313:
713	POSIX.1 Native Language Support (NLS) has been enabled in libc and
714	a bunch of new language catalog files have also been added.
715	This means that some common libc messages are now localized and
716	they depend on the LC_MESSAGES environmental variable.
717
71820090313:
719	The k8temp(4) driver has been renamed to amdtemp(4) since
720	support for Family 10 and Family 11 CPU families was added.
721
72220090309:
723	IGMPv3 and Source-Specific Multicast (SSM) have been merged
724	to the IPv4 stack. VIMAGE hooks are in but not yet used.
725
726	For kernel developers, the most important changes are that the
727	ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
728	and this lock has been downgraded to a non-recursive mutex.
729
730	Transport protocols (UDP, Raw IP) are now responsible for filtering
731	inbound multicast traffic according to group membership and source
732	filters. The imo_multicast_filter() KPI exists for this purpose.
733	Transports which do not use multicast (SCTP, TCP) already reject
734	multicast by default. Forwarding and receive performance may improve
735	as a mutex acquisition is no longer needed in the ip_input()
736	low-level input path.  in_addmulti() and in_delmulti() are shimmed
737	to new KPIs which exist to support SSM in-kernel.
738
739	For application developers, it is recommended that loopback of
740	multicast datagrams be disabled for best performance, as this
741	will still cause the lock to be taken for each looped-back
742	datagram transmission. The net.inet.ip.mcast.loop sysctl may
743	be tuned to 0 to disable loopback by default; it defaults to 1
744	to preserve the existing behaviour.
745
746	For systems administrators, to obtain best performance with
747	multicast reception and multiple groups, it is always recommended
748	that a card with a suitably precise hash filter is used. Hash
749	collisions will still result in the lock being taken within the
750	transport protocol input path to check group membership.
751
752	If deploying FreeBSD in an environment with IGMP snooping switches,
753	it is recommended that the net.inet.igmp.sendlocal sysctl remain
754	enabled; this forces 224.0.0.0/24 group membership to be announced
755	via IGMP.
756
757	The size of 'struct igmpstat' has changed; netstat needs to be
758	recompiled to reflect this.
759	Bump __FreeBSD_version to 800070.
760
76120090309:
762	libusb20.so.1 is now installed as libusb.so.1 and the ports system
763	updated to use it. This requires a buildworld/installworld in order to
764	update the library and dependencies (usbconfig, etc). Its advisable to
765	rebuild all ports which uses libusb. More specific directions are given
766	in the ports collection UPDATING file. Any /etc/libmap.conf entries for
767	libusb are no longer required and can be removed.
768
76920090302:
770	A workaround is committed to allow the creation of System V shared
771	memory segment of size > 2 GB on the 64-bit architectures.
772	Due to a limitation of the existing ABI, the shm_segsz member
773	of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
774	wrong for large segments. Note that limits must be explicitly
775	raised to allow such segments to be created.
776
77720090301:
778	The layout of struct ifnet has changed, requiring a rebuild of all
779	network device driver modules.
780
78120090227:
782	The /dev handling for the new USB stack has changed, a
783	buildworld/installworld is required for libusb20.
784
78520090223:
786	The new USB2 stack has now been permanently moved in and all kernel and
787	module names reverted to their previous values (eg, usb, ehci, ohci,
788	ums, ...).  The old usb stack can be compiled in by prefixing the name
789	with the letter 'o', the old usb modules have been removed.
790	Updating entry 20090216 for xorg and 20090215 for libmap may still
791	apply.
792
79320090217:
794	The rc.conf(5) option if_up_delay has been renamed to
795	defaultroute_delay to better reflect its purpose. If you have
796	customized this setting in /etc/rc.conf you need to update it to
797	use the new name.
798
79920090216:
800	xorg 7.4 wants to configure its input devices via hald which does not
801	yet work with USB2. If the keyboard/mouse does not work in xorg then
802	add
803		Option "AllowEmptyInput" "off"
804	to your ServerLayout section.  This will cause X to use the configured
805	kbd and mouse sections from your xorg.conf.
806
80720090215:
808	The GENERIC kernels for all architectures now default to the new USB2
809	stack. No kernel config options or code have been removed so if a
810	problem arises please report it and optionally revert to the old USB
811	stack. If you are loading USB kernel modules or have a custom kernel
812	that includes GENERIC then ensure that usb names are also changed over,
813	eg uftdi -> usb2_serial_ftdi.
814
815	Older programs linked against the ports libusb 0.1 need to be
816	redirected to the new stack's libusb20.  /etc/libmap.conf can
817	be used for this:
818		# Map old usb library to new one for usb2 stack
819		libusb-0.1.so.8	libusb20.so.1
820
82120090209:
822	All USB ethernet devices now attach as interfaces under the name ueN
823	(eg. ue0). This is to provide a predictable name as vendors often
824	change usb chipsets in a product without notice.
825
82620090203:
827	The ichsmb(4) driver has been changed to require SMBus slave
828	addresses be left-justified (xxxxxxx0b) rather than right-justified.
829	All of the other SMBus controller drivers require left-justified
830	slave addresses, so this change makes all the drivers provide the
831	same interface.
832
83320090201:
834	INET6 statistics (struct ip6stat) was updated.
835	netstat(1) needs to be recompiled.
836
83720090119:
838	NTFS has been removed from GENERIC kernel on amd64 to match
839	GENERIC on i386. Should not cause any issues since mount_ntfs(8)
840	will load ntfs.ko module automatically when NTFS support is
841	actually needed, unless ntfs.ko is not installed or security
842	level prohibits loading kernel modules. If either is the case,
843	"options NTFS" has to be added into kernel config.
844
84520090115:
846	TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
847	New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
848	800061. User space tools that rely on the size of struct tcpcb in
849	tcp_var.h (e.g. sockstat) need to be recompiled.
850
85120081225:
852	ng_tty(4) module updated to match the new TTY subsystem.
853	Due to API change, user-level applications must be updated.
854	New API support added to mpd5 CVS and expected to be present
855	in next mpd5.3 release.
856
85720081219:
858	With __FreeBSD_version 800060 the makefs tool is part of
859	the base system (it was a port).
860
86120081216:
862	The afdata and ifnet locks have been changed from mutexes to
863	rwlocks, network modules will need to be re-compiled.
864
86520081214:
866	__FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
867	RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
868	The new code reduced struct rtentry{} by 16 bytes on 32-bit
869	architecture and 40 bytes on 64-bit architecture. The userland
870	applications "arp" and "ndp" have been updated accordingly.
871	The output from "netstat -r" shows only routing entries and
872	none of the L2 information.
873
87420081130:
875	__FreeBSD_version 800057 marks the switchover from the
876	binary ath hal to source code. Users must add the line:
877
878	options	AH_SUPPORT_AR5416
879
880	to their kernel config files when specifying:
881
882	device	ath_hal
883
884	The ath_hal module no longer exists; the code is now compiled
885	together with the driver in the ath module.  It is now
886	possible to tailor chip support (i.e. reduce the set of chips
887	and thereby the code size); consult ath_hal(4) for details.
888
88920081121:
890	__FreeBSD_version 800054 adds memory barriers to
891	<machine/atomic.h>, new interfaces to ifnet to facilitate
892	multiple hardware transmit queues for cards that support
893	them, and a lock-less ring-buffer implementation to
894	enable drivers to more efficiently manage queueing of
895	packets.
896
89720081117:
898	A new version of ZFS (version 13) has been merged to -HEAD.
899	This version has zpool attribute "listsnapshots" off by
900	default, which means "zfs list" does not show snapshots,
901	and is the same as Solaris behavior.
902
90320081028:
904	dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
905
90620081009:
907	The uhci, ohci, ehci and slhci USB Host controller drivers have
908	been put into separate modules. If you load the usb module
909	separately through loader.conf you will need to load the
910	appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
911	controller add the following to loader.conf:
912
913		uhci_load="YES"
914		ehci_load="YES"
915
91620081009:
917	The ABI used by the PMC toolset has changed.  Please keep
918	userland (libpmc(3)) and the kernel module (hwpmc(4)) in
919	sync.
920
92120081009:
922	atapci kernel module now includes only generic PCI ATA
923	driver. AHCI driver moved to ataahci kernel module.
924	All vendor-specific code moved into separate kernel modules:
925	ataacard, ataacerlabs, ataadaptec, ataamd, ataati, atacenatek,
926	atacypress, atacyrix, atahighpoint, ataintel, ataite, atajmicron,
927	atamarvell, atamicron, atanational, atanetcell, atanvidia,
928	atapromise, ataserverworks, atasiliconimage, atasis, atavia
929
93020080820:
931	The TTY subsystem of the kernel has been replaced by a new
932	implementation, which provides better scalability and an
933	improved driver model. Most common drivers have been migrated to
934	the new TTY subsystem, while others have not. The following
935	drivers have not yet been ported to the new TTY layer:
936
937	PCI/ISA:
938		cy, digi, rc, rp, sio
939
940	USB:
941		ubser, ucycom
942
943	Line disciplines:
944		ng_h4, ng_tty, ppp, sl, snp
945
946	Adding these drivers to your kernel configuration file shall
947	cause compilation to fail.
948
94920080818:
950	ntpd has been upgraded to 4.2.4p5.
951
95220080801:
953	OpenSSH has been upgraded to 5.1p1.
954
955	For many years, FreeBSD's version of OpenSSH preferred DSA
956	over RSA for host and user authentication keys.  With this
957	upgrade, we've switched to the vendor's default of RSA over
958	DSA.  This may cause upgraded clients to warn about unknown
959	host keys even for previously known hosts.  Users should
960	follow the usual procedure for verifying host keys before
961	accepting the RSA key.
962
963	This can be circumvented by setting the "HostKeyAlgorithms"
964	option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
965	command line.
966
967	Please note that the sequence of keys offered for
968	authentication has been changed as well.  You may want to
969	specify IdentityFile in a different order to revert this
970	behavior.
971
97220080713:
973	The sio(4) driver has been removed from the i386 and amd64
974	kernel configuration files. This means uart(4) is now the
975	default serial port driver on those platforms as well.
976
977	To prevent collisions with the sio(4) driver, the uart(4) driver
978	uses different names for its device nodes. This means the
979	onboard serial port will now most likely be called "ttyu0"
980	instead of "ttyd0". You may need to reconfigure applications to
981	use the new device names.
982
983	When using the serial port as a boot console, be sure to update
984	/boot/device.hints and /etc/ttys before booting the new kernel.
985	If you forget to do so, you can still manually specify the hints
986	at the loader prompt:
987
988		set hint.uart.0.at="isa"
989		set hint.uart.0.port="0x3F8"
990		set hint.uart.0.flags="0x10"
991		set hint.uart.0.irq="4"
992		boot -s
993
99420080609:
995	The gpt(8) utility has been removed. Use gpart(8) to partition
996	disks instead.
997
99820080603:
999	The version that Linuxulator emulates was changed from 2.4.2
1000	to 2.6.16. If you experience any problems with Linux binaries
1001	please try to set sysctl compat.linux.osrelease to 2.4.2 and
1002	if it fixes the problem contact emulation mailing list.
1003
100420080525:
1005	ISDN4BSD (I4B) was removed from the src tree. You may need to
1006	update a your kernel configuration and remove relevant entries.
1007
100820080509:
1009	I have checked in code to support multiple routing tables.
1010	See the man pages setfib(1) and setfib(2).
1011	This is a hopefully backwards compatible version,
1012	but to make use of it you need to compile your kernel
1013	with options ROUTETABLES=2 (or more up to 16).
1014
101520080420:
1016	The 802.11 wireless support was redone to enable multi-bss
1017	operation on devices that are capable.  The underlying device
1018	is no longer used directly but instead wlanX devices are
1019	cloned with ifconfig.  This requires changes to rc.conf files.
1020	For example, change:
1021		ifconfig_ath0="WPA DHCP"
1022	to
1023		wlans_ath0=wlan0
1024		ifconfig_wlan0="WPA DHCP"
1025	see rc.conf(5) for more details.  In addition, mergemaster of
1026	/etc/rc.d is highly recommended.  Simultaneous update of userland
1027	and kernel wouldn't hurt either.
1028
1029	As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
1030	modules were merged into the base wlan module.  All references
1031	to these modules (e.g. in kernel config files) must be removed.
1032
103320080408:
1034	psm(4) has gained write(2) support in native operation level.
1035	Arbitrary commands can be written to /dev/psm%d and status can
1036	be read back from it.  Therefore, an application is responsible
1037	for status validation and error recovery.  It is a no-op in
1038	other operation levels.
1039
104020080312:
1041	Support for KSE threading has been removed from the kernel.  To
1042	run legacy applications linked against KSE libmap.conf may
1043	be used.  The following libmap.conf may be used to ensure
1044	compatibility with any prior release:
1045
1046	libpthread.so.1 libthr.so.1
1047	libpthread.so.2 libthr.so.2
1048	libkse.so.3 libthr.so.3
1049
105020080301:
1051	The layout of struct vmspace has changed. This affects libkvm
1052	and any executables that link against libkvm and use the
1053	kvm_getprocs() function. In particular, but not exclusively,
1054	it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
1055	The effects are minimal, but it's advisable to upgrade world
1056	nonetheless.
1057
105820080229:
1059	The latest em driver no longer has support in it for the
1060	82575 adapter, this is now moved to the igb driver. The
1061	split was done to make new features that are incompatible
1062	with older hardware easier to do.
1063
106420080220:
1065	The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
1066	likewise the kernel option is now GEOM_LINUX_LVM.
1067
106820080211:
1069	The default NFS mount mode has changed from UDP to TCP for
1070	increased reliability.  If you rely on (insecurely) NFS
1071	mounting across a firewall you may need to update your
1072	firewall rules.
1073
107420080208:
1075	Belatedly note the addition of m_collapse for compacting
1076	mbuf chains.
1077
107820080126:
1079	The fts(3) structures have been changed to use adequate
1080	integer types for their members and so to be able to cope
1081	with huge file trees.  The old fts(3) ABI is preserved
1082	through symbol versioning in libc, so third-party binaries
1083	using fts(3) should still work, although they will not take
1084	advantage of the extended types.  At the same time, some
1085	third-party software might fail to build after this change
1086	due to unportable assumptions made in its source code about
1087	fts(3) structure members.  Such software should be fixed
1088	by its vendor or, in the worst case, in the ports tree.
1089	FreeBSD_version 800015 marks this change for the unlikely
1090	case that a portable fix is impossible.
1091
109220080123:
1093	To upgrade to -current after this date, you must be running
1094	FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
1095	from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
1096
109720071128:
1098	The ADAPTIVE_GIANT kernel option has been retired because its
1099	functionality is the default now.
1100
110120071118:
1102	The AT keyboard emulation of sunkbd(4) has been turned on
1103	by default. In order to make the special symbols of the Sun
1104	keyboards driven by sunkbd(4) work under X these now have
1105	to be configured the same way as Sun USB keyboards driven
1106	by ukbd(4) (which also does AT keyboard emulation), f.e.:
1107
1108	Option	"XkbLayout" "us"
1109	Option	"XkbRules" "xorg"
1110	Option	"XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
1111
111220071024:
1113	It has been decided that it is desirable to provide ABI
1114	backwards compatibility to the FreeBSD 4/5/6 versions of the
1115	PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
1116	broken with the introduction of PCI domain support (see the
1117	20070930 entry). Unfortunately, this required the ABI of
1118	PCIOCGETCONF to be broken again in order to be able to
1119	provide backwards compatibility to the old version of that
1120	IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
1121	again. As for prominent ports this affects neither pciutils
1122	nor xorg-server this time, the hal port needs to be rebuilt
1123	however.
1124
112520071020:
1126	The misnamed kthread_create() and friends have been renamed
1127	to kproc_create() etc. Many of the callers already
1128	used kproc_start()..
1129	I will return kthread_create() and friends in a while
1130	with implementations that actually create threads, not procs.
1131	Renaming corresponds with version 800002.
1132
113320071010:
1134	RELENG_7 branched.
1135
1136COMMON ITEMS:
1137
1138	General Notes
1139	-------------
1140	Avoid using make -j when upgrading.  While generally safe, there are
1141	sometimes problems using -j to upgrade.  If your upgrade fails with
1142	-j, please try again without -j.  From time to time in the past there
1143	have been problems using -j with buildworld and/or installworld.  This
1144	is especially true when upgrading between "distant" versions (eg one
1145	that cross a major release boundary or several minor releases, or when
1146	several months have passed on the -current branch).
1147
1148	Sometimes, obscure build problems are the result of environment
1149	poisoning.  This can happen because the make utility reads its
1150	environment when searching for values for global variables.  To run
1151	your build attempts in an "environmental clean room", prefix all make
1152	commands with 'env -i '.  See the env(1) manual page for more details.
1153
1154	When upgrading from one major version to another it is generally best
1155	to upgrade to the latest code in the currently installed branch first,
1156	then do an upgrade to the new branch. This is the best-tested upgrade
1157	path, and has the highest probability of being successful.  Please try
1158	this approach before reporting problems with a major version upgrade.
1159
1160	ZFS notes
1161	---------
1162	When upgrading the boot ZFS pool to a new version, always follow
1163	these two steps:
1164
1165	1.) recompile and reinstall the ZFS boot loader and boot block
1166	(this is part of "make buildworld" and "make installworld")
1167
1168	2.) update the ZFS boot block on your boot drive
1169
1170	The following example updates the ZFS boot block on the first
1171	partition (freebsd-boot) of a GPT partitioned drive ad0:
1172	"gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
1173
1174	Non-boot pools do not need these updates.
1175
1176	To build a kernel
1177	-----------------
1178	If you are updating from a prior version of FreeBSD (even one just
1179	a few days old), you should follow this procedure.  It is the most
1180	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1181
1182	make kernel-toolchain
1183	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1184	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1185
1186	To test a kernel once
1187	---------------------
1188	If you just want to boot a kernel once (because you are not sure
1189	if it works, or if you want to boot a known bad kernel to provide
1190	debugging information) run
1191	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1192	nextboot -k testkernel
1193
1194	To just build a kernel when you know that it won't mess you up
1195	--------------------------------------------------------------
1196	This assumes you are already running a CURRENT system.  Replace
1197	${arch} with the architecture of your machine (e.g. "i386",
1198	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1199
1200	cd src/sys/${arch}/conf
1201	config KERNEL_NAME_HERE
1202	cd ../compile/KERNEL_NAME_HERE
1203	make depend
1204	make
1205	make install
1206
1207	If this fails, go to the "To build a kernel" section.
1208
1209	To rebuild everything and install it on the current system.
1210	-----------------------------------------------------------
1211	# Note: sometimes if you are running current you gotta do more than
1212	# is listed here if you are upgrading from a really old current.
1213
1214	<make sure you have good level 0 dumps>
1215	make buildworld
1216	make kernel KERNCONF=YOUR_KERNEL_HERE
1217							[1]
1218	<reboot in single user>				[3]
1219	mergemaster -p					[5]
1220	make installworld
1221	mergemaster -i					[4]
1222	make delete-old					[6]
1223	<reboot>
1224
1225
1226	To cross-install current onto a separate partition
1227	--------------------------------------------------
1228	# In this approach we use a separate partition to hold
1229	# current's root, 'usr', and 'var' directories.   A partition
1230	# holding "/", "/usr" and "/var" should be about 2GB in
1231	# size.
1232
1233	<make sure you have good level 0 dumps>
1234	<boot into -stable>
1235	make buildworld
1236	make buildkernel KERNCONF=YOUR_KERNEL_HERE
1237	<maybe newfs current's root partition>
1238	<mount current's root partition on directory ${CURRENT_ROOT}>
1239	make installworld DESTDIR=${CURRENT_ROOT}
1240	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1241	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1242	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
1243	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1244	<reboot into current>
1245	<do a "native" rebuild/install as described in the previous section>
1246	<maybe install compatibility libraries from ports/misc/compat*>
1247	<reboot>
1248
1249
1250	To upgrade in-place from 8.x-stable to current
1251	----------------------------------------------
1252	<make sure you have good level 0 dumps>
1253	make buildworld					[9]
1254	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
1255							[1]
1256	<reboot in single user>				[3]
1257	mergemaster -p					[5]
1258	make installworld
1259	mergemaster -i					[4]
1260	make delete-old					[6]
1261	<reboot>
1262
1263	Make sure that you've read the UPDATING file to understand the
1264	tweaks to various things you need.  At this point in the life
1265	cycle of current, things change often and you are on your own
1266	to cope.  The defaults can also change, so please read ALL of
1267	the UPDATING entries.
1268
1269	Also, if you are tracking -current, you must be subscribed to
1270	freebsd-current@freebsd.org.  Make sure that before you update
1271	your sources that you have read and understood all the recent
1272	messages there.  If in doubt, please track -stable which has
1273	much fewer pitfalls.
1274
1275	[1] If you have third party modules, such as vmware, you
1276	should disable them at this point so they don't crash your
1277	system on reboot.
1278
1279	[3] From the bootblocks, boot -s, and then do
1280		fsck -p
1281		mount -u /
1282		mount -a
1283		cd src
1284		adjkerntz -i		# if CMOS is wall time
1285	Also, when doing a major release upgrade, it is required that
1286	you boot into single user mode to do the installworld.
1287
1288	[4] Note: This step is non-optional.  Failure to do this step
1289	can result in a significant reduction in the functionality of the
1290	system.  Attempting to do it by hand is not recommended and those
1291	that pursue this avenue should read this file carefully, as well
1292	as the archives of freebsd-current and freebsd-hackers mailing lists
1293	for potential gotchas.  The -U option is also useful to consider.
1294	See mergemaster(8) for more information.
1295
1296	[5] Usually this step is a noop.  However, from time to time
1297	you may need to do this if you get unknown user in the following
1298	step.  It never hurts to do it all the time.  You may need to
1299	install a new mergemaster (cd src/usr.sbin/mergemaster && make
1300	install) after the buildworld before this step if you last updated
1301	from current before 20020224 or from -stable before 20020408.
1302
1303	[6] This only deletes old files and directories. Old libraries
1304	can be deleted by "make delete-old-libs", but you have to make
1305	sure that no program is using those libraries anymore.
1306
1307	[8] In order to have a kernel that can run the 4.x binaries needed to
1308	do an installworld, you must include the COMPAT_FREEBSD4 option in
1309	your kernel.  Failure to do so may leave you with a system that is
1310	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1311	required to run the 5.x binaries on more recent kernels.  And so on
1312	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1313
1314	Make sure that you merge any new devices from GENERIC since the
1315	last time you updated your kernel config file.
1316
1317	[9] When checking out sources, you must include the -P flag to have
1318	cvs prune empty directories.
1319
1320	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1321	"?=" instead of the "=" assignment operator, so that buildworld can
1322	override the CPUTYPE if it needs to.
1323
1324	MAKEOBJDIRPREFIX must be defined in an environment variable, and
1325	not on the command line, or in /etc/make.conf.  buildworld will
1326	warn if it is improperly defined.
1327FORMAT:
1328
1329This file contains a list, in reverse chronological order, of major
1330breakages in tracking -current.  Not all things will be listed here,
1331and it only starts on October 16, 2004.  Updating files can found in
1332previous releases if your system is older than this.
1333
1334Copyright information:
1335
1336Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1337
1338Redistribution, publication, translation and use, with or without
1339modification, in full or in part, in any form or format of this
1340document are permitted without further permission from the author.
1341
1342THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1343IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1344WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1345DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1346INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1347(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1348SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1349HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1350STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1351IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1352POSSIBILITY OF SUCH DAMAGE.
1353
1354Contact Warner Losh if you have any questions about your use of
1355this document.
1356
1357$FreeBSD: head/UPDATING 220770 2011-04-18 10:25:54Z dim $
1358