MFhead @ r286584
[freebsd.git] / UPDATING
1 Updating Information for FreeBSD current users.
2
3 This file is maintained and copyrighted by M. Warner Losh <imp@freebsd.org>.
4 See end of file for further details.  For commonly done items, please see the
5 COMMON ITEMS: section later in the file.  These instructions assume that you
6 basically know what you are doing.  If not, then please consult the FreeBSD
7 handbook:
8
9     http://www.freebsd.org/doc/en_US.ISO8859-1/books/handbook/makeworld.html
10
11 Items affecting the ports and packages system can be found in
12 /usr/ports/UPDATING.  Please read that file before running portupgrade.
13
14 NOTE: FreeBSD has switched from gcc to clang. If you have trouble bootstrapping
15 from older versions of FreeBSD, try WITHOUT_CLANG and WITH_GCC to bootstrap to
16 the tip of head, and then rebuild without this option. The bootstrap process from
17 older version of current across the gcc/clang cutover is a bit fragile.
18
19 NOTE 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
34 20150809:
35         The default group assigned to /dev/dri entries has been changed
36         from 'wheel' to 'video' with the id of '44'. If you want to have
37         access to the dri devices please add yourself to the video group
38         with:
39
40         # pw groupmod video -m $USER
41
42 20150806:
43         The menu.rc and loader.rc files will now be replaced during 
44         upgrades. Please migrate local changes to menu.rc.local and
45         loader.rc.local instead.
46
47 20150805:
48         GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
49         strings and strip have been removed. The src.conf(5) knob
50         WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
51
52 20150728:
53         As ZFS requires more kernel stack pages than is the default on some
54         architectures e.g. i386, it now warns if KSTACK_PAGES is less than
55         ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
56
57         Please consider using 'options KSTACK_PAGES=X' where X is greater
58         than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
59
60 20150706:
61         sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
62         and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
63         default, i.e., they will not contain "::".  For example, instead
64         of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
65         to have a more specific match, such as different map entries for
66         IPv6:0:0 vs IPv6:0.  This change requires that configuration
67         data (including maps, files, classes, custom ruleset, etc.) must
68         use the same format, so make certain such configuration data is
69         upgrading.  As a very simple check search for patterns like
70         'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
71         behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
72         the cf option UseCompressedIPv6Addresses.
73
74 20150630:
75         The default kernel entropy-processing algorithm is now
76         Fortuna, replacing Yarrow.
77
78         Assuming you have 'device random' in your kernel config
79         file, the configurations allow a kernel option to override
80         this default. You may choose *ONE* of:
81
82         options RANDOM_YARROW   # Legacy /dev/random algorithm.
83         options RANDOM_DUMMY    # Blocking-only driver.
84
85         If you have neither, you get Fortuna.  For most people,
86         read no further, Fortuna will give a /dev/random that works
87         like it always used to, and the difference will be irrelevant.
88
89         If you remove 'device random', you get *NO* kernel-processed
90         entopy at all. This may be acceptable to folks building
91         embedded systems, but has complications. Carry on reading,
92         and it is assumed you know what you need.
93
94         *PLEASE* read random(4) and random(9) if you are in the
95         habit of tweeking kernel configs, and/or if you are a member
96         of the embedded community, wanting specific and not-usual
97         behaviour from your security subsystems.
98
99         NOTE!! If you use RANDOM_DUMMY and/or have no 'device
100         random', you will NOT have a functioning /dev/random, and
101         many cryptographic features will not work, including SSH.
102         You may also find strange behaviour from the random(3) set
103         of library functions, in particular sranddev(3), srandomdev(3)
104         and arc4random(3). The reason for this is that the KERN_ARND
105         sysctl only returns entropy if it thinks it has some to
106         share, and with RANDOM_DUMMY or no 'device random' this
107         will never happen.
108
109 20150623:
110         An additional fix for the issue described in the 20150614 sendmail
111         entry below has been been committed in revision 284717.
112
113 20150616:
114         FreeBSD's old make (fmake) has been removed from the system. It is
115         available as the devel/fmake port or via pkg install fmake.
116
117 20150615:
118         The fix for the issue described in the 20150614 sendmail entry
119         below has been been committed in revision 284436.  The work
120         around described in that entry is no longer needed unless the
121         default setting is overridden by a confDH_PARAMETERS configuration
122         setting of '5' or pointing to a 512 bit DH parameter file.
123
124 20150614:
125         ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
126         atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
127         and devel/kyua to version 0.20+ and adjust any calling code to work
128         with Kyuafile and kyua.
129
130 20150614:
131         The import of openssl to address the FreeBSD-SA-15:10.openssl
132         security advisory includes a change which rejects handshakes
133         with DH parameters below 768 bits.  sendmail releases prior
134         to 8.15.2 (not yet released), defaulted to a 512 bit
135         DH parameter setting for client connections.  To work around
136         this interoperability, sendmail can be configured to use a
137         2048 bit DH parameter by:
138
139         1. Edit /etc/mail/`hostname`.mc
140         2. If a setting for confDH_PARAMETERS does not exist or
141            exists and is set to a string beginning with '5',
142            replace it with '2'.
143         3. If a setting for confDH_PARAMETERS exists and is set to
144            a file path, create a new file with:
145                 openssl dhparam -out /path/to/file 2048
146         4. Rebuild the .cf file:
147                 cd /etc/mail/; make; make install
148         5. Restart sendmail:
149                 cd /etc/mail/; make restart
150
151         A sendmail patch is coming, at which time this file will be
152         updated.
153
154 20150604:
155         Generation of legacy formatted entries have been disabled by default
156         in pwd_mkdb(8), as all base system consumers of the legacy formatted
157         entries were converted to use the new format by default when the new,
158         machine independent format have been added and supported since FreeBSD
159         5.x.
160
161         Please see the pwd_mkdb(8) manual page for further details.
162
163 20150525:
164         Clang and llvm have been upgraded to 3.6.1 release.  Please see the
165         20141231 entry below for information about prerequisites and upgrading,
166         if you are not already using 3.5.0 or higher.
167
168 20150521:
169         TI platform code switched to using vendor DTS files and this update
170         may break existing systems running on Beaglebone, Beaglebone Black,
171         and Pandaboard:
172
173         - dtb files should be regenerated/reinstalled. Filenames are the
174           same but content is different now
175         - GPIO addressing was changed, now each GPIO bank (32 pins per bank)
176           has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
177           addressing scheme is now pin 25 on /dev/gpioc3.
178         - Pandaboard: /etc/ttys should be updated, serial console device is
179           now /dev/ttyu2, not /dev/ttyu0
180
181 20150501:
182         soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
183         If you need the GNU extension from groff soelim(1), install groff
184         from package: pkg install groff, or via ports: textproc/groff.
185
186 20150423:
187         chmod, chflags, chown and chgrp now affect symlinks in -R mode as
188         defined in symlink(7); previously symlinks were silently ignored.
189
190 20150415:
191         The const qualifier has been removed from iconv(3) to comply with
192         POSIX.  The ports tree is aware of this from r384038 onwards.
193
194 20150416:
195         Libraries specified by LIBADD in Makefiles must have a corresponding
196         DPADD_<lib> variable to ensure correct dependencies.  This is now
197         enforced in src.libnames.mk.
198
199 20150324:
200         From legacy ata(4) driver was removed support for SATA controllers
201         supported by more functional drivers ahci(4), siis(4) and mvs(4).
202         Kernel modules ataahci and ataadaptec were removed completely,
203         replaced by ahci and mvs modules respectively.
204
205 20150315:
206         Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
207         the 20141231 entry below for information about prerequisites and
208         upgrading, if you are not already using 3.5.0 or higher.
209
210 20150307:
211         The 32-bit PowerPC kernel has been changed to a position-independent
212         executable. This can only be booted with a version of loader(8)
213         newer than January 31, 2015, so make sure to update both world and
214         kernel before rebooting.
215
216 20150217:
217         If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
218         but before r278950, the RNG was not seeded properly.  Immediately
219         upgrade the kernel to r278950 or later and regenerate any keys (e.g.
220         ssh keys or openssl keys) that were generated w/ a kernel from that
221         range.  This does not affect programs that directly used /dev/random
222         or /dev/urandom.  All userland uses of arc4random(3) are affected.
223
224 20150210:
225         The autofs(4) ABI was changed in order to restore binary compatibility
226         with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
227         with the new kernel.
228
229 20150131:
230         The powerpc64 kernel has been changed to a position-independent
231         executable. This can only be booted with a new version of loader(8),
232         so make sure to update both world and kernel before rebooting.
233
234 20150118:
235         Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
236         only release, no new features have been added.  Please see the 20141231
237         entry below for information about prerequisites and upgrading, if you
238         are not already using 3.5.0.
239
240 20150107:
241         ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
242         taken from the ELF Tool Chain project rather than GNU binutils. They
243         should be drop-in replacements, with the addition of arm64 support.
244         The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
245         binutils tools, if necessary. See 20150805 for updated information.
246
247 20150105:
248         The default Unbound configuration now enables remote control
249         using a local socket.  Users who have already enabled the
250         local_unbound service should regenerate their configuration
251         by running "service local_unbound setup" as root.
252
253 20150102:
254         The GNU texinfo and GNU info pages have been removed.
255         To be able to view GNU info pages please install texinfo from ports.
256
257 20141231:
258         Clang, llvm and lldb have been upgraded to 3.5.0 release.
259
260         As of this release, a prerequisite for building clang, llvm and lldb is
261         a C++11 capable compiler and C++11 standard library.  This means that to
262         be able to successfully build the cross-tools stage of buildworld, with
263         clang as the bootstrap compiler, your system compiler or cross compiler
264         should either be clang 3.3 or later, or gcc 4.8 or later, and your
265         system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
266         later.
267
268         On any standard FreeBSD 10.x or 11.x installation, where clang and
269         libc++ are on by default (that is, on x86 or arm), this should work out
270         of the box.
271
272         On 9.x installations where clang is enabled by default, e.g. on x86 and
273         powerpc, libc++ will not be enabled by default, so libc++ should be
274         built (with clang) and installed first.  If both clang and libc++ are
275         missing, build clang first, then use it to build libc++.
276
277         On 8.x and earlier installations, upgrade to 9.x first, and then follow
278         the instructions for 9.x above.
279
280         Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
281         default, and do not build clang.
282
283         Many embedded systems are resource constrained, and will not be able to
284         build clang in a reasonable time, or in some cases at all.  In those
285         cases, cross building bootable systems on amd64 is a workaround.
286
287         This new version of clang introduces a number of new warnings, of which
288         the following are most likely to appear:
289
290         -Wabsolute-value
291
292         This warns in two cases, for both C and C++:
293         * When the code is trying to take the absolute value of an unsigned
294           quantity, which is effectively a no-op, and almost never what was
295           intended.  The code should be fixed, if at all possible.  If you are
296           sure that the unsigned quantity can be safely cast to signed, without
297           loss of information or undefined behavior, you can add an explicit
298           cast, or disable the warning.
299
300         * When the code is trying to take an absolute value, but the called
301           abs() variant is for the wrong type, which can lead to truncation.
302           If you want to disable the warning instead of fixing the code, please
303           make sure that truncation will not occur, or it might lead to unwanted
304           side-effects.
305
306         -Wtautological-undefined-compare and
307         -Wundefined-bool-conversion
308
309         These warn when C++ code is trying to compare 'this' against NULL, while
310         'this' should never be NULL in well-defined C++ code.  However, there is
311         some legacy (pre C++11) code out there, which actively abuses this
312         feature, which was less strictly defined in previous C++ versions.
313
314         Squid and openjdk do this, for example.  The warning can be turned off
315         for C++98 and earlier, but compiling the code in C++11 mode might result
316         in unexpected behavior; for example, the parts of the program that are
317         unreachable could be optimized away.
318
319 20141222:
320         The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
321         kernel sources have been removed. The .h files remain, since some
322         utilities include them. This will need to be fixed later.
323         If "mount -t oldnfs ..." is attempted, it will fail.
324         If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
325         the utilities will report errors.
326
327 20141121:
328         The handling of LOCAL_LIB_DIRS has been altered to skip addition of
329         directories to top level SUBDIR variable when their parent
330         directory is included in LOCAL_DIRS.  Users with build systems with
331         such hierarchies and without SUBDIR entries in the parent
332         directory Makefiles should add them or add the directories to
333         LOCAL_DIRS.
334
335 20141109:
336         faith(4) and faithd(8) have been removed from the base system. Faith
337         has been obsolete for a very long time.
338
339 20141104:
340         vt(4), the new console driver, is enabled by default. It brings
341         support for Unicode and double-width characters, as well as
342         support for UEFI and integration with the KMS kernel video
343         drivers.
344
345         You may need to update your console settings in /etc/rc.conf,
346         most probably the keymap. During boot, /etc/rc.d/syscons will
347         indicate what you need to do.
348
349         vt(4) still has issues and lacks some features compared to
350         syscons(4). See the wiki for up-to-date information:
351           https://wiki.freebsd.org/Newcons
352
353         If you want to keep using syscons(4), you can do so by adding
354         the following line to /boot/loader.conf:
355           kern.vty=sc
356
357 20141102:
358         pjdfstest has been integrated into kyua as an opt-in test suite.
359         Please see share/doc/pjdfstest/README for more details on how to
360         execute it.
361
362 20141009:
363         gperf has been removed from the base system for architectures
364         that use clang. Ports that require gperf will obtain it from the
365         devel/gperf port.
366
367 20140923:
368         pjdfstest has been moved from tools/regression/pjdfstest to
369         contrib/pjdfstest .
370
371 20140922:
372         At svn r271982, The default linux compat kernel ABI has been adjusted
373         to 2.6.18 in support of the linux-c6 compat ports infrastructure
374         update.  If you wish to continue using the linux-f10 compat ports,
375         add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
376         encouraged to update their linux-compat packages to linux-c6 during
377         their next update cycle.
378
379 20140729:
380         The ofwfb driver, used to provide a graphics console on PowerPC when
381         using vt(4), no longer allows mmap() of all physical memory. This
382         will prevent Xorg on PowerPC with some ATI graphics cards from
383         initializing properly unless x11-servers/xorg-server is updated to
384         1.12.4_8 or newer.
385
386 20140723:
387         The xdev targets have been converted to using TARGET and
388         TARGET_ARCH instead of XDEV and XDEV_ARCH.
389
390 20140719:
391         The default unbound configuration has been modified to address
392         issues with reverse lookups on networks that use private
393         address ranges.  If you use the local_unbound service, run
394         "service local_unbound setup" as root to regenerate your
395         configuration, then "service local_unbound reload" to load the
396         new configuration.
397
398 20140709:
399         The GNU texinfo and GNU info pages are not built and installed
400         anymore, WITH_INFO knob has been added to allow to built and install
401         them again.
402         UPDATE: see 20150102 entry on texinfo's removal
403
404 20140708:
405         The GNU readline library is now an INTERNALLIB - that is, it is
406         statically linked into consumers (GDB and variants) in the base
407         system, and the shared library is no longer installed.  The
408         devel/readline port is available for third party software that
409         requires readline.
410
411 20140702:
412         The Itanium architecture (ia64) has been removed from the list of
413         known architectures. This is the first step in the removal of the
414         architecture.
415
416 20140701:
417         Commit r268115 has added NFSv4.1 server support, merged from
418         projects/nfsv4.1-server.  Since this includes changes to the
419         internal interfaces between the NFS related modules, a full
420         build of the kernel and modules will be necessary.
421         __FreeBSD_version has been bumped.
422
423 20140629:
424         The WITHOUT_VT_SUPPORT kernel config knob has been renamed
425         WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
426         which differs from the behaviour controlled by this knob.)
427
428 20140619:
429         Maximal length of the serial number in CTL was increased from 16 to
430         64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
431         and ctld, need to be rebuilt to work with a new kernel.
432
433 20140606:
434         The libatf-c and libatf-c++ major versions were downgraded to 0 and
435         1 respectively to match the upstream numbers.  They were out of
436         sync because, when they were originally added to FreeBSD, the
437         upstream versions were not respected.  These libraries are private
438         and not yet built by default, so renumbering them should be a
439         non-issue.  However, unclean source trees will yield broken test
440         programs once the operator executes "make delete-old-libs" after a
441         "make installworld".
442
443         Additionally, the atf-sh binary was made private by moving it into
444         /usr/libexec/.  Already-built shell test programs will keep the
445         path to the old binary so they will break after "make delete-old"
446         is run.
447
448         If you are using WITH_TESTS=yes (not the default), wipe the object
449         tree and rebuild from scratch to prevent spurious test failures.
450         This is only needed once: the misnumbered libraries and misplaced
451         binaries have been added to OptionalObsoleteFiles.inc so they will
452         be removed during a clean upgrade.
453
454 20140512:
455         Clang and llvm have been upgraded to 3.4.1 release.
456
457 20140508:
458         We bogusly installed src.opts.mk in /usr/share/mk. This file should
459         be removed to avoid issues in the future (and has been added to
460         ObsoleteFiles.inc).
461
462 20140505:
463         /etc/src.conf now affects only builds of the FreeBSD src tree. In the
464         past, it affected all builds that used the bsd.*.mk files. The old
465         behavior was a bug, but people may have relied upon it. To get this
466         behavior back, you can .include /etc/src.conf from /etc/make.conf
467         (which is still global and isn't changed). This also changes the
468         behavior of incremental builds inside the tree of individual
469         directories. Set MAKESYSPATH to ".../share/mk" to do that.
470         Although this has survived make universe and some upgrade scenarios,
471         other upgrade scenarios may have broken. At least one form of
472         temporary breakage was fixed with MAKESYSPATH settings for buildworld
473         as well... In cases where MAKESYSPATH isn't working with this
474         setting, you'll need to set it to the full path to your tree.
475
476         One side effect of all this cleaning up is that bsd.compiler.mk
477         is no longer implicitly included by bsd.own.mk. If you wish to
478         use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
479         as well.
480
481 20140430:
482         The lindev device has been removed since /dev/full has been made a
483         standard device.  __FreeBSD_version has been bumped.
484
485 20140424:
486         The knob WITHOUT_VI was added to the base system, which controls
487         building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
488         in order to reorder files share/termcap and didn't build ex(1) as a
489         build tool, so building/installing with WITH_VI is highly advised for
490         build hosts for older releases.
491
492         This issue has been fixed in stable/9 and stable/10 in r277022 and
493         r276991, respectively.
494
495 20140418:
496         The YES_HESIOD knob has been removed. It has been obsolete for
497         a decade. Please move to using WITH_HESIOD instead or your builds
498         will silently lack HESIOD.
499
500 20140405:
501         The uart(4) driver has been changed with respect to its handling
502         of the low-level console. Previously the uart(4) driver prevented
503         any process from changing the baudrate or the CLOCAL and HUPCL
504         control flags. By removing the restrictions, operators can make
505         changes to the serial console port without having to reboot.
506         However, when getty(8) is started on the serial device that is
507         associated with the low-level console, a misconfigured terminal
508         line in /etc/ttys will now have a real impact.
509         Before upgrading the kernel, make sure that /etc/ttys has the
510         serial console device configured as 3wire without baudrate to
511         preserve the previous behaviour. E.g:
512             ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
513
514 20140306:
515         Support for libwrap (TCP wrappers) in rpcbind was disabled by default
516         to improve performance.  To re-enable it, if needed, run rpcbind
517         with command line option -W.
518
519 20140226:
520         Switched back to the GPL dtc compiler due to updates in the upstream
521         dts files not being supported by the BSDL dtc compiler. You will need
522         to rebuild your kernel toolchain to pick up the new compiler. Core dumps
523         may result while building dtb files during a kernel build if you fail
524         to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
525
526 20140216:
527         Clang and llvm have been upgraded to 3.4 release.
528
529 20140216:
530         The nve(4) driver has been removed.  Please use the nfe(4) driver
531         for NVIDIA nForce MCP Ethernet adapters instead.
532
533 20140212:
534         An ABI incompatibility crept into the libc++ 3.4 import in r261283.
535         This could cause certain C++ applications using shared libraries built
536         against the previous version of libc++ to crash.  The incompatibility
537         has now been fixed, but any C++ applications or shared libraries built
538         between r261283 and r261801 should be recompiled.
539
540 20140204:
541         OpenSSH will now ignore errors caused by kernel lacking of Capsicum
542         capability mode support.  Please note that enabling the feature in
543         kernel is still highly recommended.
544
545 20140131:
546         OpenSSH is now built with sandbox support, and will use sandbox as
547         the default privilege separation method.  This requires Capsicum
548         capability mode support in kernel.
549
550 20140128:
551         The libelf and libdwarf libraries have been updated to newer
552         versions from upstream. Shared library version numbers for
553         these two libraries were bumped. Any ports or binaries
554         requiring these two libraries should be recompiled.
555         __FreeBSD_version is bumped to 1100006.
556
557 20140110:
558         If a Makefile in a tests/ directory was auto-generating a Kyuafile
559         instead of providing an explicit one, this would prevent such
560         Makefile from providing its own Kyuafile in the future during
561         NO_CLEAN builds.  This has been fixed in the Makefiles but manual
562         intervention is needed to clean an objdir if you use NO_CLEAN:
563           # find /usr/obj -name Kyuafile | xargs rm -f
564
565 20131213:
566         The behavior of gss_pseudo_random() for the krb5 mechanism
567         has changed, for applications requesting a longer random string
568         than produced by the underlying enctype's pseudo-random() function.
569         In particular, the random string produced from a session key of
570         enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
571         be different at the 17th octet and later, after this change.
572         The counter used in the PRF+ construction is now encoded as a
573         big-endian integer in accordance with RFC 4402.
574         __FreeBSD_version is bumped to 1100004.
575
576 20131108:
577         The WITHOUT_ATF build knob has been removed and its functionality
578         has been subsumed into the more generic WITHOUT_TESTS.  If you were
579         using the former to disable the build of the ATF libraries, you
580         should change your settings to use the latter.
581
582 20131025:
583         The default version of mtree is nmtree which is obtained from
584         NetBSD.  The output is generally the same, but may vary
585         slightly.  If you found you need identical output adding
586         "-F freebsd9" to the command line should do the trick.  For the
587         time being, the old mtree is available as fmtree.
588
589 20131014:
590         libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
591         This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
592         1.1.4_8 and verify bsdyml not linked in, before running "make
593         delete-old-libs":
594           # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
595           or
596           # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
597
598 20131010:
599         The stable/10 branch has been created in subversion from head
600         revision r256279.
601
602 20131010:
603         The rc.d/jail script has been updated to support jail(8)
604         configuration file.  The "jail_<jname>_*" rc.conf(5) variables
605         for per-jail configuration are automatically converted to
606         /var/run/jail.<jname>.conf before the jail(8) utility is invoked.
607         This is transparently backward compatible.  See below about some
608         incompatibilities and rc.conf(5) manual page for more details.
609
610         These variables are now deprecated in favor of jail(8) configuration
611         file.  One can use "rc.d/jail config <jname>" command to generate
612         a jail(8) configuration file in /var/run/jail.<jname>.conf without
613         running the jail(8) utility.   The default pathname of the
614         configuration file is /etc/jail.conf and can be specified by
615         using $jail_conf or $jail_<jname>_conf variables.
616
617         Please note that jail_devfs_ruleset accepts an integer at
618         this moment.  Please consider to rewrite the ruleset name
619         with an integer.
620
621 20130930:
622         BIND has been removed from the base system.  If all you need
623         is a local resolver, simply enable and start the local_unbound
624         service instead.  Otherwise, several versions of BIND are
625         available in the ports tree.   The dns/bind99 port is one example.
626
627         With this change, nslookup(1) and dig(1) are no longer in the base
628         system.  Users should instead use host(1) and drill(1) which are
629         in the base system.  Alternatively, nslookup and dig can
630         be obtained by installing the dns/bind-tools port.
631
632 20130916:
633         With the addition of unbound(8), a new unbound user is now
634         required during installworld.  "mergemaster -p" can be used to
635         add the user prior to installworld, as documented in the handbook.
636
637 20130911:
638         OpenSSH is now built with DNSSEC support, and will by default
639         silently trust signed SSHFP records.  This can be controlled with
640         the VerifyHostKeyDNS client configuration setting.  DNSSEC support
641         can be disabled entirely with the WITHOUT_LDNS option in src.conf.
642
643 20130906:
644         The GNU Compiler Collection and C++ standard library (libstdc++)
645         are no longer built by default on platforms where clang is the system
646         compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
647         options in src.conf.
648
649 20130905:
650         The PROCDESC kernel option is now part of the GENERIC kernel
651         configuration and is required for the rwhod(8) to work.
652         If you are using custom kernel configuration, you should include
653         'options PROCDESC'.
654
655 20130905:
656         The API and ABI related to the Capsicum framework was modified
657         in backward incompatible way. The userland libraries and programs
658         have to be recompiled to work with the new kernel. This includes the
659         following libraries and programs, but the whole buildworld is
660         advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
661         kdump, procstat, rwho, rwhod, uniq.
662
663 20130903:
664         AES-NI intrinsic support has been added to gcc.  The AES-NI module
665         has been updated to use this support.  A new gcc is required to build
666         the aesni module on both i386 and amd64.
667
668 20130821:
669         The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
670         Thus "device padlock_rng" and "device rdrand_rng" should be
671         used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
672
673 20130813:
674         WITH_ICONV has been split into two feature sets.  WITH_ICONV now
675         enables just the iconv* functionality and is now on by default.
676         WITH_LIBICONV_COMPAT enables the libiconv api and link time
677         compatability.  Set WITHOUT_ICONV to build the old way.
678         If you have been using WITH_ICONV before, you will very likely
679         need to turn on WITH_LIBICONV_COMPAT.
680
681 20130806:
682         INVARIANTS option now enables DEBUG for code with OpenSolaris and
683         Illumos origin, including ZFS.  If you have INVARIANTS in your
684         kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
685         explicitly.
686         DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
687         locks if WITNESS option was set.  Because that generated a lot of
688         witness(9) reports and all of them were believed to be false
689         positives, this is no longer done.  New option OPENSOLARIS_WITNESS
690         can be used to achieve the previous behavior.
691
692 20130806:
693         Timer values in IPv6 data structures now use time_uptime instead
694         of time_second.  Although this is not a user-visible functional
695         change, userland utilities which directly use them---ndp(8),
696         rtadvd(8), and rtsold(8) in the base system---need to be updated
697         to r253970 or later.
698
699 20130802:
700         find -delete can now delete the pathnames given as arguments,
701         instead of only files found below them or if the pathname did
702         not contain any slashes. Formerly, the following error message
703         would result:
704
705         find: -delete: <path>: relative path potentially not safe
706
707         Deleting the pathnames given as arguments can be prevented
708         without error messages using -mindepth 1 or by changing
709         directory and passing "." as argument to find. This works in the
710         old as well as the new version of find.
711
712 20130726:
713         Behavior of devfs rules path matching has been changed.
714         Pattern is now always matched against fully qualified devfs
715         path and slash characters must be explicitly matched by
716         slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
717         subdirectories must be reviewed.
718
719 20130716:
720         The default ARM ABI has changed to the ARM EABI. The old ABI is
721         incompatible with the ARM EABI and all programs and modules will
722         need to be rebuilt to work with a new kernel.
723
724         To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
725
726         NOTE: Support for the old ABI will be removed in the future and
727         users are advised to upgrade.
728
729 20130709:
730         pkg_install has been disconnected from the build if you really need it
731         you should add WITH_PKGTOOLS in your src.conf(5).
732
733 20130709:
734         Most of network statistics structures were changed to be able
735         keep 64-bits counters. Thus all tools, that work with networking
736         statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
737
738 20130629:
739         Fix targets that run multiple make's to use && rather than ;
740         so that subsequent steps depend on success of previous.
741
742         NOTE: if building 'universe' with -j* on stable/8 or stable/9
743         it would be better to start the build using bmake, to avoid
744         overloading the machine.
745
746 20130618:
747         Fix a bug that allowed a tracing process (e.g. gdb) to write
748         to a memory-mapped file in the traced process's address space
749         even if neither the traced process nor the tracing process had
750         write access to that file.
751
752 20130615:
753         CVS has been removed from the base system.  An exact copy
754         of the code is available from the devel/cvs port.
755
756 20130613:
757         Some people report the following error after the switch to bmake:
758
759                 make: illegal option -- J
760                 usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
761                         ...
762                 *** [buildworld] Error code 2
763
764         this likely due to an old instance of make in
765         ${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
766         which src/Makefile will use that blindly, if it exists, so if
767         you see the above error:
768
769                 rm -rf `make -V MAKEPATH`
770
771         should resolve it.
772
773 20130516:
774         Use bmake by default.
775         Whereas before one could choose to build with bmake via
776         -DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
777         make. The goal is to remove these knobs for 10-RELEASE.
778
779         It is worth noting that bmake (like gmake) treats the command
780         line as the unit of failure, rather than statements within the
781         command line.  Thus '(cd some/where && dosomething)' is safer
782         than 'cd some/where; dosomething'. The '()' allows consistent
783         behavior in parallel build.
784
785 20130429:
786         Fix a bug that allows NFS clients to issue READDIR on files.
787
788 20130426:
789         The WITHOUT_IDEA option has been removed because
790         the IDEA patent expired.
791
792 20130426:
793         The sysctl which controls TRIM support under ZFS has been renamed
794         from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
795         enabled by default.
796
797 20130425:
798         The mergemaster command now uses the default MAKEOBJDIRPREFIX
799         rather than creating it's own in the temporary directory in
800         order allow access to bootstrapped versions of tools such as
801         install and mtree.  When upgrading from version of FreeBSD where
802         the install command does not support -l, you will need to
803         install a new mergemaster command if mergemaster -p is required.
804         This can be accomplished with the command (cd src/usr.sbin/mergemaster
805         && make install).
806
807 20130404:
808         Legacy ATA stack, disabled and replaced by new CAM-based one since
809         FreeBSD 9.0, completely removed from the sources.  Kernel modules
810         atadisk and atapi*, user-level tools atacontrol and burncd are
811         removed.  Kernel option `options ATA_CAM` is now permanently enabled
812         and removed.
813
814 20130319:
815         SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
816         and socketpair(2). Software, in particular Kerberos, may
817         automatically detect and use these during building. The resulting
818         binaries will not work on older kernels.
819
820 20130308:
821         CTL_DISABLE has also been added to the sparc64 GENERIC (for further
822         information, see the respective 20130304 entry).
823
824 20130304:
825         Recent commits to callout(9) changed the size of struct callout,
826         so the KBI is probably heavily disturbed. Also, some functions
827         in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
828         by macros. Every kernel module using it won't load, so rebuild
829         is requested.
830
831         The ctl device has been re-enabled in GENERIC for i386 and amd64,
832         but does not initialize by default (because of the new CTL_DISABLE
833         option) to save memory.  To re-enable it, remove the CTL_DISABLE
834         option from the kernel config file or set kern.cam.ctl.disable=0
835         in /boot/loader.conf.
836
837 20130301:
838         The ctl device has been disabled in GENERIC for i386 and amd64.
839         This was done due to the extra memory being allocated at system
840         initialisation time by the ctl driver which was only used if
841         a CAM target device was created.  This makes a FreeBSD system
842         unusable on 128MB or less of RAM.
843
844 20130208:
845         A new compression method (lz4) has been merged to -HEAD.  Please
846         refer to zpool-features(7) for more information.
847
848         Please refer to the "ZFS notes" section of this file for information
849         on upgrading boot ZFS pools.
850
851 20130129:
852         A BSD-licensed patch(1) variant has been added and is installed
853         as bsdpatch, being the GNU version the default patch.
854         To inverse the logic and use the BSD-licensed one as default,
855         while having the GNU version installed as gnupatch, rebuild
856         and install world with the WITH_BSD_PATCH knob set.
857
858 20130121:
859         Due to the use of the new -l option to install(1) during build
860         and install, you must take care not to directly set the INSTALL
861         make variable in your /etc/make.conf, /etc/src.conf, or on the
862         command line.  If you wish to use the -C flag for all installs
863         you may be able to add INSTALL+=-C to /etc/make.conf or
864         /etc/src.conf.
865
866 20130118:
867         The install(1) option -M has changed meaning and now takes an
868         argument that is a file or path to append logs to.  In the
869         unlikely event that -M was the last option on the command line
870         and the command line contained at least two files and a target
871         directory the first file will have logs appended to it.  The -M
872         option served little practical purpose in the last decade so its
873         use is expected to be extremely rare.
874
875 20121223:
876         After switching to Clang as the default compiler some users of ZFS
877         on i386 systems started to experience stack overflow kernel panics.
878         Please consider using 'options KSTACK_PAGES=4' in such configurations.
879
880 20121222:
881         GEOM_LABEL now mangles label names read from file system metadata.
882         Mangling affect labels containing spaces, non-printable characters,
883         '%' or '"'. Device names in /etc/fstab and other places may need to
884         be updated.
885
886 20121217:
887         By default, only the 10 most recent kernel dumps will be saved.  To
888         restore the previous behaviour (no limit on the number of kernel dumps
889         stored in the dump directory) add the following line to /etc/rc.conf:
890
891                 savecore_flags=""
892
893 20121201:
894         With the addition of auditdistd(8), a new auditdistd user is now
895         required during installworld.  "mergemaster -p" can be used to
896         add the user prior to installworld, as documented in the handbook.
897
898 20121117:
899         The sin6_scope_id member variable in struct sockaddr_in6 is now
900         filled by the kernel before passing the structure to the userland via
901         sysctl or routing socket.  This means the KAME-specific embedded scope
902         id in sin6_addr.s6_addr[2] is always cleared in userland application.
903         This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
904         __FreeBSD_version is bumped to 1000025.
905
906 20121105:
907         On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
908         This means that the world and kernel will be compiled with clang
909         and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
910         and /usr/bin/cpp.  To disable this behavior and revert to building
911         with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
912         of current may need to bootstrap WITHOUT_CLANG first if the clang
913         build fails (its compatibility window doesn't extend to the 9 stable
914         branch point).
915
916 20121102:
917         The IPFIREWALL_FORWARD kernel option has been removed. Its
918         functionality now turned on by default.
919
920 20121023:
921         The ZERO_COPY_SOCKET kernel option has been removed and
922         split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
923         NB: SOCKET_SEND_COW uses the VM page based copy-on-write
924         mechanism which is not safe and may result in kernel crashes.
925         NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
926         driver supports disposeable external page sized mbuf storage.
927         Proper replacements for both zero-copy mechanisms are under
928         consideration and will eventually lead to complete removal
929         of the two kernel options.
930
931 20121023:
932         The IPv4 network stack has been converted to network byte
933         order. The following modules need to be recompiled together
934         with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
935         pf(4), ipfw(4), ng_ipfw(4), stf(4).
936
937 20121022:
938         Support for non-MPSAFE filesystems was removed from VFS. The
939         VFS_VERSION was bumped, all filesystem modules shall be
940         recompiled.
941
942 20121018:
943         All the non-MPSAFE filesystems have been disconnected from
944         the build. The full list includes: codafs, hpfs, ntfs, nwfs,
945         portalfs, smbfs, xfs.
946
947 20121016:
948         The interface cloning API and ABI has changed. The following
949         modules need to be recompiled together with kernel:
950         ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
951         vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
952         faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
953
954 20121015:
955         The sdhci driver was split in two parts: sdhci (generic SD Host
956         Controller logic) and sdhci_pci (actual hardware driver).
957         No kernel config modifications are required, but if you
958         load sdhc as a module you must switch to sdhci_pci instead.
959
960 20121014:
961         Import the FUSE kernel and userland support into base system.
962
963 20121013:
964         The GNU sort(1) program has been removed since the BSD-licensed
965         sort(1) has been the default for quite some time and no serious
966         problems have been reported.  The corresponding WITH_GNU_SORT
967         knob has also gone.
968
969 20121006:
970         The pfil(9) API/ABI for AF_INET family has been changed. Packet
971         filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
972         with new kernel.
973
974 20121001:
975         The net80211(4) ABI has been changed to allow for improved driver
976         PS-POLL and power-save support.  All wireless drivers need to be
977         recompiled to work with the new kernel.
978
979 20120913:
980         The random(4) support for the VIA hardware random number
981         generator (`PADLOCK') is no longer enabled unconditionally.
982         Add the padlock_rng device in the custom kernel config if
983         needed.  The GENERIC kernels on i386 and amd64 do include the
984         device, so the change only affects the custom kernel
985         configurations.
986
987 20120908:
988         The pf(4) packet filter ABI has been changed. pfctl(8) and
989         snmp_pf module need to be recompiled to work with new kernel.
990
991 20120828:
992         A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
993         to -HEAD. Pools that have empty_bpobj in active state can not be
994         imported read-write with ZFS implementations that do not support
995         this feature. For more information read the zpool-features(5)
996         manual page.
997
998 20120727:
999         The sparc64 ZFS loader has been changed to no longer try to auto-
1000         detect ZFS providers based on diskN aliases but now requires these
1001         to be explicitly listed in the OFW boot-device environment variable.
1002
1003 20120712:
1004         The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
1005         libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
1006         configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
1007
1008 20120712:
1009         The following sysctls and tunables have been renamed for consistency
1010         with other variables:
1011           kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
1012           kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
1013
1014 20120628:
1015         The sort utility has been replaced with BSD sort.  For now, GNU sort
1016         is also available as "gnusort" or the default can be set back to
1017         GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
1018         installed as "bsdsort".
1019
1020 20120611:
1021         A new version of ZFS (pool version 5000) has been merged to -HEAD.
1022         Starting with this version the old system of ZFS pool versioning
1023         is superseded by "feature flags". This concept enables forward
1024         compatibility against certain future changes in functionality of ZFS
1025         pools. The first read-only compatible "feature flag" for ZFS pools
1026         is named "com.delphix:async_destroy". For more information
1027         read the new zpool-features(5) manual page.
1028         Please refer to the "ZFS notes" section of this file for information
1029         on upgrading boot ZFS pools.
1030
1031 20120417:
1032         The malloc(3) implementation embedded in libc now uses sources imported
1033         as contrib/jemalloc.  The most disruptive API change is to
1034         /etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
1035         delete it prior to installworld, and optionally re-create it using the
1036         new format after rebooting.  See malloc.conf(5) for details
1037         (specifically the TUNING section and the "opt.*" entries in the MALLCTL
1038         NAMESPACE section).
1039
1040 20120328:
1041         Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
1042         is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
1043         now spelled mips.  This is to aid compatibility with third-party
1044         software that expects this naming scheme in uname(3).  Little-endian
1045         settings are unchanged. If you are updating a big-endian mips64 machine
1046         from before this change, you may need to set MACHINE_ARCH=mips64 in
1047         your environment before the new build system will recognize your machine.
1048
1049 20120306:
1050         Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
1051         platforms.
1052
1053 20120229:
1054         Now unix domain sockets behave "as expected" on nullfs(5). Previously
1055         nullfs(5) did not pass through all behaviours to the underlying layer,
1056         as a result if we bound to a socket on the lower layer we could connect
1057         only to the lower path; if we bound to the upper layer we could connect
1058         only to the upper path. The new behavior is one can connect to both the
1059         lower and the upper paths regardless what layer path one binds to.
1060
1061 20120211:
1062         The getifaddrs upgrade path broken with 20111215 has been restored.
1063         If you have upgraded in between 20111215 and 20120209 you need to
1064         recompile libc again with your kernel.  You still need to recompile
1065         world to be able to configure CARP but this restriction already
1066         comes from 20111215.
1067
1068 20120114:
1069         The set_rcvar() function has been removed from /etc/rc.subr.  All
1070         base and ports rc.d scripts have been updated, so if you have a
1071         port installed with a script in /usr/local/etc/rc.d you can either
1072         hand-edit the rcvar= line, or reinstall the port.
1073
1074         An easy way to handle the mass-update of /etc/rc.d:
1075         rm /etc/rc.d/* && mergemaster -i
1076
1077 20120109:
1078         panic(9) now stops other CPUs in the SMP systems, disables interrupts
1079         on the current CPU and prevents other threads from running.
1080         This behavior can be reverted using the kern.stop_scheduler_on_panic
1081         tunable/sysctl.
1082         The new behavior can be incompatible with kern.sync_on_panic.
1083
1084 20111215:
1085         The carp(4) facility has been changed significantly. Configuration
1086         of the CARP protocol via ifconfig(8) has changed, as well as format
1087         of CARP events submitted to devd(8) has changed. See manual pages
1088         for more information. The arpbalance feature of carp(4) is currently
1089         not supported anymore.
1090
1091         Size of struct in_aliasreq, struct in6_aliasreq has changed. User
1092         utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
1093         need to be recompiled.
1094
1095 20111122:
1096         The acpi_wmi(4) status device /dev/wmistat has been renamed to
1097         /dev/wmistat0.
1098
1099 20111108:
1100         The option VFS_ALLOW_NONMPSAFE option has been added in order to
1101         explicitely support non-MPSAFE filesystems.
1102         It is on by default for all supported platform at this present
1103         time.
1104
1105 20111101:
1106         The broken amd(4) driver has been replaced with esp(4) in the amd64,
1107         i386 and pc98 GENERIC kernel configuration files.
1108
1109 20110930:
1110         sysinstall has been removed
1111
1112 20110923:
1113         The stable/9 branch created in subversion.  This corresponds to the
1114         RELENG_9 branch in CVS.
1115
1116 COMMON ITEMS:
1117
1118         General Notes
1119         -------------
1120         Avoid using make -j when upgrading.  While generally safe, there are
1121         sometimes problems using -j to upgrade.  If your upgrade fails with
1122         -j, please try again without -j.  From time to time in the past there
1123         have been problems using -j with buildworld and/or installworld.  This
1124         is especially true when upgrading between "distant" versions (eg one
1125         that cross a major release boundary or several minor releases, or when
1126         several months have passed on the -current branch).
1127
1128         Sometimes, obscure build problems are the result of environment
1129         poisoning.  This can happen because the make utility reads its
1130         environment when searching for values for global variables.  To run
1131         your build attempts in an "environmental clean room", prefix all make
1132         commands with 'env -i '.  See the env(1) manual page for more details.
1133
1134         When upgrading from one major version to another it is generally best
1135         to upgrade to the latest code in the currently installed branch first,
1136         then do an upgrade to the new branch. This is the best-tested upgrade
1137         path, and has the highest probability of being successful.  Please try
1138         this approach before reporting problems with a major version upgrade.
1139
1140         When upgrading a live system, having a root shell around before
1141         installing anything can help undo problems. Not having a root shell
1142         around can lead to problems if pam has changed too much from your
1143         starting point to allow continued authentication after the upgrade.
1144
1145         This file should be read as a log of events. When a later event changes
1146         information of a prior event, the prior event should not be deleted.
1147         Instead, a pointer to the entry with the new information should be
1148         placed in the old entry. Readers of this file should also sanity check
1149         older entries before relying on them blindly. Authors of new entries
1150         should write them with this in mind.
1151
1152         ZFS notes
1153         ---------
1154         When upgrading the boot ZFS pool to a new version, always follow
1155         these two steps:
1156
1157         1.) recompile and reinstall the ZFS boot loader and boot block
1158         (this is part of "make buildworld" and "make installworld")
1159
1160         2.) update the ZFS boot block on your boot drive
1161
1162         The following example updates the ZFS boot block on the first
1163         partition (freebsd-boot) of a GPT partitioned drive ada0:
1164         "gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1165
1166         Non-boot pools do not need these updates.
1167
1168         To build a kernel
1169         -----------------
1170         If you are updating from a prior version of FreeBSD (even one just
1171         a few days old), you should follow this procedure.  It is the most
1172         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1173
1174         make kernel-toolchain
1175         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1176         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1177
1178         To test a kernel once
1179         ---------------------
1180         If you just want to boot a kernel once (because you are not sure
1181         if it works, or if you want to boot a known bad kernel to provide
1182         debugging information) run
1183         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1184         nextboot -k testkernel
1185
1186         To just build a kernel when you know that it won't mess you up
1187         --------------------------------------------------------------
1188         This assumes you are already running a CURRENT system.  Replace
1189         ${arch} with the architecture of your machine (e.g. "i386",
1190         "arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1191
1192         cd src/sys/${arch}/conf
1193         config KERNEL_NAME_HERE
1194         cd ../compile/KERNEL_NAME_HERE
1195         make depend
1196         make
1197         make install
1198
1199         If this fails, go to the "To build a kernel" section.
1200
1201         To rebuild everything and install it on the current system.
1202         -----------------------------------------------------------
1203         # Note: sometimes if you are running current you gotta do more than
1204         # is listed here if you are upgrading from a really old current.
1205
1206         <make sure you have good level 0 dumps>
1207         make buildworld
1208         make kernel KERNCONF=YOUR_KERNEL_HERE
1209                                                         [1]
1210         <reboot in single user>                         [3]
1211         mergemaster -Fp                                 [5]
1212         make installworld
1213         mergemaster -Fi                                 [4]
1214         make delete-old                                 [6]
1215         <reboot>
1216
1217         To cross-install current onto a separate partition
1218         --------------------------------------------------
1219         # In this approach we use a separate partition to hold
1220         # current's root, 'usr', and 'var' directories.   A partition
1221         # holding "/", "/usr" and "/var" should be about 2GB in
1222         # size.
1223
1224         <make sure you have good level 0 dumps>
1225         <boot into -stable>
1226         make buildworld
1227         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1228         <maybe newfs current's root partition>
1229         <mount current's root partition on directory ${CURRENT_ROOT}>
1230         make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1231         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1232         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1233         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1234         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1235         <reboot into current>
1236         <do a "native" rebuild/install as described in the previous section>
1237         <maybe install compatibility libraries from ports/misc/compat*>
1238         <reboot>
1239
1240
1241         To upgrade in-place from stable to current
1242         ----------------------------------------------
1243         <make sure you have good level 0 dumps>
1244         make buildworld                                 [9]
1245         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
1246                                                         [1]
1247         <reboot in single user>                         [3]
1248         mergemaster -Fp                                 [5]
1249         make installworld
1250         mergemaster -Fi                                 [4]
1251         make delete-old                                 [6]
1252         <reboot>
1253
1254         Make sure that you've read the UPDATING file to understand the
1255         tweaks to various things you need.  At this point in the life
1256         cycle of current, things change often and you are on your own
1257         to cope.  The defaults can also change, so please read ALL of
1258         the UPDATING entries.
1259
1260         Also, if you are tracking -current, you must be subscribed to
1261         freebsd-current@freebsd.org.  Make sure that before you update
1262         your sources that you have read and understood all the recent
1263         messages there.  If in doubt, please track -stable which has
1264         much fewer pitfalls.
1265
1266         [1] If you have third party modules, such as vmware, you
1267         should disable them at this point so they don't crash your
1268         system on reboot.
1269
1270         [3] From the bootblocks, boot -s, and then do
1271                 fsck -p
1272                 mount -u /
1273                 mount -a
1274                 cd src
1275                 adjkerntz -i            # if CMOS is wall time
1276         Also, when doing a major release upgrade, it is required that
1277         you boot into single user mode to do the installworld.
1278
1279         [4] Note: This step is non-optional.  Failure to do this step
1280         can result in a significant reduction in the functionality of the
1281         system.  Attempting to do it by hand is not recommended and those
1282         that pursue this avenue should read this file carefully, as well
1283         as the archives of freebsd-current and freebsd-hackers mailing lists
1284         for potential gotchas.  The -U option is also useful to consider.
1285         See mergemaster(8) for more information.
1286
1287         [5] Usually this step is a noop.  However, from time to time
1288         you may need to do this if you get unknown user in the following
1289         step.  It never hurts to do it all the time.  You may need to
1290         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1291         install) after the buildworld before this step if you last updated
1292         from current before 20130425 or from -stable before 20130430.
1293
1294         [6] This only deletes old files and directories. Old libraries
1295         can be deleted by "make delete-old-libs", but you have to make
1296         sure that no program is using those libraries anymore.
1297
1298         [8] In order to have a kernel that can run the 4.x binaries needed to
1299         do an installworld, you must include the COMPAT_FREEBSD4 option in
1300         your kernel.  Failure to do so may leave you with a system that is
1301         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1302         required to run the 5.x binaries on more recent kernels.  And so on
1303         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1304
1305         Make sure that you merge any new devices from GENERIC since the
1306         last time you updated your kernel config file.
1307
1308         [9] When checking out sources, you must include the -P flag to have
1309         cvs prune empty directories.
1310
1311         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1312         "?=" instead of the "=" assignment operator, so that buildworld can
1313         override the CPUTYPE if it needs to.
1314
1315         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1316         not on the command line, or in /etc/make.conf.  buildworld will
1317         warn if it is improperly defined.
1318 FORMAT:
1319
1320 This file contains a list, in reverse chronological order, of major
1321 breakages in tracking -current.  It is not guaranteed to be a complete
1322 list of such breakages, and only contains entries since September 23, 2011.
1323 If you need to see UPDATING entries from before that date, you will need
1324 to fetch an UPDATING file from an older FreeBSD release.
1325
1326 Copyright information:
1327
1328 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1329
1330 Redistribution, publication, translation and use, with or without
1331 modification, in full or in part, in any form or format of this
1332 document are permitted without further permission from the author.
1333
1334 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1335 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1336 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1337 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1338 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1339 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1340 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1341 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1342 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1343 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1344 POSSIBILITY OF SUCH DAMAGE.
1345
1346 Contact Warner Losh if you have any questions about your use of
1347 this document.
1348
1349 $FreeBSD$