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