xref: /freebsd/UPDATING (revision fa7bd4a7323b2462295b810265b16f1a8f131825)
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
3420140505:
35	/etc/src.conf now affects only builds of the FreeBSD src tree. In the
36	past, it affected all builds that used the bsd.*.mk files. The old
37	behavior was a bug, but people may have relied upon it. To get this
38	behavior back, you can .include /etc/src.conf from /etc/make.conf
39	(which is still global and isn't changed). This also changes the
40	behavior of incremental builds inside the tree of individual
41	directories. Set MAKESYSPATH to ".../share/mk" to do that.
42	Although this has survived make universe and some upgrade scenarios,
43	other upgrade scenarios may have broken. At least one form of
44	temporary breakage was fixed with MAKESYSPATH settings for buildworld
45	as well...
46
4720140430:
48	The lindev device has been removed since /dev/full has been made a
49	standard device.  __FreeBSD_version has been bumped.
50
5120140418:
52	The YES_HESIOD knob has been removed. It has been obsolete for
53	a decade. Please move to using WITH_HESIOD instead or your builds
54	will silently lack HESIOD.
55
5620140405:
57	The uart(4) driver has been changed with respect to its handling
58	of the low-level console. Previously the uart(4) driver prevented
59	any process from changing the baudrate or the CLOCAL and HUPCL
60	control flags. By removing the restrictions, operators can make
61	changes to the serial console port without having to reboot.
62	However, when getty(8) is started on the serial device that is
63	associated with the low-level console, a misconfigured terminal
64	line in /etc/ttys will now have a real impact.
65	Before upgrading the kernel, make sure that /etc/ttys has the
66	serial console device configured as 3wire without baudrate to
67	preserve the previous behaviour. E.g:
68	    ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
69
7020140306:
71	Support for libwrap (TCP wrappers) in rpcbind was disabled by default
72	to improve performance.  To re-enable it, if needed, run rpcbind
73	with command line option -W.
74
7520140226:
76	Switched back to the GPL dtc compiler due to updates in the upstream
77	dts files not being supported by the BSDL dtc compiler. You will need
78	to rebuild your kernel toolchain to pick up the new compiler. Core dumps
79	may result while building dtb files during a kernel build if you fail
80	to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
81
8220140216:
83	Clang and llvm have been upgraded to 3.4 release.
84
8520140216:
86	The nve(4) driver has been removed.  Please use the nfe(4) driver
87	for NVIDIA nForce MCP Ethernet adapters instead.
88
8920140212:
90	An ABI incompatibility crept into the libc++ 3.4 import in r261283.
91	This could cause certain C++ applications using shared libraries built
92	against the previous version of libc++ to crash.  The incompatibility
93	has now been fixed, but any C++ applications or shared libraries built
94	between r261283 and r261801 should be recompiled.
95
9620140204:
97	OpenSSH will now ignore errors caused by kernel lacking of Capsicum
98	capability mode support.  Please note that enabling the feature in
99	kernel is still highly recommended.
100
10120140131:
102	OpenSSH is now built with sandbox support, and will use sandbox as
103	the default privilege separation method.  This requires Capsicum
104	capability mode support in kernel.
105
10620140128:
107	The libelf and libdwarf libraries have been updated to newer
108	versions from upstream. Shared library version numbers for
109	these two libraries were bumped. Any ports or binaries
110	requiring these two libraries should be recompiled.
111	__FreeBSD_version is bumped to 1100006.
112
11320140110:
114	If a Makefile in a tests/ directory was auto-generating a Kyuafile
115	instead of providing an explicit one, this would prevent such
116	Makefile from providing its own Kyuafile in the future during
117	NO_CLEAN builds.  This has been fixed in the Makefiles but manual
118	intervention is needed to clean an objdir if you use NO_CLEAN:
119	  # find /usr/obj -name Kyuafile | xargs rm -f
120
12120131213:
122	The behavior of gss_pseudo_random() for the krb5 mechanism
123	has changed, for applications requesting a longer random string
124	than produced by the underlying enctype's pseudo-random() function.
125	In particular, the random string produced from a session key of
126	enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
127	be different at the 17th octet and later, after this change.
128	The counter used in the PRF+ construction is now encoded as a
129	big-endian integer in accordance with RFC 4402.
130	__FreeBSD_version is bumped to 1100004.
131
13220131108:
133	The WITHOUT_ATF build knob has been removed and its functionality
134	has been subsumed into the more generic WITHOUT_TESTS.  If you were
135	using the former to disable the build of the ATF libraries, you
136	should change your settings to use the latter.
137
13820131025:
139	The default version of mtree is nmtree which is obtained from
140	NetBSD.  The output is generally the same, but may vary
141	slightly.  If you found you need identical output adding
142	"-F freebsd9" to the command line should do the trick.  For the
143	time being, the old mtree is available as fmtree.
144
14520131014:
146	libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
147	This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
148	1.1.4_8 and verify bsdyml not linked in, before running "make
149	delete-old-libs":
150	  # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
151	  or
152	  # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
153
15420131010:
155	The rc.d/jail script has been updated to support jail(8)
156	configuration file.  The "jail_<jname>_*" rc.conf(5) variables
157	for per-jail configuration are automatically converted to
158	/var/run/jail.<jname>.conf before the jail(8) utility is invoked.
159	This is transparently backward compatible.  See below about some
160	incompatibilities and rc.conf(5) manual page for more details.
161
162	These variables are now deprecated in favor of jail(8) configuration
163	file.  One can use "rc.d/jail config <jname>" command to generate
164	a jail(8) configuration file in /var/run/jail.<jname>.conf without
165	running the jail(8) utility.   The default pathname of the
166	configuration file is /etc/jail.conf and can be specified by
167	using $jail_conf or $jail_<jname>_conf variables.
168
169	Please note that jail_devfs_ruleset accepts an integer at
170	this moment.  Please consider to rewrite the ruleset name
171	with an integer.
172
17320130930:
174	BIND has been removed from the base system.  If all you need
175	is a local resolver, simply enable and start the local_unbound
176	service instead.  Otherwise, several versions of BIND are
177	available in the ports tree.   The dns/bind99 port is one example.
178
179	With this change, nslookup(1) and dig(1) are no longer in the base
180	system.  Users should instead use host(1) and drill(1) which are
181	in the base system.  Alternatively, nslookup and dig can
182	be obtained by installing the dns/bind-tools port.
183
18420130916:
185	With the addition of unbound(8), a new unbound user is now
186	required during installworld.  "mergemaster -p" can be used to
187	add the user prior to installworld, as documented in the handbook.
188
18920130911:
190	OpenSSH is now built with DNSSEC support, and will by default
191	silently trust signed SSHFP records.  This can be controlled with
192	the VerifyHostKeyDNS client configuration setting.  DNSSEC support
193	can be disabled entirely with the WITHOUT_LDNS option in src.conf.
194
19520130906:
196	The GNU Compiler Collection and C++ standard library (libstdc++)
197	are no longer built by default on platforms where clang is the system
198	compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
199	options in src.conf.
200
20120130905:
202	The PROCDESC kernel option is now part of the GENERIC kernel
203	configuration and is required for the rwhod(8) to work.
204	If you are using custom kernel configuration, you should include
205	'options PROCDESC'.
206
20720130905:
208	The API and ABI related to the Capsicum framework was modified
209	in backward incompatible way. The userland libraries and programs
210	have to be recompiled to work with the new kernel. This includes the
211	following libraries and programs, but the whole buildworld is
212	advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
213	kdump, procstat, rwho, rwhod, uniq.
214
21520130903:
216	AES-NI intrinsic support has been added to gcc.  The AES-NI module
217	has been updated to use this support.  A new gcc is required to build
218	the aesni module on both i386 and amd64.
219
22020130821:
221	The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
222	Thus "device padlock_rng" and "device rdrand_rng" should be
223	used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
224
22520130813:
226	WITH_ICONV has been split into two feature sets.  WITH_ICONV now
227	enables just the iconv* functionality and is now on by default.
228	WITH_LIBICONV_COMPAT enables the libiconv api and link time
229	compatability.  Set WITHOUT_ICONV to build the old way.
230	If you have been using WITH_ICONV before, you will very likely
231	need to turn on WITH_LIBICONV_COMPAT.
232
23320130806:
234	INVARIANTS option now enables DEBUG for code with OpenSolaris and
235	Illumos origin, including ZFS.  If you have INVARIANTS in your
236	kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
237	explicitly.
238	DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
239	locks if WITNESS option was set.  Because that generated a lot of
240	witness(9) reports and all of them were believed to be false
241	positives, this is no longer done.  New option OPENSOLARIS_WITNESS
242	can be used to achieve the previous behavior.
243
24420130806:
245	Timer values in IPv6 data structures now use time_uptime instead
246	of time_second.  Although this is not a user-visible functional
247	change, userland utilities which directly use them---ndp(8),
248	rtadvd(8), and rtsold(8) in the base system---need to be updated
249	to r253970 or later.
250
25120130802:
252	find -delete can now delete the pathnames given as arguments,
253	instead of only files found below them or if the pathname did
254	not contain any slashes. Formerly, the following error message
255	would result:
256
257	find: -delete: <path>: relative path potentially not safe
258
259	Deleting the pathnames given as arguments can be prevented
260	without error messages using -mindepth 1 or by changing
261	directory and passing "." as argument to find. This works in the
262	old as well as the new version of find.
263
26420130726:
265	Behavior of devfs rules path matching has been changed.
266	Pattern is now always matched against fully qualified devfs
267	path and slash characters must be explicitly matched by
268	slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
269	subdirectories must be reviewed.
270
27120130716:
272	The default ARM ABI has changed to the ARM EABI. The old ABI is
273	incompatible with the ARM EABI and all programs and modules will
274	need to be rebuilt to work with a new kernel.
275
276	To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
277
278	NOTE: Support for the old ABI will be removed in the future and
279	users are advised to upgrade.
280
28120130709:
282	pkg_install has been disconnected from the build if you really need it
283	you should add WITH_PKGTOOLS in your src.conf(5).
284
28520130709:
286	Most of network statistics structures were changed to be able
287	keep 64-bits counters. Thus all tools, that work with networking
288	statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
289
29020130629:
291	Fix targets that run multiple make's to use && rather than ;
292	so that subsequent steps depend on success of previous.
293
294	NOTE: if building 'universe' with -j* on stable/8 or stable/9
295	it would be better to start the build using bmake, to avoid
296	overloading the machine.
297
29820130618:
299	Fix a bug that allowed a tracing process (e.g. gdb) to write
300	to a memory-mapped file in the traced process's address space
301	even if neither the traced process nor the tracing process had
302	write access to that file.
303
30420130615:
305	CVS has been removed from the base system.  An exact copy
306	of the code is available from the devel/cvs port.
307
30820130613:
309	Some people report the following error after the switch to bmake:
310
311		make: illegal option -- J
312		usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
313			...
314		*** [buildworld] Error code 2
315
316	this likely due to an old instance of make in
317	${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
318	which src/Makefile will use that blindly, if it exists, so if
319	you see the above error:
320
321		rm -rf `make -V MAKEPATH`
322
323	should resolve it.
324
32520130516:
326	Use bmake by default.
327	Whereas before one could choose to build with bmake via
328	-DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
329	make. The goal is to remove these knobs for 10-RELEASE.
330
331	It is worth noting that bmake (like gmake) treats the command
332	line as the unit of failure, rather than statements within the
333	command line.  Thus '(cd some/where && dosomething)' is safer
334	than 'cd some/where; dosomething'. The '()' allows consistent
335	behavior in parallel build.
336
33720130429:
338        Fix a bug that allows NFS clients to issue READDIR on files.
339
34020130426:
341	The WITHOUT_IDEA option has been removed because
342	the IDEA patent expired.
343
34420130426:
345	The sysctl which controls TRIM support under ZFS has been renamed
346	from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
347	enabled by default.
348
34920130425:
350	The mergemaster command now uses the default MAKEOBJDIRPREFIX
351	rather than creating it's own in the temporary directory in
352	order allow access to bootstrapped versions of tools such as
353	install and mtree.  When upgrading from version of FreeBSD where
354	the install command does not support -l, you will need to
355	install a new mergemaster command if mergemaster -p is required.
356	This can be accomplished with the command (cd src/usr.sbin/mergemaster
357	&& make install).
358
35920130404:
360	Legacy ATA stack, disabled and replaced by new CAM-based one since
361	FreeBSD 9.0, completely removed from the sources.  Kernel modules
362	atadisk and atapi*, user-level tools atacontrol and burncd are
363	removed.  Kernel option `options ATA_CAM` is now permanently enabled
364	and removed.
365
36620130319:
367	SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
368	and socketpair(2). Software, in particular Kerberos, may
369	automatically detect and use these during building. The resulting
370	binaries will not work on older kernels.
371
37220130308:
373	CTL_DISABLE has also been added to the sparc64 GENERIC (for further
374	information, see the respective 20130304 entry).
375
37620130304:
377	Recent commits to callout(9) changed the size of struct callout,
378	so the KBI is probably heavily disturbed. Also, some functions
379	in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
380	by macros. Every kernel module using it won't load, so rebuild
381	is requested.
382
383	The ctl device has been re-enabled in GENERIC for i386 and amd64,
384	but does not initialize by default (because of the new CTL_DISABLE
385	option) to save memory.  To re-enable it, remove the CTL_DISABLE
386	option from the kernel config file or set kern.cam.ctl.disable=0
387	in /boot/loader.conf.
388
38920130301:
390	The ctl device has been disabled in GENERIC for i386 and amd64.
391	This was done due to the extra memory being allocated at system
392	initialisation time by the ctl driver which was only used if
393	a CAM target device was created.  This makes a FreeBSD system
394	unusable on 128MB or less of RAM.
395
39620130208:
397	A new compression method (lz4) has been merged to -HEAD.  Please
398	refer to zpool-features(7) for more information.
399
400	Please refer to the "ZFS notes" section of this file for information
401	on upgrading boot ZFS pools.
402
40320130129:
404	A BSD-licensed patch(1) variant has been added and is installed
405	as bsdpatch, being the GNU version the default patch.
406	To inverse the logic and use the BSD-licensed one as default,
407	while having the GNU version installed as gnupatch, rebuild
408	and install world with the WITH_BSD_PATCH knob set.
409
41020130121:
411	Due to the use of the new -l option to install(1) during build
412	and install, you must take care not to directly set the INSTALL
413	make variable in your /etc/make.conf, /etc/src.conf, or on the
414	command line.  If you wish to use the -C flag for all installs
415	you may be able to add INSTALL+=-C to /etc/make.conf or
416	/etc/src.conf.
417
41820130118:
419	The install(1) option -M has changed meaning and now takes an
420	argument that is a file or path to append logs to.  In the
421	unlikely event that -M was the last option on the command line
422	and the command line contained at least two files and a target
423	directory the first file will have logs appended to it.  The -M
424	option served little practical purpose in the last decade so its
425	use is expected to be extremely rare.
426
42720121223:
428	After switching to Clang as the default compiler some users of ZFS
429	on i386 systems started to experience stack overflow kernel panics.
430	Please consider using 'options KSTACK_PAGES=4' in such configurations.
431
43220121222:
433	GEOM_LABEL now mangles label names read from file system metadata.
434	Mangling affect labels containing spaces, non-printable characters,
435	'%' or '"'. Device names in /etc/fstab and other places may need to
436	be updated.
437
43820121217:
439	By default, only the 10 most recent kernel dumps will be saved.  To
440	restore the previous behaviour (no limit on the number of kernel dumps
441	stored in the dump directory) add the following line to /etc/rc.conf:
442
443		savecore_flags=""
444
44520121201:
446	With the addition of auditdistd(8), a new auditdistd user is now
447	required during installworld.  "mergemaster -p" can be used to
448	add the user prior to installworld, as documented in the handbook.
449
45020121117:
451	The sin6_scope_id member variable in struct sockaddr_in6 is now
452	filled by the kernel before passing the structure to the userland via
453	sysctl or routing socket.  This means the KAME-specific embedded scope
454	id in sin6_addr.s6_addr[2] is always cleared in userland application.
455	This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
456	__FreeBSD_version is bumped to 1000025.
457
45820121105:
459	On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
460	This means that the world and kernel will be compiled with clang
461	and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
462	and /usr/bin/cpp.  To disable this behavior and revert to building
463	with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
464	of current may need to bootstrap WITHOUT_CLANG first if the clang
465	build fails (its compatibility window doesn't extend to the 9 stable
466	branch point).
467
46820121102:
469	The IPFIREWALL_FORWARD kernel option has been removed. Its
470	functionality now turned on by default.
471
47220121023:
473	The ZERO_COPY_SOCKET kernel option has been removed and
474	split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
475	NB: SOCKET_SEND_COW uses the VM page based copy-on-write
476	mechanism which is not safe and may result in kernel crashes.
477	NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
478	driver supports disposeable external page sized mbuf storage.
479	Proper replacements for both zero-copy mechanisms are under
480	consideration and will eventually lead to complete removal
481	of the two kernel options.
482
48320121023:
484	The IPv4 network stack has been converted to network byte
485	order. The following modules need to be recompiled together
486	with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
487	pf(4), ipfw(4), ng_ipfw(4), stf(4).
488
48920121022:
490	Support for non-MPSAFE filesystems was removed from VFS. The
491	VFS_VERSION was bumped, all filesystem modules shall be
492	recompiled.
493
49420121018:
495	All the non-MPSAFE filesystems have been disconnected from
496	the build. The full list includes: codafs, hpfs, ntfs, nwfs,
497	portalfs, smbfs, xfs.
498
49920121016:
500	The interface cloning API and ABI has changed. The following
501	modules need to be recompiled together with kernel:
502	ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
503	vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
504	faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
505
50620121015:
507	The sdhci driver was split in two parts: sdhci (generic SD Host
508	Controller logic) and sdhci_pci (actual hardware driver).
509	No kernel config modifications are required, but if you
510	load sdhc as a module you must switch to sdhci_pci instead.
511
51220121014:
513	Import the FUSE kernel and userland support into base system.
514
51520121013:
516	The GNU sort(1) program has been removed since the BSD-licensed
517	sort(1) has been the default for quite some time and no serious
518	problems have been reported.  The corresponding WITH_GNU_SORT
519	knob has also gone.
520
52120121006:
522	The pfil(9) API/ABI for AF_INET family has been changed. Packet
523	filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
524	with new kernel.
525
52620121001:
527	The net80211(4) ABI has been changed to allow for improved driver
528	PS-POLL and power-save support.  All wireless drivers need to be
529	recompiled to work with the new kernel.
530
53120120913:
532	The random(4) support for the VIA hardware random number
533	generator (`PADLOCK') is no longer enabled unconditionally.
534	Add the padlock_rng device in the custom kernel config if
535	needed.  The GENERIC kernels on i386 and amd64 do include the
536	device, so the change only affects the custom kernel
537	configurations.
538
53920120908:
540	The pf(4) packet filter ABI has been changed. pfctl(8) and
541	snmp_pf module need to be recompiled to work with new kernel.
542
54320120828:
544	A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
545	to -HEAD. Pools that have empty_bpobj in active state can not be
546	imported read-write with ZFS implementations that do not support
547	this feature. For more information read the zpool-features(5)
548	manual page.
549
55020120727:
551	The sparc64 ZFS loader has been changed to no longer try to auto-
552	detect ZFS providers based on diskN aliases but now requires these
553	to be explicitly listed in the OFW boot-device environment variable.
554
55520120712:
556	The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
557	libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
558	configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
559
56020120712:
561	The following sysctls and tunables have been renamed for consistency
562	with other variables:
563	  kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
564	  kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
565
56620120628:
567	The sort utility has been replaced with BSD sort.  For now, GNU sort
568	is also available as "gnusort" or the default can be set back to
569	GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
570	installed as "bsdsort".
571
57220120611:
573	A new version of ZFS (pool version 5000) has been merged to -HEAD.
574	Starting with this version the old system of ZFS pool versioning
575	is superseded by "feature flags". This concept enables forward
576	compatibility against certain future changes in functionality of ZFS
577	pools. The first read-only compatible "feature flag" for ZFS pools
578	is named "com.delphix:async_destroy". For more information
579	read the new zpool-features(5) manual page.
580	Please refer to the "ZFS notes" section of this file for information
581	on upgrading boot ZFS pools.
582
58320120417:
584	The malloc(3) implementation embedded in libc now uses sources imported
585	as contrib/jemalloc.  The most disruptive API change is to
586	/etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
587	delete it prior to installworld, and optionally re-create it using the
588	new format after rebooting.  See malloc.conf(5) for details
589	(specifically the TUNING section and the "opt.*" entries in the MALLCTL
590	NAMESPACE section).
591
59220120328:
593	Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
594	is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
595	now spelled mips.  This is to aid compatibility with third-party
596	software that expects this naming scheme in uname(3).  Little-endian
597	settings are unchanged. If you are updating a big-endian mips64 machine
598	from before this change, you may need to set MACHINE_ARCH=mips64 in
599	your environment before the new build system will recognize your machine.
600
60120120306:
602	Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
603	platforms.
604
60520120229:
606	Now unix domain sockets behave "as expected" on	nullfs(5). Previously
607	nullfs(5) did not pass through all behaviours to the underlying layer,
608	as a result if we bound to a socket on the lower layer we could connect
609	only to the lower path; if we bound to the upper layer we could connect
610	only to	the upper path. The new behavior is one can connect to both the
611	lower and the upper paths regardless what layer path one binds to.
612
61320120211:
614	The getifaddrs upgrade path broken with 20111215 has been restored.
615	If you have upgraded in between 20111215 and 20120209 you need to
616	recompile libc again with your kernel.  You still need to recompile
617	world to be able to configure CARP but this restriction already
618	comes from 20111215.
619
62020120114:
621	The set_rcvar() function has been removed from /etc/rc.subr.  All
622	base and ports rc.d scripts have been updated, so if you have a
623	port installed with a script in /usr/local/etc/rc.d you can either
624	hand-edit the rcvar= line, or reinstall the port.
625
626	An easy way to handle the mass-update of /etc/rc.d:
627	rm /etc/rc.d/* && mergemaster -i
628
62920120109:
630	panic(9) now stops other CPUs in the SMP systems, disables interrupts
631	on the current CPU and prevents other threads from running.
632	This behavior can be reverted using the kern.stop_scheduler_on_panic
633	tunable/sysctl.
634	The new behavior can be incompatible with kern.sync_on_panic.
635
63620111215:
637	The carp(4) facility has been changed significantly. Configuration
638	of the CARP protocol via ifconfig(8) has changed, as well as format
639	of CARP events submitted to devd(8) has changed. See manual pages
640	for more information. The arpbalance feature of carp(4) is currently
641	not supported anymore.
642
643	Size of struct in_aliasreq, struct in6_aliasreq has changed. User
644	utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
645	need to be recompiled.
646
64720111122:
648	The acpi_wmi(4) status device /dev/wmistat has been renamed to
649	/dev/wmistat0.
650
65120111108:
652	The option VFS_ALLOW_NONMPSAFE option has been added in order to
653	explicitely support non-MPSAFE filesystems.
654	It is on by default for all supported platform at this present
655	time.
656
65720111101:
658	The broken amd(4) driver has been replaced with esp(4) in the amd64,
659	i386 and pc98 GENERIC kernel configuration files.
660
66120110930:
662	sysinstall has been removed
663
66420110923:
665	The stable/9 branch created in subversion.  This corresponds to the
666	RELENG_9 branch in CVS.
667
668COMMON ITEMS:
669
670	General Notes
671	-------------
672	Avoid using make -j when upgrading.  While generally safe, there are
673	sometimes problems using -j to upgrade.  If your upgrade fails with
674	-j, please try again without -j.  From time to time in the past there
675	have been problems using -j with buildworld and/or installworld.  This
676	is especially true when upgrading between "distant" versions (eg one
677	that cross a major release boundary or several minor releases, or when
678	several months have passed on the -current branch).
679
680	Sometimes, obscure build problems are the result of environment
681	poisoning.  This can happen because the make utility reads its
682	environment when searching for values for global variables.  To run
683	your build attempts in an "environmental clean room", prefix all make
684	commands with 'env -i '.  See the env(1) manual page for more details.
685
686	When upgrading from one major version to another it is generally best
687	to upgrade to the latest code in the currently installed branch first,
688	then do an upgrade to the new branch. This is the best-tested upgrade
689	path, and has the highest probability of being successful.  Please try
690	this approach before reporting problems with a major version upgrade.
691
692	When upgrading a live system, having a root shell around before
693	installing anything can help undo problems. Not having a root shell
694	around can lead to problems if pam has changed too much from your
695	starting point to allow continued authentication after the upgrade.
696
697	ZFS notes
698	---------
699	When upgrading the boot ZFS pool to a new version, always follow
700	these two steps:
701
702	1.) recompile and reinstall the ZFS boot loader and boot block
703	(this is part of "make buildworld" and "make installworld")
704
705	2.) update the ZFS boot block on your boot drive
706
707	The following example updates the ZFS boot block on the first
708	partition (freebsd-boot) of a GPT partitioned drive ad0:
709	"gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
710
711	Non-boot pools do not need these updates.
712
713	To build a kernel
714	-----------------
715	If you are updating from a prior version of FreeBSD (even one just
716	a few days old), you should follow this procedure.  It is the most
717	failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
718
719	make kernel-toolchain
720	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
721	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
722
723	To test a kernel once
724	---------------------
725	If you just want to boot a kernel once (because you are not sure
726	if it works, or if you want to boot a known bad kernel to provide
727	debugging information) run
728	make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
729	nextboot -k testkernel
730
731	To just build a kernel when you know that it won't mess you up
732	--------------------------------------------------------------
733	This assumes you are already running a CURRENT system.  Replace
734	${arch} with the architecture of your machine (e.g. "i386",
735	"arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
736
737	cd src/sys/${arch}/conf
738	config KERNEL_NAME_HERE
739	cd ../compile/KERNEL_NAME_HERE
740	make depend
741	make
742	make install
743
744	If this fails, go to the "To build a kernel" section.
745
746	To rebuild everything and install it on the current system.
747	-----------------------------------------------------------
748	# Note: sometimes if you are running current you gotta do more than
749	# is listed here if you are upgrading from a really old current.
750
751	<make sure you have good level 0 dumps>
752	make buildworld
753	make kernel KERNCONF=YOUR_KERNEL_HERE
754							[1]
755	<reboot in single user>				[3]
756	mergemaster -Fp					[5]
757	make installworld
758	mergemaster -Fi					[4]
759	make delete-old					[6]
760	<reboot>
761
762	To cross-install current onto a separate partition
763	--------------------------------------------------
764	# In this approach we use a separate partition to hold
765	# current's root, 'usr', and 'var' directories.   A partition
766	# holding "/", "/usr" and "/var" should be about 2GB in
767	# size.
768
769	<make sure you have good level 0 dumps>
770	<boot into -stable>
771	make buildworld
772	make buildkernel KERNCONF=YOUR_KERNEL_HERE
773	<maybe newfs current's root partition>
774	<mount current's root partition on directory ${CURRENT_ROOT}>
775	make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
776	make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
777	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
778	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
779	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
780	<reboot into current>
781	<do a "native" rebuild/install as described in the previous section>
782	<maybe install compatibility libraries from ports/misc/compat*>
783	<reboot>
784
785
786	To upgrade in-place from stable to current
787	----------------------------------------------
788	<make sure you have good level 0 dumps>
789	make buildworld					[9]
790	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
791							[1]
792	<reboot in single user>				[3]
793	mergemaster -Fp					[5]
794	make installworld
795	mergemaster -Fi					[4]
796	make delete-old					[6]
797	<reboot>
798
799	Make sure that you've read the UPDATING file to understand the
800	tweaks to various things you need.  At this point in the life
801	cycle of current, things change often and you are on your own
802	to cope.  The defaults can also change, so please read ALL of
803	the UPDATING entries.
804
805	Also, if you are tracking -current, you must be subscribed to
806	freebsd-current@freebsd.org.  Make sure that before you update
807	your sources that you have read and understood all the recent
808	messages there.  If in doubt, please track -stable which has
809	much fewer pitfalls.
810
811	[1] If you have third party modules, such as vmware, you
812	should disable them at this point so they don't crash your
813	system on reboot.
814
815	[3] From the bootblocks, boot -s, and then do
816		fsck -p
817		mount -u /
818		mount -a
819		cd src
820		adjkerntz -i		# if CMOS is wall time
821	Also, when doing a major release upgrade, it is required that
822	you boot into single user mode to do the installworld.
823
824	[4] Note: This step is non-optional.  Failure to do this step
825	can result in a significant reduction in the functionality of the
826	system.  Attempting to do it by hand is not recommended and those
827	that pursue this avenue should read this file carefully, as well
828	as the archives of freebsd-current and freebsd-hackers mailing lists
829	for potential gotchas.  The -U option is also useful to consider.
830	See mergemaster(8) for more information.
831
832	[5] Usually this step is a noop.  However, from time to time
833	you may need to do this if you get unknown user in the following
834	step.  It never hurts to do it all the time.  You may need to
835	install a new mergemaster (cd src/usr.sbin/mergemaster && make
836	install) after the buildworld before this step if you last updated
837	from current before 20130425 or from -stable before 20130430.
838
839	[6] This only deletes old files and directories. Old libraries
840	can be deleted by "make delete-old-libs", but you have to make
841	sure that no program is using those libraries anymore.
842
843	[8] In order to have a kernel that can run the 4.x binaries needed to
844	do an installworld, you must include the COMPAT_FREEBSD4 option in
845	your kernel.  Failure to do so may leave you with a system that is
846	hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
847	required to run the 5.x binaries on more recent kernels.  And so on
848	for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
849
850	Make sure that you merge any new devices from GENERIC since the
851	last time you updated your kernel config file.
852
853	[9] When checking out sources, you must include the -P flag to have
854	cvs prune empty directories.
855
856	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
857	"?=" instead of the "=" assignment operator, so that buildworld can
858	override the CPUTYPE if it needs to.
859
860	MAKEOBJDIRPREFIX must be defined in an environment variable, and
861	not on the command line, or in /etc/make.conf.  buildworld will
862	warn if it is improperly defined.
863FORMAT:
864
865This file contains a list, in reverse chronological order, of major
866breakages in tracking -current.  It is not guaranteed to be a complete
867list of such breakages, and only contains entries since October 10, 2007.
868If you need to see UPDATING entries from before that date, you will need
869to fetch an UPDATING file from an older FreeBSD release.
870
871Copyright information:
872
873Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
874
875Redistribution, publication, translation and use, with or without
876modification, in full or in part, in any form or format of this
877document are permitted without further permission from the author.
878
879THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
880IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
881WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
882DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
883INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
884(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
885SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
886HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
887STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
888IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
889POSSIBILITY OF SUCH DAMAGE.
890
891Contact Warner Losh if you have any questions about your use of
892this document.
893
894$FreeBSD$
895