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