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