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