xref: /freebsd/UPDATING (revision 4b63a7c678a1291c8056de3770cfa393773b1f94)
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
9    http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
10
11Items affecting the ports and packages system can be found in
12/usr/ports/UPDATING.  Please read that file before running portupgrade.
13
14NOTE: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15from older versions of FreeBSD, try WITHOUT_CLANG and WITH_GCC to bootstrap to
16the tip of head, and then rebuild without this option. The bootstrap process from
17older version of current across the gcc/clang cutover is a bit fragile.
18
19NOTE TO PEOPLE WHO THINK THAT FreeBSD 11.x IS SLOW:
20	FreeBSD 11.x has many debugging features turned on, in both the kernel
21	and userland.  These features attempt to detect incorrect use of
22	system primitives, and encourage loud failure through extra sanity
23	checking and fail stop semantics.  They also substantially impact
24	system performance.  If you want to do performance measurement,
25	benchmarking, and optimization, you'll want to turn them off.  This
26	includes various WITNESS- related kernel options, INVARIANTS, malloc
27	debugging flags in userland, and various verbose features in the
28	kernel.  Many developers choose to disable these features on build
29	machines to maximize performance.  (To completely disable malloc
30	debugging, define MALLOC_PRODUCTION in /etc/make.conf, or to merely
31	disable the most expensive debugging functionality run
32	"ln -s 'abort:false,junk:false' /etc/malloc.conf".)
33
3420141109:
35	faith(4) and faithd(8) has been removed from base system. It
36	has been obsolete for a very long time.
37
3820141104:
39	vt(4), the new console driver, is enabled by default. It brings
40	support for Unicode and double-width characters, as well as
41	support for UEFI and integration with the KMS kernel video
42	drivers.
43
44	You may need to update your console settings in /etc/rc.conf,
45	most probably the keymap. During boot, /etc/rc.d/syscons will
46	indicate what you need to do.
47
48	vt(4) still has issues and lacks some features compared to
49	syscons(4). See the wiki for up-to-date information:
50	  https://wiki.freebsd.org/Newcons
51
52	If you want to keep using syscons(4), you can do so by adding
53	the following line to /boot/loader.conf:
54	  kern.vty=sc
55
5620141102:
57	pjdfstest has been integrated into kyua as an opt-in test suite.
58	Please see share/doc/pjdfstest/README for a more details on how to
59	execute it.
60
6120141009:
62	gperf has been removed from the base system for architectures
63	that use clang. Ports that require gperf will obtain it from the
64	devel/gperf port.
65
6620140923:
67	pjdfstest has been moved from tools/regression/pjdfstest to
68	contrib/pjdfstest .
69
7020140922:
71	At svn r271982, The default linux compat kernel ABI has been adjusted
72	to 2.6.18 in support of the linux-c6 compat ports infrastructure
73	update.  If you wish to continue using the linux-f10 compat ports,
74	add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
75	encouraged to update their linux-compat packages to linux-c6 during
76	their next update cycle.
77
7820140729:
79	The ofwfb driver, used to provide a graphics console on PowerPC when
80	using vt(4), no longer allows mmap() of all of physical memory. This
81	will prevent Xorg on PowerPC with some ATI graphics cards from
82	initializing properly unless x11-servers/xorg-server is updated to
83	1.12.4_8 or newer.
84
8520140723:
86	The xdev targets have been converted to using TARGET and
87	TARGET_ARCH instead of XDEV and XDEV_ARCH.
88
8920140719:
90	The default unbound configuration has been modified to address
91	issues with reverse lookups on networks that use private
92	address ranges.  If you use the local_unbound service, run
93	"service local_unbound setup" as root to regenerate your
94	configuration, then "service local_unbound reload" to load the
95	new configuration.
96
9720140709:
98	The GNU texinfo and GNU info pages are not built and installed
99	anymore, WITH_INFO knob has been added to allow to built and install
100	them again.
101
10220140708:
103	The GNU readline library is now an INTERNALLIB - that is, it is
104	statically linked into consumers (GDB and variants) in the base
105	system, and the shared library is no longer installed.  The
106	devel/readline port is available for third party software that
107	requires readline.
108
10920140702:
110	The Itanium architecture (ia64) has been removed from the list of
111	known architectures. This is the first step in the removal of the
112	architecture.
113
11420140701:
115	Commit r268115 has added NFSv4.1 server support, merged from
116	projects/nfsv4.1-server.  Since this includes changes to the
117	internal interfaces between the NFS related modules, a full
118	build of the kernel and modules will be necessary.
119	__FreeBSD_version has been bumped.
120
12120140629:
122	The WITHOUT_VT_SUPPORT kernel config knob has been renamed
123	WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
124	which differs from the behaviour controlled by this knob.)
125
12620140619:
127	Maximal length of the serial number in CTL was increased from 16 to
128	64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
129	and ctld, need to be rebuilt to work with a new kernel.
130
13120140606:
132	The libatf-c and libatf-c++ major versions were downgraded to 0 and
133	1 respectively to match the upstream numbers.  They were out of
134	sync because, when they were originally added to FreeBSD, the
135	upstream versions were not respected.  These libraries are private
136	and not yet built by default, so renumbering them should be a
137	non-issue.  However, unclean source trees will yield broken test
138	programs once the operator executes "make delete-old-libs" after a
139	"make installworld".
140
141	Additionally, the atf-sh binary was made private by moving it into
142	/usr/libexec/.  Already-built shell test programs will keep the
143	path to the old binary so they will break after "make delete-old"
144	is run.
145
146	If you are using WITH_TESTS=yes (not the default), wipe the object
147	tree and rebuild from scratch to prevent spurious test failures.
148	This is only needed once: the misnumbered libraries and misplaced
149	binaries have been added to OptionalObsoleteFiles.inc so they will
150	be removed during a clean upgrade.
151
15220140512:
153	Clang and llvm have been upgraded to 3.4.1 release.
154
15520140508:
156	We bogusly installed src.opts.mk in /usr/share/mk. This file should
157	be removed to avoid issues in the future (and has been added to
158	ObsoleteFiles.inc).
159
16020140505:
161	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
162	past, it affected all builds that used the bsd.*.mk files. The old
163	behavior was a bug, but people may have relied upon it. To get this
164	behavior back, you can .include /etc/src.conf from /etc/make.conf
165	(which is still global and isn't changed). This also changes the
166	behavior of incremental builds inside the tree of individual
167	directories. Set MAKESYSPATH to ".../share/mk" to do that.
168	Although this has survived make universe and some upgrade scenarios,
169	other upgrade scenarios may have broken. At least one form of
170	temporary breakage was fixed with MAKESYSPATH settings for buildworld
171	as well... In cases where MAKESYSPATH isn't working with this
172	setting, you'll need to set it to the full path to your tree.
173
174	One side effect of all this cleaning up is that bsd.compiler.mk
175	is no longer implicitly included by bsd.own.mk. If you wish to
176	use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
177	as well.
178
17920140430:
180	The lindev device has been removed since /dev/full has been made a
181	standard device.  __FreeBSD_version has been bumped.
182
18320140418:
184	The YES_HESIOD knob has been removed. It has been obsolete for
185	a decade. Please move to using WITH_HESIOD instead or your builds
186	will silently lack HESIOD.
187
18820140405:
189	The uart(4) driver has been changed with respect to its handling
190	of the low-level console. Previously the uart(4) driver prevented
191	any process from changing the baudrate or the CLOCAL and HUPCL
192	control flags. By removing the restrictions, operators can make
193	changes to the serial console port without having to reboot.
194	However, when getty(8) is started on the serial device that is
195	associated with the low-level console, a misconfigured terminal
196	line in /etc/ttys will now have a real impact.
197	Before upgrading the kernel, make sure that /etc/ttys has the
198	serial console device configured as 3wire without baudrate to
199	preserve the previous behaviour. E.g:
200	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
201
20220140306:
203	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
204	to improve performance.  To re-enable it, if needed, run rpcbind
205	with command line option -W.
206
20720140226:
208	Switched back to the GPL dtc compiler due to updates in the upstream
209	dts files not being supported by the BSDL dtc compiler. You will need
210	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
211	may result while building dtb files during a kernel build if you fail
212	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
213
21420140216:
215	Clang and llvm have been upgraded to 3.4 release.
216
21720140216:
218	The nve(4) driver has been removed.  Please use the nfe(4) driver
219	for NVIDIA nForce MCP Ethernet adapters instead.
220
22120140212:
222	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
223	This could cause certain C++ applications using shared libraries built
224	against the previous version of libc++ to crash.  The incompatibility
225	has now been fixed, but any C++ applications or shared libraries built
226	between r261283 and r261801 should be recompiled.
227
22820140204:
229	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
230	capability mode support.  Please note that enabling the feature in
231	kernel is still highly recommended.
232
23320140131:
234	OpenSSH is now built with sandbox support, and will use sandbox as
235	the default privilege separation method.  This requires Capsicum
236	capability mode support in kernel.
237
23820140128:
239	The libelf and libdwarf libraries have been updated to newer
240	versions from upstream. Shared library version numbers for
241	these two libraries were bumped. Any ports or binaries
242	requiring these two libraries should be recompiled.
243	__FreeBSD_version is bumped to 1100006.
244
24520140110:
246	If a Makefile in a tests/ directory was auto-generating a Kyuafile
247	instead of providing an explicit one, this would prevent such
248	Makefile from providing its own Kyuafile in the future during
249	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
250	intervention is needed to clean an objdir if you use NO_CLEAN:
251	  # find /usr/obj -name Kyuafile | xargs rm -f
252
25320131213:
254	The behavior of gss_pseudo_random() for the krb5 mechanism
255	has changed, for applications requesting a longer random string
256	than produced by the underlying enctype's pseudo-random() function.
257	In particular, the random string produced from a session key of
258	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
259	be different at the 17th octet and later, after this change.
260	The counter used in the PRF+ construction is now encoded as a
261	big-endian integer in accordance with RFC 4402.
262	__FreeBSD_version is bumped to 1100004.
263
26420131108:
265	The WITHOUT_ATF build knob has been removed and its functionality
266	has been subsumed into the more generic WITHOUT_TESTS.  If you were
267	using the former to disable the build of the ATF libraries, you
268	should change your settings to use the latter.
269
27020131025:
271	The default version of mtree is nmtree which is obtained from
272	NetBSD.  The output is generally the same, but may vary
273	slightly.  If you found you need identical output adding
274	"-F freebsd9" to the command line should do the trick.  For the
275	time being, the old mtree is available as fmtree.
276
27720131014:
278	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
279	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
280	1.1.4_8 and verify bsdyml not linked in, before running "make
281	delete-old-libs":
282	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
283	  or
284	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
285
28620131010:
287	The rc.d/jail script has been updated to support jail(8)
288	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
289	for per-jail configuration are automatically converted to
290	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
291	This is transparently backward compatible.  See below about some
292	incompatibilities and rc.conf(5) manual page for more details.
293
294	These variables are now deprecated in favor of jail(8) configuration
295	file.  One can use "rc.d/jail config <jname>" command to generate
296	a jail(8) configuration file in /var/run/jail.<jname>.conf without
297	running the jail(8) utility.   The default pathname of the
298	configuration file is /etc/jail.conf and can be specified by
299	using $jail_conf or $jail_<jname>_conf variables.
300
301	Please note that jail_devfs_ruleset accepts an integer at
302	this moment.  Please consider to rewrite the ruleset name
303	with an integer.
304
30520130930:
306	BIND has been removed from the base system.  If all you need
307	is a local resolver, simply enable and start the local_unbound
308	service instead.  Otherwise, several versions of BIND are
309	available in the ports tree.   The dns/bind99 port is one example.
310
311	With this change, nslookup(1) and dig(1) are no longer in the base
312	system.  Users should instead use host(1) and drill(1) which are
313	in the base system.  Alternatively, nslookup and dig can
314	be obtained by installing the dns/bind-tools port.
315
31620130916:
317	With the addition of unbound(8), a new unbound user is now
318	required during installworld.  "mergemaster -p" can be used to
319	add the user prior to installworld, as documented in the handbook.
320
32120130911:
322	OpenSSH is now built with DNSSEC support, and will by default
323	silently trust signed SSHFP records.  This can be controlled with
324	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
325	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
326
32720130906:
328	The GNU Compiler Collection and C++ standard library (libstdc++)
329	are no longer built by default on platforms where clang is the system
330	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
331	options in src.conf.
332
33320130905:
334	The PROCDESC kernel option is now part of the GENERIC kernel
335	configuration and is required for the rwhod(8) to work.
336	If you are using custom kernel configuration, you should include
337	'options PROCDESC'.
338
33920130905:
340	The API and ABI related to the Capsicum framework was modified
341	in backward incompatible way. The userland libraries and programs
342	have to be recompiled to work with the new kernel. This includes the
343	following libraries and programs, but the whole buildworld is
344	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
345	kdump, procstat, rwho, rwhod, uniq.
346
34720130903:
348	AES-NI intrinsic support has been added to gcc.  The AES-NI module
349	has been updated to use this support.  A new gcc is required to build
350	the aesni module on both i386 and amd64.
351
35220130821:
353	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
354	Thus "device padlock_rng" and "device rdrand_rng" should be
355	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
356
35720130813:
358	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
359	enables just the iconv* functionality and is now on by default.
360	WITH_LIBICONV_COMPAT enables the libiconv api and link time
361	compatability.  Set WITHOUT_ICONV to build the old way.
362	If you have been using WITH_ICONV before, you will very likely
363	need to turn on WITH_LIBICONV_COMPAT.
364
36520130806:
366	INVARIANTS option now enables DEBUG for code with OpenSolaris and
367	Illumos origin, including ZFS.  If you have INVARIANTS in your
368	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
369	explicitly.
370	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
371	locks if WITNESS option was set.  Because that generated a lot of
372	witness(9) reports and all of them were believed to be false
373	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
374	can be used to achieve the previous behavior.
375
37620130806:
377	Timer values in IPv6 data structures now use time_uptime instead
378	of time_second.  Although this is not a user-visible functional
379	change, userland utilities which directly use them---ndp(8),
380	rtadvd(8), and rtsold(8) in the base system---need to be updated
381	to r253970 or later.
382
38320130802:
384	find -delete can now delete the pathnames given as arguments,
385	instead of only files found below them or if the pathname did
386	not contain any slashes. Formerly, the following error message
387	would result:
388
389	find: -delete: <path>: relative path potentially not safe
390
391	Deleting the pathnames given as arguments can be prevented
392	without error messages using -mindepth 1 or by changing
393	directory and passing "." as argument to find. This works in the
394	old as well as the new version of find.
395
39620130726:
397	Behavior of devfs rules path matching has been changed.
398	Pattern is now always matched against fully qualified devfs
399	path and slash characters must be explicitly matched by
400	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
401	subdirectories must be reviewed.
402
40320130716:
404	The default ARM ABI has changed to the ARM EABI. The old ABI is
405	incompatible with the ARM EABI and all programs and modules will
406	need to be rebuilt to work with a new kernel.
407
408	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
409
410	NOTE: Support for the old ABI will be removed in the future and
411	users are advised to upgrade.
412
41320130709:
414	pkg_install has been disconnected from the build if you really need it
415	you should add WITH_PKGTOOLS in your src.conf(5).
416
41720130709:
418	Most of network statistics structures were changed to be able
419	keep 64-bits counters. Thus all tools, that work with networking
420	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
421
42220130629:
423	Fix targets that run multiple make's to use && rather than ;
424	so that subsequent steps depend on success of previous.
425
426	NOTE: if building 'universe' with -j* on stable/8 or stable/9
427	it would be better to start the build using bmake, to avoid
428	overloading the machine.
429
43020130618:
431	Fix a bug that allowed a tracing process (e.g. gdb) to write
432	to a memory-mapped file in the traced process's address space
433	even if neither the traced process nor the tracing process had
434	write access to that file.
435
43620130615:
437	CVS has been removed from the base system.  An exact copy
438	of the code is available from the devel/cvs port.
439
44020130613:
441	Some people report the following error after the switch to bmake:
442
443		make: illegal option -- J
444		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
445			...
446		*** [buildworld] Error code 2
447
448	this likely due to an old instance of make in
449	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
450	which src/Makefile will use that blindly, if it exists, so if
451	you see the above error:
452
453		rm -rf `make -V MAKEPATH`
454
455	should resolve it.
456
45720130516:
458	Use bmake by default.
459	Whereas before one could choose to build with bmake via
460	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
461	make. The goal is to remove these knobs for 10-RELEASE.
462
463	It is worth noting that bmake (like gmake) treats the command
464	line as the unit of failure, rather than statements within the
465	command line.  Thus '(cd some/where && dosomething)' is safer
466	than 'cd some/where; dosomething'. The '()' allows consistent
467	behavior in parallel build.
468
46920130429:
470        Fix a bug that allows NFS clients to issue READDIR on files.
471
47220130426:
473	The WITHOUT_IDEA option has been removed because
474	the IDEA patent expired.
475
47620130426:
477	The sysctl which controls TRIM support under ZFS has been renamed
478	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
479	enabled by default.
480
48120130425:
482	The mergemaster command now uses the default MAKEOBJDIRPREFIX
483	rather than creating it's own in the temporary directory in
484	order allow access to bootstrapped versions of tools such as
485	install and mtree.  When upgrading from version of FreeBSD where
486	the install command does not support -l, you will need to
487	install a new mergemaster command if mergemaster -p is required.
488	This can be accomplished with the command (cd src/usr.sbin/mergemaster
489	&& make install).
490
49120130404:
492	Legacy ATA stack, disabled and replaced by new CAM-based one since
493	FreeBSD 9.0, completely removed from the sources.  Kernel modules
494	atadisk and atapi*, user-level tools atacontrol and burncd are
495	removed.  Kernel option `options ATA_CAM` is now permanently enabled
496	and removed.
497
49820130319:
499	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
500	and socketpair(2). Software, in particular Kerberos, may
501	automatically detect and use these during building. The resulting
502	binaries will not work on older kernels.
503
50420130308:
505	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
506	information, see the respective 20130304 entry).
507
50820130304:
509	Recent commits to callout(9) changed the size of struct callout,
510	so the KBI is probably heavily disturbed. Also, some functions
511	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
512	by macros. Every kernel module using it won't load, so rebuild
513	is requested.
514
515	The ctl device has been re-enabled in GENERIC for i386 and amd64,
516	but does not initialize by default (because of the new CTL_DISABLE
517	option) to save memory.  To re-enable it, remove the CTL_DISABLE
518	option from the kernel config file or set kern.cam.ctl.disable=0
519	in /boot/loader.conf.
520
52120130301:
522	The ctl device has been disabled in GENERIC for i386 and amd64.
523	This was done due to the extra memory being allocated at system
524	initialisation time by the ctl driver which was only used if
525	a CAM target device was created.  This makes a FreeBSD system
526	unusable on 128MB or less of RAM.
527
52820130208:
529	A new compression method (lz4) has been merged to -HEAD.  Please
530	refer to zpool-features(7) for more information.
531
532	Please refer to the "ZFS notes" section of this file for information
533	on upgrading boot ZFS pools.
534
53520130129:
536	A BSD-licensed patch(1) variant has been added and is installed
537	as bsdpatch, being the GNU version the default patch.
538	To inverse the logic and use the BSD-licensed one as default,
539	while having the GNU version installed as gnupatch, rebuild
540	and install world with the WITH_BSD_PATCH knob set.
541
54220130121:
543	Due to the use of the new -l option to install(1) during build
544	and install, you must take care not to directly set the INSTALL
545	make variable in your /etc/make.conf, /etc/src.conf, or on the
546	command line.  If you wish to use the -C flag for all installs
547	you may be able to add INSTALL+=-C to /etc/make.conf or
548	/etc/src.conf.
549
55020130118:
551	The install(1) option -M has changed meaning and now takes an
552	argument that is a file or path to append logs to.  In the
553	unlikely event that -M was the last option on the command line
554	and the command line contained at least two files and a target
555	directory the first file will have logs appended to it.  The -M
556	option served little practical purpose in the last decade so its
557	use is expected to be extremely rare.
558
55920121223:
560	After switching to Clang as the default compiler some users of ZFS
561	on i386 systems started to experience stack overflow kernel panics.
562	Please consider using 'options KSTACK_PAGES=4' in such configurations.
563
56420121222:
565	GEOM_LABEL now mangles label names read from file system metadata.
566	Mangling affect labels containing spaces, non-printable characters,
567	'%' or '"'. Device names in /etc/fstab and other places may need to
568	be updated.
569
57020121217:
571	By default, only the 10 most recent kernel dumps will be saved.  To
572	restore the previous behaviour (no limit on the number of kernel dumps
573	stored in the dump directory) add the following line to /etc/rc.conf:
574
575		savecore_flags=""
576
57720121201:
578	With the addition of auditdistd(8), a new auditdistd user is now
579	required during installworld.  "mergemaster -p" can be used to
580	add the user prior to installworld, as documented in the handbook.
581
58220121117:
583	The sin6_scope_id member variable in struct sockaddr_in6 is now
584	filled by the kernel before passing the structure to the userland via
585	sysctl or routing socket.  This means the KAME-specific embedded scope
586	id in sin6_addr.s6_addr[2] is always cleared in userland application.
587	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
588	__FreeBSD_version is bumped to 1000025.
589
59020121105:
591	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
592	This means that the world and kernel will be compiled with clang
593	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
594	and /usr/bin/cpp.  To disable this behavior and revert to building
595	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
596	of current may need to bootstrap WITHOUT_CLANG first if the clang
597	build fails (its compatibility window doesn't extend to the 9 stable
598	branch point).
599
60020121102:
601	The IPFIREWALL_FORWARD kernel option has been removed. Its
602	functionality now turned on by default.
603
60420121023:
605	The ZERO_COPY_SOCKET kernel option has been removed and
606	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
607	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
608	mechanism which is not safe and may result in kernel crashes.
609	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
610	driver supports disposeable external page sized mbuf storage.
611	Proper replacements for both zero-copy mechanisms are under
612	consideration and will eventually lead to complete removal
613	of the two kernel options.
614
61520121023:
616	The IPv4 network stack has been converted to network byte
617	order. The following modules need to be recompiled together
618	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
619	pf(4), ipfw(4), ng_ipfw(4), stf(4).
620
62120121022:
622	Support for non-MPSAFE filesystems was removed from VFS. The
623	VFS_VERSION was bumped, all filesystem modules shall be
624	recompiled.
625
62620121018:
627	All the non-MPSAFE filesystems have been disconnected from
628	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
629	portalfs, smbfs, xfs.
630
63120121016:
632	The interface cloning API and ABI has changed. The following
633	modules need to be recompiled together with kernel:
634	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
635	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
636	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
637
63820121015:
639	The sdhci driver was split in two parts: sdhci (generic SD Host
640	Controller logic) and sdhci_pci (actual hardware driver).
641	No kernel config modifications are required, but if you
642	load sdhc as a module you must switch to sdhci_pci instead.
643
64420121014:
645	Import the FUSE kernel and userland support into base system.
646
64720121013:
648	The GNU sort(1) program has been removed since the BSD-licensed
649	sort(1) has been the default for quite some time and no serious
650	problems have been reported.  The corresponding WITH_GNU_SORT
651	knob has also gone.
652
65320121006:
654	The pfil(9) API/ABI for AF_INET family has been changed. Packet
655	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
656	with new kernel.
657
65820121001:
659	The net80211(4) ABI has been changed to allow for improved driver
660	PS-POLL and power-save support.  All wireless drivers need to be
661	recompiled to work with the new kernel.
662
66320120913:
664	The random(4) support for the VIA hardware random number
665	generator (`PADLOCK') is no longer enabled unconditionally.
666	Add the padlock_rng device in the custom kernel config if
667	needed.  The GENERIC kernels on i386 and amd64 do include the
668	device, so the change only affects the custom kernel
669	configurations.
670
67120120908:
672	The pf(4) packet filter ABI has been changed. pfctl(8) and
673	snmp_pf module need to be recompiled to work with new kernel.
674
67520120828:
676	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
677	to -HEAD. Pools that have empty_bpobj in active state can not be
678	imported read-write with ZFS implementations that do not support
679	this feature. For more information read the zpool-features(5)
680	manual page.
681
68220120727:
683	The sparc64 ZFS loader has been changed to no longer try to auto-
684	detect ZFS providers based on diskN aliases but now requires these
685	to be explicitly listed in the OFW boot-device environment variable.
686
68720120712:
688	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
689	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
690	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
691
69220120712:
693	The following sysctls and tunables have been renamed for consistency
694	with other variables:
695	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
696	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
697
69820120628:
699	The sort utility has been replaced with BSD sort.  For now, GNU sort
700	is also available as "gnusort" or the default can be set back to
701	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
702	installed as "bsdsort".
703
70420120611:
705	A new version of ZFS (pool version 5000) has been merged to -HEAD.
706	Starting with this version the old system of ZFS pool versioning
707	is superseded by "feature flags". This concept enables forward
708	compatibility against certain future changes in functionality of ZFS
709	pools. The first read-only compatible "feature flag" for ZFS pools
710	is named "com.delphix:async_destroy". For more information
711	read the new zpool-features(5) manual page.
712	Please refer to the "ZFS notes" section of this file for information
713	on upgrading boot ZFS pools.
714
71520120417:
716	The malloc(3) implementation embedded in libc now uses sources imported
717	as contrib/jemalloc.  The most disruptive API change is to
718	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
719	delete it prior to installworld, and optionally re-create it using the
720	new format after rebooting.  See malloc.conf(5) for details
721	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
722	NAMESPACE section).
723
72420120328:
725	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
726	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
727	now spelled mips.  This is to aid compatibility with third-party
728	software that expects this naming scheme in uname(3).  Little-endian
729	settings are unchanged. If you are updating a big-endian mips64 machine
730	from before this change, you may need to set MACHINE_ARCH=mips64 in
731	your environment before the new build system will recognize your machine.
732
73320120306:
734	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
735	platforms.
736
73720120229:
738	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
739	nullfs(5) did not pass through all behaviours to the underlying layer,
740	as a result if we bound to a socket on the lower layer we could connect
741	only to the lower path; if we bound to the upper layer we could connect
742	only to	the upper path. The new behavior is one can connect to both the
743	lower and the upper paths regardless what layer path one binds to.
744
74520120211:
746	The getifaddrs upgrade path broken with 20111215 has been restored.
747	If you have upgraded in between 20111215 and 20120209 you need to
748	recompile libc again with your kernel.  You still need to recompile
749	world to be able to configure CARP but this restriction already
750	comes from 20111215.
751
75220120114:
753	The set_rcvar() function has been removed from /etc/rc.subr.  All
754	base and ports rc.d scripts have been updated, so if you have a
755	port installed with a script in /usr/local/etc/rc.d you can either
756	hand-edit the rcvar= line, or reinstall the port.
757
758	An easy way to handle the mass-update of /etc/rc.d:
759	rm /etc/rc.d/* && mergemaster -i
760
76120120109:
762	panic(9) now stops other CPUs in the SMP systems, disables interrupts
763	on the current CPU and prevents other threads from running.
764	This behavior can be reverted using the kern.stop_scheduler_on_panic
765	tunable/sysctl.
766	The new behavior can be incompatible with kern.sync_on_panic.
767
76820111215:
769	The carp(4) facility has been changed significantly. Configuration
770	of the CARP protocol via ifconfig(8) has changed, as well as format
771	of CARP events submitted to devd(8) has changed. See manual pages
772	for more information. The arpbalance feature of carp(4) is currently
773	not supported anymore.
774
775	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
776	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
777	need to be recompiled.
778
77920111122:
780	The acpi_wmi(4) status device /dev/wmistat has been renamed to
781	/dev/wmistat0.
782
78320111108:
784	The option VFS_ALLOW_NONMPSAFE option has been added in order to
785	explicitely support non-MPSAFE filesystems.
786	It is on by default for all supported platform at this present
787	time.
788
78920111101:
790	The broken amd(4) driver has been replaced with esp(4) in the amd64,
791	i386 and pc98 GENERIC kernel configuration files.
792
79320110930:
794	sysinstall has been removed
795
79620110923:
797	The stable/9 branch created in subversion.  This corresponds to the
798	RELENG_9 branch in CVS.
799
800COMMON ITEMS:
801
802	General Notes
803	-------------
804	Avoid using make -j when upgrading.  While generally safe, there are
805	sometimes problems using -j to upgrade.  If your upgrade fails with
806	-j, please try again without -j.  From time to time in the past there
807	have been problems using -j with buildworld and/or installworld.  This
808	is especially true when upgrading between "distant" versions (eg one
809	that cross a major release boundary or several minor releases, or when
810	several months have passed on the -current branch).
811
812	Sometimes, obscure build problems are the result of environment
813	poisoning.  This can happen because the make utility reads its
814	environment when searching for values for global variables.  To run
815	your build attempts in an "environmental clean room", prefix all make
816	commands with 'env -i '.  See the env(1) manual page for more details.
817
818	When upgrading from one major version to another it is generally best
819	to upgrade to the latest code in the currently installed branch first,
820	then do an upgrade to the new branch. This is the best-tested upgrade
821	path, and has the highest probability of being successful.  Please try
822	this approach before reporting problems with a major version upgrade.
823
824	When upgrading a live system, having a root shell around before
825	installing anything can help undo problems. Not having a root shell
826	around can lead to problems if pam has changed too much from your
827	starting point to allow continued authentication after the upgrade.
828
829	ZFS notes
830	---------
831	When upgrading the boot ZFS pool to a new version, always follow
832	these two steps:
833
834	1.) recompile and reinstall the ZFS boot loader and boot block
835	(this is part of "make buildworld" and "make installworld")
836
837	2.) update the ZFS boot block on your boot drive
838
839	The following example updates the ZFS boot block on the first
840	partition (freebsd-boot) of a GPT partitioned drive ada0:
841	"gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
842
843	Non-boot pools do not need these updates.
844
845	To build a kernel
846	-----------------
847	If you are updating from a prior version of FreeBSD (even one just
848	a few days old), you should follow this procedure.  It is the most
849	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
850
851	make kernel-toolchain
852	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
853	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
854
855	To test a kernel once
856	---------------------
857	If you just want to boot a kernel once (because you are not sure
858	if it works, or if you want to boot a known bad kernel to provide
859	debugging information) run
860	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
861	nextboot -k testkernel
862
863	To just build a kernel when you know that it won't mess you up
864	--------------------------------------------------------------
865	This assumes you are already running a CURRENT system.  Replace
866	${arch} with the architecture of your machine (e.g. "i386",
867	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
868
869	cd src/sys/${arch}/conf
870	config KERNEL_NAME_HERE
871	cd ../compile/KERNEL_NAME_HERE
872	make depend
873	make
874	make install
875
876	If this fails, go to the "To build a kernel" section.
877
878	To rebuild everything and install it on the current system.
879	-----------------------------------------------------------
880	# Note: sometimes if you are running current you gotta do more than
881	# is listed here if you are upgrading from a really old current.
882
883	<make sure you have good level 0 dumps>
884	make buildworld
885	make kernel KERNCONF=YOUR_KERNEL_HERE
886							[1]
887	<reboot in single user>				[3]
888	mergemaster -Fp					[5]
889	make installworld
890	mergemaster -Fi					[4]
891	make delete-old					[6]
892	<reboot>
893
894	To cross-install current onto a separate partition
895	--------------------------------------------------
896	# In this approach we use a separate partition to hold
897	# current's root, 'usr', and 'var' directories.   A partition
898	# holding "/", "/usr" and "/var" should be about 2GB in
899	# size.
900
901	<make sure you have good level 0 dumps>
902	<boot into -stable>
903	make buildworld
904	make buildkernel KERNCONF=YOUR_KERNEL_HERE
905	<maybe newfs current's root partition>
906	<mount current's root partition on directory ${CURRENT_ROOT}>
907	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
908	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
909	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
910	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
911	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
912	<reboot into current>
913	<do a "native" rebuild/install as described in the previous section>
914	<maybe install compatibility libraries from ports/misc/compat*>
915	<reboot>
916
917
918	To upgrade in-place from stable to current
919	----------------------------------------------
920	<make sure you have good level 0 dumps>
921	make buildworld					[9]
922	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
923							[1]
924	<reboot in single user>				[3]
925	mergemaster -Fp					[5]
926	make installworld
927	mergemaster -Fi					[4]
928	make delete-old					[6]
929	<reboot>
930
931	Make sure that you've read the UPDATING file to understand the
932	tweaks to various things you need.  At this point in the life
933	cycle of current, things change often and you are on your own
934	to cope.  The defaults can also change, so please read ALL of
935	the UPDATING entries.
936
937	Also, if you are tracking -current, you must be subscribed to
938	freebsd-current@freebsd.org.  Make sure that before you update
939	your sources that you have read and understood all the recent
940	messages there.  If in doubt, please track -stable which has
941	much fewer pitfalls.
942
943	[1] If you have third party modules, such as vmware, you
944	should disable them at this point so they don't crash your
945	system on reboot.
946
947	[3] From the bootblocks, boot -s, and then do
948		fsck -p
949		mount -u /
950		mount -a
951		cd src
952		adjkerntz -i		# if CMOS is wall time
953	Also, when doing a major release upgrade, it is required that
954	you boot into single user mode to do the installworld.
955
956	[4] Note: This step is non-optional.  Failure to do this step
957	can result in a significant reduction in the functionality of the
958	system.  Attempting to do it by hand is not recommended and those
959	that pursue this avenue should read this file carefully, as well
960	as the archives of freebsd-current and freebsd-hackers mailing lists
961	for potential gotchas.  The -U option is also useful to consider.
962	See mergemaster(8) for more information.
963
964	[5] Usually this step is a noop.  However, from time to time
965	you may need to do this if you get unknown user in the following
966	step.  It never hurts to do it all the time.  You may need to
967	install a new mergemaster (cd src/usr.sbin/mergemaster && make
968	install) after the buildworld before this step if you last updated
969	from current before 20130425 or from -stable before 20130430.
970
971	[6] This only deletes old files and directories. Old libraries
972	can be deleted by "make delete-old-libs", but you have to make
973	sure that no program is using those libraries anymore.
974
975	[8] In order to have a kernel that can run the 4.x binaries needed to
976	do an installworld, you must include the COMPAT_FREEBSD4 option in
977	your kernel.  Failure to do so may leave you with a system that is
978	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
979	required to run the 5.x binaries on more recent kernels.  And so on
980	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
981
982	Make sure that you merge any new devices from GENERIC since the
983	last time you updated your kernel config file.
984
985	[9] When checking out sources, you must include the -P flag to have
986	cvs prune empty directories.
987
988	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
989	"?=" instead of the "=" assignment operator, so that buildworld can
990	override the CPUTYPE if it needs to.
991
992	MAKEOBJDIRPREFIX must be defined in an environment variable, and
993	not on the command line, or in /etc/make.conf.  buildworld will
994	warn if it is improperly defined.
995FORMAT:
996
997This file contains a list, in reverse chronological order, of major
998breakages in tracking -current.  It is not guaranteed to be a complete
999list of such breakages, and only contains entries since October 10, 2007.
1000If you need to see UPDATING entries from before that date, you will need
1001to fetch an UPDATING file from an older FreeBSD release.
1002
1003Copyright information:
1004
1005Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1006
1007Redistribution, publication, translation and use, with or without
1008modification, in full or in part, in any form or format of this
1009document are permitted without further permission from the author.
1010
1011THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1012IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1013WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1014DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1015INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1016(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1017SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1018HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1019STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1020IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1021POSSIBILITY OF SUCH DAMAGE.
1022
1023Contact Warner Losh if you have any questions about your use of
1024this document.
1025
1026$FreeBSD$
1027