]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
Add 'contrib/pnglite/' from commit 'a70c2a23d0d84dfc63a1d9413a7f4aaede7313aa'
[FreeBSD/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     https://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 TO PEOPLE WHO THINK THAT FreeBSD 13.x IS SLOW:
15         FreeBSD 13.x has many debugging features turned on, in both the kernel
16         and userland.  These features attempt to detect incorrect use of
17         system primitives, and encourage loud failure through extra sanity
18         checking and fail stop semantics.  They also substantially impact
19         system performance.  If you want to do performance measurement,
20         benchmarking, and optimization, you'll want to turn them off.  This
21         includes various WITNESS- related kernel options, INVARIANTS, malloc
22         debugging flags in userland, and various verbose features in the
23         kernel.  Many developers choose to disable these features on build
24         machines to maximize performance.  (To completely disable malloc
25         debugging, define WITH_MALLOC_PRODUCTION in /etc/src.conf and rebuild
26         world, or to merely disable the most expensive debugging functionality
27         at runtime, run "ln -s 'abort:false,junk:false' /etc/malloc.conf".)
28
29 20201223:
30         The FreeBSD project has migrated from Subversion to Git. Temporary
31         instructions can be found at
32         https://github.com/bsdimp/freebsd-git-docs/blob/main/src-cvt.md
33         and other documents in that repo.
34
35 20201216:
36         The services database has been updated to cover more of the basic
37         services expected in a modern system. The database is big enough
38         that it will cause issues in mergemaster in Releases previous to
39         12.2 and 11.3, or in very old current systems from before r358154.
40
41 20201215:
42         Obsolete in-tree GDB 6.1.1 has been removed.  GDB (including kgdb)
43         may be installed from ports or packages.
44
45 20201124:
46         ping6 has been merged into ping.  It can now be called as "ping -6".
47         See ping(8) for details.
48
49 20201108:
50         Default value of net.add_addr_allfibs has been changed to 0.
51         If you have multi-fib configuration and rely on existence of all
52         interface routes in every fib, you need to set the above sysctl to 1.
53 20201030:
54         The internal pre-processor in the calendar(1) program has been
55         extended to support more C pre-processor commands (e.g. #ifdef, #else,
56         and #undef) and to detect unbalanced conditional statements.
57         Error messages have been extended to include the filename and line
58         number if processing stops to help fixing malformed data files.
59
60 20201026:
61         All the data files for the calendar(1) program, except calendar.freebsd,
62         have been moved to the deskutils/calendar-data port, much like the
63         jewish calendar entries were moved to deskutils/hebcal years ago. After
64         make delete-old-files, you need to install it to retain full
65         functionality. calendar(1) will issue a reminder for files it can't
66         find.
67
68 20200923:
69         LINT files are no longer generated. We now include the relevant NOTES
70         files. Note: This may cause conflicts with updating in some cases.
71                 find sys -name LINT\* -delete
72         is suggested across this commit to remove the generated LINT files.
73
74         If you have tried to update with generated files there, the svn
75         command you want to un-auger the tree is
76                 cd sys/amd64/conf
77                 svn revert -R .
78         and then do the above find from the top level. Substitute 'amd64'
79         above with where the error message indicates a conflict.
80
81 20200824:
82         OpenZFS support has been integrated. Do not upgrade root pools until
83         the loader is updated to support zstd. Furthermore, we caution against
84         'zpool upgrade' for the next few weeks. The change should be transparent
85         unless you  want to use new features.
86
87         Not all "NO_CLEAN" build scenarios work across these changes. Many
88         scenarios have been tested and fixed, but rebuilding kernels without
89         rebuilding world may fail.
90
91         The ZFS cache file has moved from /boot to /etc to match the OpenZFS
92         upstream default. A fallback to /boot has been added for mountroot.
93
94         Pool auto import behavior at boot has been moved from the kernel module
95         to an explicit "zpool import -a" in one of the rc scripts enabled by
96         zfs_enable=YES. This means your non-root zpools won't auto import until
97         you upgrade your /etc/rc.d files.
98
99 20200824:
100         The resume code now notifies devd with the 'kernel' system
101         rather than the old 'kern' subsystem to be consistent with
102         other use. The old notification will be created as well, but
103         will be removed prior to FreeBSD 14.0.
104
105 20200821:
106         r362275 changed the internal API between the kernel RPC and the
107         NFS modules. As such, all the modules must be recompiled from
108         sources.
109
110 20200817:
111         r364330 modified the internal API used between the NFS modules.
112         As such, all the NFS modules must be re-compiled from sources.
113
114 20200816:
115         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
116         been upgraded to 11.0.0.  Please see the 20141231 entry below for
117         information about prerequisites and upgrading, if you are not already
118         using clang 3.5.0 or higher.
119
120 20200810:
121         r364092 modified the internal ABI used between the kernel NFS
122         modules.  As such, all of these modules need to be rebuilt
123         from sources, so a version bump was done.
124
125 20200807:
126         Makefile.inc has been updated to work around the issue documented in
127         20200729. It was a case where the optimization of using symbolic links
128         to point to binaries created a situation where we'd run new binaries
129         with old libraries starting midway through the installworld process.
130
131 20200729:
132         r363679 has redefined some undefined behavior in regcomp(3); notably,
133         extraneous escapes of most ordinary characters will no longer be
134         accepted.  An exp-run has identified all of the problems with this in
135         ports, but other non-ports software may need extra escapes removed to
136         continue to function.
137
138         Because of this change, installworld may encounter the following error
139         from rtld: Undefined symbol "regcomp@FBSD_1.6" -- It is imperative that
140         you do not halt installworld. Instead, let it run to completion (whether
141         successful or not) and run installworld once more.
142
143 20200627:
144         A new implementation of bc and dc has been imported in r362681. This
145         implementation corrects non-conformant behavior of the previous bc
146         and adds GNU bc compatible options. It offers a number of extensions,
147         is much faster on large values, and has support for message catalogs
148         (a number of languages are already supported, contributions of further
149         languages welcome). The option WITHOUT_GH_BC can be used to build the
150         world with the previous versions of bc and dc.
151
152 20200625:
153         r362639 changed the internal API used between the NFS kernel modules.
154         As such, they all need to be rebuilt from sources.
155
156 20200613:
157         r362158 changed the arguments for VFS_CHECKEXP().  As such, any
158         out of tree file systems need to be modified and rebuilt.
159         Also, any file systems that are modules must be rebuilt.
160
161 20200604:
162         read(2) of a directory fd is now rejected by default.  root may
163         re-enable it for system root only on non-ZFS filesystems with the
164         security.bsd.allow_read_dir sysctl(8) MIB if
165         security.bsd.suser_enabled=1.
166
167         It may be advised to setup aliases for grep to default to `-d skip` if
168         commonly non-recursively grepping a list that includes directories and
169         the potential for the resulting stderr output is not tolerable.  Example
170         aliases are now installed, commented out, in /root/.cshrc and
171         /root/.shrc.
172
173 20200523:
174         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
175         been upgraded to 10.0.1.  Please see the 20141231 entry below for
176         information about prerequisites and upgrading, if you are not already
177         using clang 3.5.0 or higher.
178
179 20200512:
180         Support for obsolete compilers has been removed from the build system.
181         Clang 6 and GCC 6.4 are the minimum supported versions.
182
183 20200424:
184         closefrom(2) has been moved under COMPAT12, and replaced in libc with a
185         stub that calls close_range(2).  If using a custom kernel configuration,
186         you may want to ensure that the COMPAT_FREEBSD12 option is included, as
187         a slightly older -CURRENT userland and older FreeBSD userlands may not
188         be functional without closefrom(2).
189
190 20200414:
191         Upstream DTS from Linux 5.6 was merged and they now have the SID
192         and THS (Secure ID controller and THermal Sensor) node present.
193         The DTB overlays have now been removed from the tree for the H3/H5 and
194         A64 SoCs and the aw_sid and aw_thermal driver have been updated to
195         deal with upstream DTS. If you are using those overlays you need to
196         remove them from loader.conf and update the DTBs on the FAT partition.
197
198 20200310:
199         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
200         been upgraded to 10.0.0.  Please see the 20141231 entry below for
201         information about prerequisites and upgrading, if you are not already
202         using clang 3.5.0 or higher.
203
204 20200309:
205         The amd(8) automount daemon has been removed from the source tree.
206         As of FreeBSD 10.1 autofs(5) is the preferred tool for automounting.
207         amd is still available in the sysutils/am-utils port.
208
209 20200301:
210         Removed brooktree driver (bktr.4) from the tree.
211
212 20200229:
213         The WITH_GPL_DTC option has been removed.  The BSD-licenced device tree
214         compiler in usr.bin/dtc is used on all architectures which use dtc, and
215         the GPL dtc is available (if needed) from the sysutils/dtc port.
216
217 20200229:
218         The WITHOUT_LLVM_LIBUNWIND option has been removed.  LLVM's libunwind
219         is used by all supported CPU architectures.
220
221 20200229:
222         GCC 4.2.1 has been removed from the tree.  The WITH_GCC,
223         WITH_GCC_BOOTSTRAP, and WITH_GNUCXX options are no longer available.
224         Users who wish to build FreeBSD with GCC must use the external toolchain
225         ports or packages.
226
227 20200220:
228         ncurses has been updated to a newer version (6.2-20200215). Given the ABI
229         has changed, users will have to rebuild all the ports that are linked to
230         ncurses.
231
232 20200217:
233         The size of struct vnet and the magic cookie have changed.
234         Users need to recompile libkvm and all modules using VIMAGE
235         together with their new kernel.
236
237 20200212:
238         Defining the long deprecated NO_CTF, NO_DEBUG_FILES, NO_INSTALLLIB,
239         NO_MAN, NO_PROFILE, and NO_WARNS variables is now an error.  Update
240         your Makefiles and scripts to define MK_<var>=no instead as required.
241
242         One exception to this is that program or library Makefiles should
243         define MAN to empty rather than setting MK_MAN=no.
244
245 20200108:
246         Clang/LLVM is now the default compiler and LLD the default
247         linker for riscv64.
248
249 20200107:
250         make universe no longer uses GCC 4.2.1 on any architectures.
251         Architectures not supported by in-tree Clang/LLVM require an
252         external toolchain package.
253
254 20200104:
255         GCC 4.2.1 is now not built by default, as part of the GCC 4.2.1
256         retirement plan.  Specifically, the GCC, GCC_BOOTSTRAP, and GNUCXX
257         options default to off for all supported CPU architectures.  As a
258         short-term transition aid they may be enabled via WITH_* options.
259         GCC 4.2.1 is expected to be removed from the tree on 2020-03-31.
260
261 20200102:
262         Support for armv5 has been disconnected and is being removed. The
263         machine combination MACHINE=arm MACHINE_ARCH=arm is no longer valid.
264         You must now use a MACHINE_ARCH of armv6 or armv7. The default
265         MACHINE_ARCH for MACHINE=arm is now armv7.
266
267 20191226:
268         Clang/LLVM is now the default compiler for all powerpc architectures.
269         LLD is now the default linker for powerpc64.  The change for powerpc64
270         also includes a change to the ELFv2 ABI, incompatible with the existing
271         ABI.
272
273 20191226:
274         Kernel-loadable random(4) modules are no longer unloadable.
275
276 20191222:
277         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
278         been upgraded to 9.0.1.  Please see the 20141231 entry below for
279         information about prerequisites and upgrading, if you are not already
280         using clang 3.5.0 or higher.
281
282 20191212:
283         r355677 has modified the internal interface used between the
284         NFS modules in the kernel. As such, they must all be upgraded
285         simultaneously. I will do a version bump for this.
286
287 20191205:
288         The root certificates of the Mozilla CA Certificate Store have been
289         imported into the base system and can be managed with the certctl(8)
290         utility.  If you have installed the security/ca_root_nss port or package
291         with the ETCSYMLINK option (the default), be advised that there may be
292         differences between those included in the port and those included in
293         base due to differences in nss branch used as well as general update
294         frequency.  Note also that certctl(8) cannot manage certs in the
295         format used by the security/ca_root_nss port.
296
297 20191120:
298         The amd(8) automount daemon has been disabled by default, and will be
299         removed in the future.  As of FreeBSD 10.1 the autofs(5) is available
300         for automounting.
301
302 20191107:
303         The nctgpio and wbwd drivers have been moved to the superio bus.
304         If you have one of these drivers in a kernel configuration, then
305         you should add device superio to it.  If you use one of these drivers
306         as a module and you compile a custom set of modules, then you should
307         add superio to the set.
308
309 20191021:
310         KPIs for network drivers to access interface addresses have changed.
311         Users need to recompile NIC driver modules together with kernel.
312
313 20191021:
314         The net.link.tap.user_open sysctl no longer prevents user opening of
315         already created /dev/tapNN devices.  Access is still controlled by
316         node permissions, just like tun devices.  The net.link.tap.user_open
317         sysctl is now used only to allow users to perform devfs cloning of
318         tap devices, and the subsequent open may not succeed if the user is not
319         in the appropriate group.  This sysctl may be deprecated/removed
320         completely in the future.
321
322 20191009:
323         mips, powerpc, and sparc64 are no longer built as part of
324         universe / tinderbox unless MAKE_OBSOLETE_GCC is defined. If
325         not defined, mips, powerpc, and sparc64 builds will look for
326         the xtoolchain binaries and if installed use them for universe
327         builds. As llvm 9.0 becomes vetted for these architectures, they
328         will be removed from the list.
329
330 20191009:
331         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
332         been upgraded to 9.0.0.  Please see the 20141231 entry below for
333         information about prerequisites and upgrading, if you are not already
334         using clang 3.5.0 or higher.
335
336 20191003:
337         The hpt27xx, hptmv, hptnr, and hptrr drivers have been removed from
338         GENERIC.  They are available as modules and can be loaded by adding
339         to /boot/loader.conf hpt27xx_load="YES", hptmv_load="YES",
340         hptnr_load="YES", or hptrr_load="YES", respectively.
341
342 20190913:
343         ntpd no longer by default locks its pages in memory, allowing them
344         to be paged out by the kernel. Use rlimit memlock to restore
345         historic BSD behaviour. For example, add "rlimit memlock 32"
346         to ntp.conf to lock up to 32 MB of ntpd address space in memory.
347
348 20190823:
349         Several of ping6's options have been renamed for better consistency
350         with ping.  If you use any of -ARWXaghmrtwx, you must update your
351         scripts.  See ping6(8) for details.
352
353 20190727:
354         The vfs.fusefs.sync_unmount and vfs.fusefs.init_backgrounded sysctls
355         and the "-o sync_unmount" and "-o init_backgrounded" mount options have
356         been removed from mount_fusefs(8).  You can safely remove them from
357         your scripts, because they had no effect.
358
359         The vfs.fusefs.fix_broken_io, vfs.fusefs.sync_resize,
360         vfs.fusefs.refresh_size, vfs.fusefs.mmap_enable,
361         vfs.fusefs.reclaim_revoked, and vfs.fusefs.data_cache_invalidate
362         sysctls have been removed.  If you felt the need to set any of them to
363         a non-default value, please tell asomers@FreeBSD.org why.
364
365 20190713:
366         Default permissions on the /var/account/acct file (and copies of it
367         rotated by periodic daily scripts) are changed from 0644 to 0640
368         because the file contains sensitive information that should not be
369         world-readable.  If the /var/account directory must be created by
370         rc.d/accounting, the mode used is now 0750.  Admins who use the
371         accounting feature are encouraged to change the mode of an existing
372         /var/account directory to 0750 or 0700.
373
374 20190620:
375         Entropy collection and the /dev/random device are no longer optional
376         components.  The "device random" option has been removed.
377         Implementations of distilling algorithms can still be made loadable
378         with "options RANDOM_LOADABLE" (e.g., random_fortuna.ko).
379
380 20190612:
381         Clang, llvm, lld, lldb, compiler-rt, libc++, libunwind and openmp have
382         been upgraded to 8.0.1.  Please see the 20141231 entry below for
383         information about prerequisites and upgrading, if you are not already
384         using clang 3.5.0 or higher.
385
386 20190608:
387         A fix was applied to i386 kernel modules to avoid panics with
388         dpcpu or vnet.  Users need to recompile i386 kernel modules
389         having pcpu or vnet sections or they will refuse to load.
390
391 20190513:
392         User-wired pages now have their own counter,
393         vm.stats.vm.v_user_wire_count.  The vm.max_wired sysctl was renamed
394         to vm.max_user_wired and changed from an unsigned int to an unsigned
395         long.  bhyve VMs wired with the -S are now subject to the user
396         wiring limit; the vm.max_user_wired sysctl may need to be tuned to
397         avoid running into the limit.
398
399 20190507:
400         The IPSEC option has been removed from GENERIC.  Users requiring
401         ipsec(4) must now load the ipsec(4) kernel module.
402
403 20190507:
404         The tap(4) driver has been folded into tun(4), and the module has been
405         renamed to tuntap.  You should update any kld_list="if_tap" or
406         kld_list="if_tun" entries in /etc/rc.conf, if_tap_load="YES" or
407         if_tun_load="YES" entries in /boot/loader.conf to load the if_tuntap
408         module instead, and "device tap" or "device tun" entries in kernel
409         config files to select the tuntap device instead.
410
411 20190418:
412         The following knobs have been added related to tradeoffs between
413         safe use of the random device and availability in the absence of
414         entropy:
415
416         kern.random.initial_seeding.bypass_before_seeding: tunable; set
417         non-zero to bypass the random device prior to seeding, or zero to
418         block random requests until the random device is initially seeded.
419         For now, set to 1 (unsafe) by default to restore pre-r346250 boot
420         availability properties.
421
422         kern.random.initial_seeding.read_random_bypassed_before_seeding:
423         read-only diagnostic sysctl that is set when bypass is enabled and
424         read_random(9) is bypassed, to enable programmatic handling of this
425         initial condition, if desired.
426
427         kern.random.initial_seeding.arc4random_bypassed_before_seeding:
428         Similar to the above, but for for arc4random(9) initial seeding.
429
430         kern.random.initial_seeding.disable_bypass_warnings: tunable; set
431         non-zero to disable warnings in dmesg when the same conditions are
432         met as for the diagnostic sysctls above.  Defaults to zero, i.e.,
433         produce warnings in dmesg when the conditions are met.
434
435 20190416:
436         The loadable random module KPI has changed; the random_infra_init()
437         routine now requires a 3rd function pointer for a bool (*)(void)
438         method that returns true if the random device is seeded (and
439         therefore unblocked).
440
441 20190404:
442         r345895 reverts r320698. This implies that an nfsuserd(8) daemon
443         built from head sources between r320757 (July 6, 2017) and
444         r338192 (Aug. 22, 2018) will not work unless the "-use-udpsock"
445         is added to the command line.
446         nfsuserd daemons built from head sources that are post-r338192 are
447         not affected and should continue to work.
448
449 20190320:
450         The fuse(4) module has been renamed to fusefs(4) for consistency with
451         other filesystems.  You should update any kld_load="fuse" entries in
452         /etc/rc.conf, fuse_load="YES" entries in /boot/loader.conf, and
453         "options FUSE" entries in kernel config files.
454
455 20190304:
456         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
457         8.0.0.  Please see the 20141231 entry below for information about
458         prerequisites and upgrading, if you are not already using clang 3.5.0
459         or higher.
460
461 20190226:
462         geom_uzip(4) depends on the new module xz.  If geom_uzip is statically
463         compiled into your custom kernel, add 'device xz' statement to the
464         kernel config.
465
466 20190219:
467         drm and drm2 have been removed from the tree. Please see
468         https://wiki.freebsd.org/Graphics for the latest information on
469         migrating to the drm ports.
470
471 20190131:
472         Iflib is no longer unconditionally compiled into the kernel.  Drivers
473         using iflib and statically compiled into the kernel, now require
474         the 'device iflib' config option.  For the same drivers loaded as
475         modules on kernels not having 'device iflib', the iflib.ko module
476         is loaded automatically.
477
478 20190125:
479         The IEEE80211_AMPDU_AGE and AH_SUPPORT_AR5416 kernel configuration
480         options no longer exist since r343219 and r343427 respectively;
481         nothing uses them, so they should be just removed from custom
482         kernel config files.
483
484 20181230:
485         r342635 changes the way efibootmgr(8) works by requiring users to add
486         the -b (bootnum) parameter for commands where the bootnum was previously
487         specified with each option. For example 'efibootmgr -B 0001' is now
488         'efibootmgr -B -b 0001'.
489
490 20181220:
491         r342286 modifies the NFSv4 server so that it obeys vfs.nfsd.nfs_privport
492         in the same as it is applied to NFSv2 and 3.  This implies that NFSv4
493         servers that have vfs.nfsd.nfs_privport set will only allow mounts
494         from clients using a reserved port#. Since both the FreeBSD and Linux
495         NFSv4 clients use reserved port#s by default, this should not affect
496         most NFSv4 mounts.
497
498 20181219:
499         The XLP config has been removed. We can't support 64-bit atomics in this
500         kernel because it is running in 32-bit mode. XLP users must transition
501         to running a 64-bit kernel (XLP64 or XLPN32).
502
503         The mips GXEMUL support has been removed from FreeBSD. MALTA* + qemu is
504         the preferred emulator today and we don't need two different ones.
505
506         The old sibyte / swarm / Broadcom BCM1250 support has been
507         removed from the mips port.
508
509 20181211:
510         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
511         7.0.1.  Please see the 20141231 entry below for information about
512         prerequisites and upgrading, if you are not already using clang 3.5.0
513         or higher.
514
515 20181211:
516         Remove the timed and netdate programs from the base tree.  Setting
517         the time with these daemons has been obsolete for over a decade.
518
519 20181126:
520         On amd64, arm64 and armv7 (architectures that install LLVM's ld.lld
521         linker as /usr/bin/ld) GNU ld is no longer installed as ld.bfd, as
522         it produces broken binaries when ifuncs are in use.  Users needing
523         GNU ld should install the binutils port or package.
524
525 20181123:
526         The BSD crtbegin and crtend code has been enabled by default. It has
527         had extensive testing on amd64, arm64, and i386. It can be disabled
528         by building a world with -DWITHOUT_BSD_CRTBEGIN.
529
530 20181115:
531         The set of CTM commands (ctm, ctm_smail, ctm_rmail, ctm_dequeue)
532         has been converted to a port (misc/ctm) and will be removed from
533         FreeBSD-13.  It is available as a package (ctm) for all supported
534         FreeBSD versions.
535
536 20181110:
537         The default newsyslog.conf(5) file has been changed to only include
538         files in /etc/newsyslog.conf.d/ and /usr/local/etc/newsyslog.conf.d/ if
539         the filenames end in '.conf' and do not begin with a '.'.
540
541         You should check the configuration files in these two directories match
542         this naming convention. You can verify which configuration files are
543         being included using the command:
544                 $ newsyslog -Nrv
545
546 20181015:
547         Ports for the DRM modules have been simplified. Now, amd64 users should
548         just install the drm-kmod port. All others should install
549         drm-legacy-kmod.
550
551         Graphics hardware that's newer than about 2010 usually works with
552         drm-kmod.  For hardware older than 2013, however, some users will need
553         to use drm-legacy-kmod if drm-kmod doesn't work for them. Hardware older
554         than 2008 usually only works in drm-legacy-kmod. The graphics team can
555         only commit to hardware made since 2013 due to the complexity of the
556         market and difficulty to test all the older cards effectively. If you
557         have hardware supported by drm-kmod, you are strongly encouraged to use
558         that as you will get better support.
559
560         Other than KPI chasing, drm-legacy-kmod will not be updated. As outlined
561         elsewhere, the drm and drm2 modules will be eliminated from the src base
562         soon (with a limited exception for arm). Please update to the package
563         asap and report any issues to x11@freebsd.org.
564
565         Generally, anybody using the drm*-kmod packages should add
566         WITHOUT_DRM_MODULE=t and WITHOUT_DRM2_MODULE=t to avoid nasty
567         cross-threading surprises, especially with automatic driver
568         loading from X11 startup. These will become the defaults in 13-current
569         shortly.
570
571 20181012:
572         The ixlv(4) driver has been renamed to iavf(4).  As a consequence,
573         custom kernel and module loading configuration files must be updated
574         accordingly.  Moreover, interfaces previous presented as ixlvN to the
575         system are now exposed as iavfN and network configuration files must
576         be adjusted as necessary.
577
578 20181009:
579         OpenSSL has been updated to version 1.1.1.  This update included
580         additional various API changes throughout the base system.  It is
581         important to rebuild third-party software after upgrading.  The value
582         of __FreeBSD_version has been bumped accordingly.
583
584 20181006:
585         The legacy DRM modules and drivers have now been added to the loader's
586         module blacklist, in favor of loading them with kld_list in rc.conf(5).
587         The module blacklist may be overridden with the loader.conf(5)
588         'module_blacklist' variable, but loading them via rc.conf(5) is strongly
589         encouraged.
590
591 20181002:
592         The cam(4) based nda(4) driver will be used over nvd(4) by default on
593         powerpc64. You may set 'options NVME_USE_NVD=1' in your kernel conf or
594         loader tunable 'hw.nvme.use_nvd=1' if you wish to use the existing
595         driver.  Make sure to edit /boot/etc/kboot.conf and fstab to use the
596         nda device name.
597
598 20180913:
599         Reproducible build mode is now on by default, in preparation for
600         FreeBSD 12.0.  This eliminates build metadata such as the user,
601         host, and time from the kernel (and uname), unless the working tree
602         corresponds to a modified checkout from a version control system.
603         The previous behavior can be obtained by setting the /etc/src.conf
604         knob WITHOUT_REPRODUCIBLE_BUILD.
605
606 20180826:
607         The Yarrow CSPRNG has been removed from the kernel as it has not been
608         supported by its designers since at least 2003. Fortuna has been the
609         default since FreeBSD-11.
610
611 20180822:
612         devctl freeze/thaw have gone into the tree, the rc scripts have been
613         updated to use them and devmatch has been changed.  You should update
614         kernel, userland and rc scripts all at the same time.
615
616 20180818:
617         The default interpreter has been switched from 4th to Lua.
618         LOADER_DEFAULT_INTERP, documented in build(7), will override the default
619         interpreter.  If you have custom FORTH code you will need to set
620         LOADER_DEFAULT_INTERP=4th (valid values are 4th, lua or simp) in
621         src.conf for the build.  This will create default hard links between
622         loader and loader_4th instead of loader and loader_lua, the new default.
623         If you are using UEFI it will create the proper hard link to loader.efi.
624
625         bhyve uses userboot.so. It remains 4th-only until some issues are solved
626         regarding coexisting with multiple versions of FreeBSD are resolved.
627
628 20180815:
629         ls(1) now respects the COLORTERM environment variable used in other
630         systems and software to indicate that a colored terminal is both
631         supported and desired.  If ls(1) is suddenly emitting colors, they may
632         be disabled again by either removing the unwanted COLORTERM from your
633         environment, or using `ls --color=never`.  The ls(1) specific CLICOLOR
634         may not be observed in a future release.
635
636 20180808:
637         The default pager for most commands has been changed to "less".  To
638         restore the old behavior, set PAGER="more" and MANPAGER="more -s" in
639         your environment.
640
641 20180731:
642         The jedec_ts(4) driver has been removed. A superset of its functionality
643         is available in the jedec_dimm(4) driver, and the manpage for that
644         driver includes migration instructions. If you have "device jedec_ts"
645         in your kernel configuration file, it must be removed.
646
647 20180730:
648         amd64/GENERIC now has EFI runtime services, EFIRT, enabled by default.
649         This should have no effect if the kernel is booted via BIOS/legacy boot.
650         EFIRT may be disabled via a loader tunable, efi.rt.disabled, if a system
651         has a buggy firmware that prevents a successful boot due to use of
652         runtime services.
653
654 20180727:
655         Atmel AT91RM9200 and AT91SAM9, Cavium CNS 11xx and XScale
656         support has been removed from the tree. These ports were
657         obsolete and/or known to be broken for many years.
658
659 20180723:
660         loader.efi has been augmented to participate more fully in the
661         UEFI boot manager protocol. loader.efi will now look at the
662         BootXXXX environment variable to determine if a specific kernel
663         or root partition was specified. XXXX is derived from BootCurrent.
664         efibootmgr(8) manages these standard UEFI variables.
665
666 20180720:
667         zfsloader's functionality has now been folded into loader.
668         zfsloader is no longer necessary once you've updated your
669         boot blocks. For a transition period, we will install a
670         hardlink for zfsloader to loader to allow a smooth transition
671         until the boot blocks can be updated (hard link because old
672         zfs boot blocks don't understand symlinks).
673
674 20180719:
675         ARM64 now have efifb support, if you want to have serial console
676         on your arm64 board when an screen is connected and the bootloader
677         setup a frame buffer for us to use, just add :
678         boot_serial=YES
679         boot_multicons=YES
680         in /boot/loader.conf
681         For Raspberry Pi 3 (RPI) users, this is needed even if you don't have
682         an screen connected as the firmware will setup a frame buffer are that
683         u-boot will expose as an EFI frame buffer.
684
685 20180719:
686         New uid:gid added, ntpd:ntpd (123:123).  Be sure to run mergemaster
687         or take steps to update /etc/passwd before doing installworld on
688         existing systems.  Do not skip the "mergemaster -Fp" step before
689         installworld, as described in the update procedures near the bottom
690         of this document.  Also, rc.d/ntpd now starts ntpd(8) as user ntpd
691         if the new mac_ntpd(4) policy is available, unless ntpd_flags or
692         the ntp config file contain options that change file/dir locations.
693         When such options (e.g., "statsdir" or "crypto") are used, ntpd can
694         still be run as non-root by setting ntpd_user=ntpd in rc.conf, after
695         taking steps to ensure that all required files/dirs are accessible
696         by the ntpd user.
697
698 20180717:
699         Big endian arm support has been removed.
700
701 20180711:
702         The static environment setup in kernel configs is no longer mutually
703         exclusive with the loader(8) environment by default.  In order to
704         restore the previous default behavior of disabling the loader(8)
705         environment if a static environment is present, you must specify
706         loader_env.disabled=1 in the static environment.
707
708 20180705:
709         The ABI of syscalls used by management tools like sockstat and
710         netstat has been broken to allow 32-bit binaries to work on
711         64-bit kernels without modification.  These programs will need
712         to match the kernel in order to function.  External programs may
713         require minor modifications to accommodate a change of type in
714         structures from pointers to 64-bit virtual addresses.
715
716 20180702:
717         On i386 and amd64 atomics are now inlined. Out of tree modules using
718         atomics will need to be rebuilt.
719
720 20180701:
721         The '%I' format in the kern.corefile sysctl limits the number of
722         core files that a process can generate to the number stored in the
723         debug.ncores sysctl. The '%I' format is replaced by the single digit
724         index. Previously, if all indexes were taken the kernel would overwrite
725         only a core file with the highest index in a filename.
726         Currently the system will create a new core file if there is a free
727         index or if all slots are taken it will overwrite the oldest one.
728
729 20180630:
730         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
731         6.0.1.  Please see the 20141231 entry below for information about
732         prerequisites and upgrading, if you are not already using clang 3.5.0
733         or higher.
734
735 20180628:
736         r335753 introduced a new quoting method. However, etc/devd/devmatch.conf
737         needed to be changed to work with it. This change was made with r335763
738         and requires a mergemaster / etcupdate / etc to update the installed
739         file.
740
741 20180612:
742         r334930 changed the interface between the NFS modules, so they all
743         need to be rebuilt.  r335018 did a __FreeBSD_version bump for this.
744
745 20180530:
746         As of r334391 lld is the default amd64 system linker; it is installed
747         as /usr/bin/ld.  Kernel build workarounds (see 20180510 entry) are no
748         longer necessary.
749
750 20180530:
751         The kernel / userland interface for devinfo changed, so you'll
752         need a new kernel and userland as a pair for it to work (rebuilding
753         lib/libdevinfo is all that's required). devinfo and devmatch will
754         not work, but everything else will when there's a mismatch.
755
756 20180523:
757         The on-disk format for hwpmc callchain records has changed to include
758         threadid corresponding to a given record. This changes the field offsets
759         and thus requires that libpmcstat be rebuilt before using a kernel
760         later than r334108.
761
762 20180517:
763         The vxge(4) driver has been removed.  This driver was introduced into
764         HEAD one week before the Exar left the Ethernet market and is not
765         known to be used.  If you have device vxge in your kernel config file
766         it must be removed.
767
768 20180510:
769         The amd64 kernel now requires a ld that supports ifunc to produce a
770         working kernel, either lld or a newer binutils. lld is built by default
771         on amd64, and the 'buildkernel' target uses it automatically. However,
772         it is not the default linker, so building the kernel the traditional
773         way requires LD=ld.lld on the command line (or LD=/usr/local/bin/ld for
774         binutils port/package). lld will soon be default, and this requirement
775         will go away.
776
777         NOTE: As of r334391 lld is the default system linker on amd64, and no
778         workaround is necessary.
779
780 20180508:
781         The nxge(4) driver has been removed.  This driver was for PCI-X 10g
782         cards made by s2io/Neterion.  The company was acquired by Exar and
783         no longer sells or supports Ethernet products.  If you have device
784         nxge in your kernel config file it must be removed.
785
786 20180504:
787         The tz database (tzdb) has been updated to 2018e.  This version more
788         correctly models time stamps in time zones with negative DST such as
789         Europe/Dublin (from 1971 on), Europe/Prague (1946/7), and
790         Africa/Windhoek (1994/2017).  This does not affect the UT offsets, only
791         time zone abbreviations and the tm_isdst flag.
792
793 20180502:
794         The ixgb(4) driver has been removed.  This driver was for an early and
795         uncommon legacy PCI 10GbE for a single ASIC, Intel 82597EX. Intel
796         quickly shifted to the long lived ixgbe family.  If you have device
797         ixgb in your kernel config file it must be removed.
798
799 20180501:
800         The lmc(4) driver has been removed.  This was a WAN interface
801         card that was already reportedly rare in 2003, and had an ambiguous
802         license.  If you have device lmc in your kernel config file it must
803         be removed.
804
805 20180413:
806         Support for Arcnet networks has been removed.  If you have device
807         arcnet or device cm in your kernel config file they must be
808         removed.
809
810 20180411:
811         Support for FDDI networks has been removed.  If you have device
812         fddi or device fpa in your kernel config file they must be
813         removed.
814
815 20180406:
816         In addition to supporting RFC 3164 formatted messages, the
817         syslogd(8) service is now capable of parsing RFC 5424 formatted
818         log messages. The main benefit of using RFC 5424 is that clients
819         may now send log messages with timestamps containing year numbers,
820         microseconds and time zone offsets.
821
822         Similarly, the syslog(3) C library function has been altered to
823         send RFC 5424 formatted messages to the local system logging
824         daemon. On systems using syslogd(8), this change should have no
825         negative impact, as long as syslogd(8) and the C library are
826         updated at the same time. On systems using a different system
827         logging daemon, it may be necessary to make configuration
828         adjustments, depending on the software used.
829
830         When using syslog-ng, add the 'syslog-protocol' flag to local
831         input sources to enable parsing of RFC 5424 formatted messages:
832
833                 source src {
834                         unix-dgram("/var/run/log" flags(syslog-protocol));
835                 }
836
837         When using rsyslog, disable the 'SysSock.UseSpecialParser' option
838         of the 'imuxsock' module to let messages be processed by the
839         regular RFC 3164/5424 parsing pipeline:
840
841                 module(load="imuxsock" SysSock.UseSpecialParser="off")
842
843         Do note that these changes only affect communication between local
844         applications and syslogd(8). The format that syslogd(8) uses to
845         store messages on disk or forward messages to other systems
846         remains unchanged. syslogd(8) still uses RFC 3164 for these
847         purposes. Options to customize this behaviour will be added in the
848         future. Utilities that process log files stored in /var/log are
849         thus expected to continue to function as before.
850
851         __FreeBSD_version has been incremented to 1200061 to denote this
852         change.
853
854 20180328:
855         Support for token ring networks has been removed. If you
856         have "device token" in your kernel config you should remove
857         it. No device drivers supported token ring.
858
859 20180323:
860         makefs was modified to be able to tag ISO9660 El Torito boot catalog
861         entries as EFI instead of overloading the i386 tag as done previously.
862         The amd64 mkisoimages.sh script used to build amd64 ISO images for
863         release was updated to use this. This may mean that makefs must be
864         updated before "make cdrom" can be run in the release directory. This
865         should be as simple as:
866
867                 $ cd $SRCDIR/usr.sbin/makefs
868                 $ make depend all install
869
870 20180212:
871         FreeBSD boot loader enhanced with Lua scripting. It's purely opt-in for
872         now by building WITH_LOADER_LUA and WITHOUT_FORTH in /etc/src.conf.
873         Co-existence for the transition period will come shortly. Booting is a
874         complex environment and test coverage for Lua-enabled loaders has been
875         thin, so it would be prudent to assume it might not work and make
876         provisions for backup boot methods.
877
878 20180211:
879         devmatch functionality has been turned on in devd. It will automatically
880         load drivers for unattached devices. This may cause unexpected drivers
881         to be loaded. Please report any problems to current@ and
882         imp@freebsd.org.
883
884 20180114:
885         Clang, llvm, lld, lldb, compiler-rt and libc++ have been upgraded to
886         6.0.0.  Please see the 20141231 entry below for information about
887         prerequisites and upgrading, if you are not already using clang 3.5.0
888         or higher.
889
890 20180110:
891         LLVM's lld linker is now used as the FreeBSD/amd64 bootstrap linker.
892         This means it is used to link the kernel and userland libraries and
893         executables, but is not yet installed as /usr/bin/ld by default.
894
895         To revert to ld.bfd as the bootstrap linker, in /etc/src.conf set
896         WITHOUT_LLD_BOOTSTRAP=yes
897
898 20180110:
899         On i386, pmtimer has been removed. Its functionality has been folded
900         into apm. It was a no-op on ACPI in current for a while now (but was
901         still needed on i386 in FreeBSD 11 and earlier). Users may need to
902         remove it from kernel config files.
903
904 20180104:
905         The use of RSS hash from the network card aka flowid has been
906         disabled by default for lagg(4) as it's currently incompatible with
907         the lacp and loadbalance protocols.
908
909         This can be re-enabled by setting the following in loader.conf:
910         net.link.lagg.default_use_flowid="1"
911
912 20180102:
913         The SW_WATCHDOG option is no longer necessary to enable the
914         hardclock-based software watchdog if no hardware watchdog is
915         configured. As before, SW_WATCHDOG will cause the software
916         watchdog to be enabled even if a hardware watchdog is configured.
917
918 20171215:
919         r326887 fixes the issue described in the 20171214 UPDATING entry.
920         r326888 flips the switch back to building GELI support always.
921
922 20171214:
923         r362593 broke ZFS + GELI support for reasons unknown. However,
924         it also broke ZFS support generally, so GELI has been turned off
925         by default as the lesser evil in r326857. If you boot off ZFS and/or
926         GELI, it might not be a good time to update.
927
928 20171125:
929         PowerPC users must update loader(8) by rebuilding world before
930         installing a new kernel, as the protocol connecting them has
931         changed. Without the update, loader metadata will not be passed
932         successfully to the kernel and users will have to enter their
933         root partition at the kernel mountroot prompt to continue booting.
934         Newer versions of loader can boot old kernels without issue.
935
936 20171110:
937         The LOADER_FIREWIRE_SUPPORT build variable as been renamed to
938         WITH/OUT_LOADER_FIREWIRE. LOADER_{NO_,}GELI_SUPPORT has been renamed
939         to WITH/OUT_LOADER_GELI.
940
941 20171106:
942         The naive and non-compliant support of posix_fallocate(2) in ZFS
943         has been removed as of r325320.  The system call now returns EINVAL
944         when used on a ZFS file.  Although the new behavior complies with the
945         standard, some consumers are not prepared to cope with it.
946         One known victim is lld prior to r325420.
947
948 20171102:
949         Building in a FreeBSD src checkout will automatically create object
950         directories now rather than store files in the current directory if
951         'make obj' was not ran.  Calling 'make obj' is no longer necessary.
952         This feature can be disabled by setting WITHOUT_AUTO_OBJ=yes in
953         /etc/src-env.conf (not /etc/src.conf), or passing the option in the
954         environment.
955
956 20171101:
957         The default MAKEOBJDIR has changed from /usr/obj/<srcdir> for native
958         builds, and /usr/obj/<arch>/<srcdir> for cross-builds, to a unified
959         /usr/obj/<srcdir>/<arch>.  This behavior can be changed to the old
960         format by setting WITHOUT_UNIFIED_OBJDIR=yes in /etc/src-env.conf,
961         the environment, or with -DWITHOUT_UNIFIED_OBJDIR when building.
962         The UNIFIED_OBJDIR option is a transitional feature that will be
963         removed for 12.0 release; please migrate to the new format for any
964         tools by looking up the OBJDIR used by 'make -V .OBJDIR' means rather
965         than hardcoding paths.
966
967 20171028:
968         The native-xtools target no longer installs the files by default to the
969         OBJDIR.  Use the native-xtools-install target with a DESTDIR to install
970         to ${DESTDIR}/${NXTP} where NXTP defaults to /nxb-bin.
971
972 20171021:
973         As part of the boot loader infrastructure cleanup, LOADER_*_SUPPORT
974         options are changing from controlling the build if defined / undefined
975         to controlling the build with explicit 'yes' or 'no' values. They will
976         shift to WITH/WITHOUT options to match other options in the system.
977
978 20171010:
979         libstand has turned into a private library for sys/boot use only.
980         It is no longer supported as a public interface outside of sys/boot.
981
982 20171005:
983         The arm port has split armv6 into armv6 and armv7. armv7 is now
984         a valid TARGET_ARCH/MACHINE_ARCH setting. If you have an armv7 system
985         and are running a kernel from before r324363, you will need to add
986         MACHINE_ARCH=armv7 to 'make buildworld' to do a native build.
987
988 20171003:
989         When building multiple kernels using KERNCONF, non-existent KERNCONF
990         files will produce an error and buildkernel will fail. Previously
991         missing KERNCONF files silently failed giving no indication as to
992         why, only to subsequently discover during installkernel that the
993         desired kernel was never built in the first place.
994
995 20170912:
996         The default serial number format for CTL LUNs has changed.  This will
997         affect users who use /dev/diskid/* device nodes, or whose FibreChannel
998         or iSCSI clients care about their LUNs' serial numbers.  Users who
999         require serial number stability should hardcode serial numbers in
1000         /etc/ctl.conf .
1001
1002 20170912:
1003         For 32-bit arm compiled for hard-float support, soft-floating point
1004         binaries now always get their shared libraries from
1005         LD_SOFT_LIBRARY_PATH (in the past, this was only used if
1006         /usr/libsoft also existed). Only users with a hard-float ld.so, but
1007         soft-float everything else should be affected.
1008
1009 20170826:
1010         The geli password typed at boot is now hidden.  To restore the previous
1011         behavior, see geli(8) for configuration options.
1012
1013 20170825:
1014         Move PMTUD blackhole counters to TCPSTATS and remove them from bare
1015         sysctl values.  Minor nit, but requires a rebuild of both world/kernel
1016         to complete.
1017
1018 20170814:
1019         "make check" behavior (made in ^/head@r295380) has been changed to
1020         execute from a limited sandbox, as opposed to executing from
1021         ${TESTSDIR}.
1022
1023         Behavioral changes:
1024         - The "beforecheck" and "aftercheck" targets are now specified.
1025         - ${CHECKDIR} (added in commit noted above) has been removed.
1026         - Legacy behavior can be enabled by setting
1027           WITHOUT_MAKE_CHECK_USE_SANDBOX in src.conf(5) or the environment.
1028
1029         If the limited sandbox mode is enabled, "make check" will execute
1030         "make distribution", then install, execute the tests, and clean up the
1031         sandbox if successful.
1032
1033         The "make distribution" and "make install" targets are typically run as
1034         root to set appropriate permissions and ownership at installation time.
1035         The end-user should set "WITH_INSTALL_AS_USER" in src.conf(5) or the
1036         environment if executing "make check" with limited sandbox mode using
1037         an unprivileged user.
1038
1039 20170808:
1040         Since the switch to GPT disk labels, fsck for UFS/FFS has been
1041         unable to automatically find alternate superblocks. As of r322297,
1042         the information needed to find alternate superblocks has been
1043         moved to the end of the area reserved for the boot block.
1044         Filesystems created with a newfs of this vintage or later
1045         will create the recovery information. If you have a filesystem
1046         created prior to this change and wish to have a recovery block
1047         created for your filesystem, you can do so by running fsck in
1048         foreground mode (i.e., do not use the -p or -y options). As it
1049         starts, fsck will ask ``SAVE DATA TO FIND ALTERNATE SUPERBLOCKS''
1050         to which you should answer yes.
1051
1052 20170728:
1053         As of r321665, an NFSv4 server configuration that services
1054         Kerberos mounts or clients that do not support the uid/gid in
1055         owner/owner_group string capability, must explicitly enable
1056         the nfsuserd daemon by adding nfsuserd_enable="YES" to the
1057         machine's /etc/rc.conf file.
1058
1059 20170722:
1060         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 5.0.0.
1061         Please see the 20141231 entry below for information about prerequisites
1062         and upgrading, if you are not already using clang 3.5.0 or higher.
1063
1064 20170701:
1065         WITHOUT_RCMDS is now the default. Set WITH_RCMDS if you need the
1066         r-commands (rlogin, rsh, etc.) to be built with the base system.
1067
1068 20170625:
1069         The FreeBSD/powerpc platform now uses a 64-bit type for time_t.  This is
1070         a very major ABI incompatible change, so users of FreeBSD/powerpc must
1071         be careful when performing source upgrades.  It is best to run
1072         'make installworld' from an alternate root system, either a live
1073         CD/memory stick, or a temporary root partition.  Additionally, all ports
1074         must be recompiled.  powerpc64 is largely unaffected, except in the case
1075         of 32-bit compatibility.  All 32-bit binaries will be affected.
1076
1077 20170623:
1078         Forward compatibility for the "ino64" project have been committed. This
1079         will allow most new binaries to run on older kernels in a limited
1080         fashion.  This prevents many of the common foot-shooting actions in the
1081         upgrade as well as the limited ability to roll back the kernel across
1082         the ino64 upgrade. Complicated use cases may not work properly, though
1083         enough simpler ones work to allow recovery in most situations.
1084
1085 20170620:
1086         Switch back to the BSDL dtc (Device Tree Compiler). Set WITH_GPL_DTC
1087         if you require the GPL compiler.
1088
1089 20170618:
1090         The internal ABI used for communication between the NFS kernel modules
1091         was changed by r320085, so __FreeBSD_version was bumped to
1092         ensure all the NFS related modules are updated together.
1093
1094 20170617:
1095         The ABI of struct event was changed by extending the data
1096         member to 64bit and adding ext fields.  For upgrade, same
1097         precautions as for the entry 20170523 "ino64" must be
1098         followed.
1099
1100 20170531:
1101         The GNU roff toolchain has been removed from base. To render manpages
1102         which are not supported by mandoc(1), man(1) can fallback on GNU roff
1103         from ports (and recommends to install it).
1104         To render roff(7) documents, consider using GNU roff from ports or the
1105         heirloom doctools roff toolchain from ports via pkg install groff or
1106         via pkg install heirloom-doctools.
1107
1108 20170524:
1109         The ath(4) and ath_hal(4) modules now build piecemeal to allow for
1110         smaller runtime footprint builds.  This is useful for embedded systems
1111         which only require one chipset support.
1112
1113         If you load it as a module, make sure this is in /boot/loader.conf:
1114
1115         if_ath_load="YES"
1116
1117         This will load the HAL, all chip/RF backends and if_ath_pci.
1118         If you have if_ath_pci in /boot/loader.conf, ensure it is after
1119         if_ath or it will not load any HAL chipset support.
1120
1121         If you want to selectively load things (eg on ye cheape ARM/MIPS
1122         platforms where RAM is at a premium) you should:
1123
1124         * load ath_hal
1125         * load the chip modules in question
1126         * load ath_rate, ath_dfs
1127         * load ath_main
1128         * load if_ath_pci and/or if_ath_ahb depending upon your particular
1129           bus bind type - this is where probe/attach is done.
1130
1131         For further comments/feedback, poke adrian@ .
1132
1133 20170523:
1134         The "ino64" 64-bit inode project has been committed, which extends
1135         a number of types to 64 bits.  Upgrading in place requires care and
1136         adherence to the documented upgrade procedure.
1137
1138         If using a custom kernel configuration ensure that the
1139         COMPAT_FREEBSD11 option is included (as during the upgrade the
1140         system will be running the ino64 kernel with the existing world).
1141
1142         For the safest in-place upgrade begin by removing previous build
1143         artifacts via "rm -rf /usr/obj/*".  Then, carefully follow the full
1144         procedure documented below under the heading "To rebuild everything and
1145         install it on the current system."  Specifically, a reboot is required
1146         after installing the new kernel before installing world. While an
1147         installworld normally works by accident from multiuser after rebooting
1148         the proper kernel, there are many cases where this will fail across this
1149         upgrade and installworld from single user is required.
1150
1151 20170424:
1152         The NATM framework including the en(4), fatm(4), hatm(4), and
1153         patm(4) devices has been removed.  Consumers should plan a
1154         migration before the end-of-life date for FreeBSD 11.
1155
1156 20170420:
1157         GNU diff has been replaced by a BSD licensed diff. Some features of GNU
1158         diff has not been implemented, if those are needed a newer version of
1159         GNU diff is available via the diffutils package under the gdiff name.
1160
1161 20170413:
1162         As of r316810 for ipfilter, keep frags is no longer assumed when
1163         keep state is specified in a rule. r316810 aligns ipfilter with
1164         documentation in man pages separating keep frags from keep state.
1165         This allows keep state to be specified without forcing keep frags
1166         and allows keep frags to be specified independently of keep state.
1167         To maintain previous behaviour, also specify keep frags with
1168         keep state (as documented in ipf.conf.5).
1169
1170 20170407:
1171         arm64 builds now use the base system LLD 4.0.0 linker by default,
1172         instead of requiring that the aarch64-binutils port or package be
1173         installed. To continue using aarch64-binutils, set
1174         CROSS_BINUTILS_PREFIX=/usr/local/aarch64-freebsd/bin .
1175
1176 20170405:
1177         The UDP optimization in entry 20160818 that added the sysctl
1178         net.inet.udp.require_l2_bcast has been reverted.  L2 broadcast
1179         packets will no longer be treated as L3 broadcast packets.
1180
1181 20170331:
1182         Binds and sends to the loopback addresses, IPv6 and IPv4, will now
1183         use any explicitly assigned loopback address available in the jail
1184         instead of using the first assigned address of the jail.
1185
1186 20170329:
1187         The ctl.ko module no longer implements the iSCSI target frontend:
1188         cfiscsi.ko does instead.
1189
1190         If building cfiscsi.ko as a kernel module, the module can be loaded
1191         via one of the following methods:
1192         - `cfiscsi_load="YES"` in loader.conf(5).
1193         - Add `cfiscsi` to `$kld_list` in rc.conf(5).
1194         - ctladm(8)/ctld(8), when compiled with iSCSI support
1195           (`WITH_ISCSI=yes` in src.conf(5))
1196
1197         Please see cfiscsi(4) for more details.
1198
1199 20170316:
1200         The mmcsd.ko module now additionally depends on geom_flashmap.ko.
1201         Also, mmc.ko and mmcsd.ko need to be a matching pair built from the
1202         same source (previously, the dependency of mmcsd.ko on mmc.ko was
1203         missing, but mmcsd.ko now will refuse to load if it is incompatible
1204         with mmc.ko).
1205
1206 20170315:
1207         The syntax of ipfw(8) named states was changed to avoid ambiguity.
1208         If you have used named states in the firewall rules, you need to modify
1209         them after installworld and before rebooting. Now named states must
1210         be prefixed with colon.
1211
1212 20170311:
1213         The old drm (sys/dev/drm/) drivers for i915 and radeon have been
1214         removed as the userland we provide cannot use them. The KMS version
1215         (sys/dev/drm2) supports the same hardware.
1216
1217 20170302:
1218         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 4.0.0.
1219         Please see the 20141231 entry below for information about prerequisites
1220         and upgrading, if you are not already using clang 3.5.0 or higher.
1221
1222 20170221:
1223         The code that provides support for ZFS .zfs/ directory functionality
1224         has been reimplemented.  It's not possible now to create a snapshot
1225         by mkdir under .zfs/snapshot/.  That should be the only user visible
1226         change.
1227
1228 20170216:
1229         EISA bus support has been removed. The WITH_EISA option is no longer
1230         valid.
1231
1232 20170215:
1233         MCA bus support has been removed.
1234
1235 20170127:
1236         The WITH_LLD_AS_LD / WITHOUT_LLD_AS_LD build knobs have been renamed
1237         WITH_LLD_IS_LD / WITHOUT_LLD_IS_LD, for consistency with CLANG_IS_CC.
1238
1239 20170112:
1240         The EM_MULTIQUEUE kernel configuration option is deprecated now that
1241         the em(4) driver conforms to iflib specifications.
1242
1243 20170109:
1244         The igb(4), em(4) and lem(4) ethernet drivers are now implemented via
1245         IFLIB.  If you have a custom kernel configuration that excludes em(4)
1246         but you use igb(4), you need to re-add em(4) to your custom
1247         configuration.
1248
1249 20161217:
1250         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.1.
1251         Please see the 20141231 entry below for information about prerequisites
1252         and upgrading, if you are not already using clang 3.5.0 or higher.
1253
1254 20161124:
1255         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.9.0.
1256         Please see the 20141231 entry below for information about prerequisites
1257         and upgrading, if you are not already using clang 3.5.0 or higher.
1258
1259 20161119:
1260         The layout of the pmap structure has changed for powerpc to put the pmap
1261         statistics at the front for all CPU variations.  libkvm(3) and all tools
1262         that link against it need to be recompiled.
1263
1264 20161030:
1265         isl(4) and cyapa(4) drivers now require a new driver,
1266         chromebook_platform(4), to work properly on Chromebook-class hardware.
1267         On other types of hardware the drivers may need to be configured using
1268         device hints.  Please see the corresponding manual pages for details.
1269
1270 20161017:
1271         The urtwn(4) driver was merged into rtwn(4) and now consists of
1272         rtwn(4) main module + rtwn_usb(4) and rtwn_pci(4) bus-specific
1273         parts.
1274         Also, firmware for RTL8188CE was renamed due to possible name
1275         conflict (rtwnrtl8192cU(B) -> rtwnrtl8192cE(B))
1276
1277 20161015:
1278         GNU rcs has been removed from base.  It is available as packages:
1279         - rcs: Latest GPLv3 GNU rcs version.
1280         - rcs57: Copy of the latest version of GNU rcs (GPLv2) before it was
1281         removed from base.
1282
1283 20161008:
1284         Use of the cc_cdg, cc_chd, cc_hd, or cc_vegas congestion control
1285         modules now requires that the kernel configuration contain the
1286         TCP_HHOOK option. (This option is included in the GENERIC kernel.)
1287
1288 20161003:
1289         The WITHOUT_ELFCOPY_AS_OBJCOPY src.conf(5) knob has been retired.
1290         ELF Tool Chain's elfcopy is always installed as /usr/bin/objcopy.
1291
1292 20160924:
1293         Relocatable object files with the extension of .So have been renamed
1294         to use an extension of .pico instead.  The purpose of this change is
1295         to avoid a name clash with shared libraries on case-insensitive file
1296         systems.  On those file systems, foo.So is the same file as foo.so.
1297
1298 20160918:
1299         GNU rcs has been turned off by default.  It can (temporarily) be built
1300         again by adding WITH_RCS knob in src.conf.
1301         Otherwise, GNU rcs is available from packages:
1302         - rcs: Latest GPLv3 GNU rcs version.
1303         - rcs57: Copy of the latest version of GNU rcs (GPLv2) from base.
1304
1305 20160918:
1306         The backup_uses_rcs functionality has been removed from rc.subr.
1307
1308 20160908:
1309         The queue(3) debugging macro, QUEUE_MACRO_DEBUG, has been split into
1310         two separate components, QUEUE_MACRO_DEBUG_TRACE and
1311         QUEUE_MACRO_DEBUG_TRASH.  Define both for the original
1312         QUEUE_MACRO_DEBUG behavior.
1313
1314 20160824:
1315         r304787 changed some ioctl interfaces between the iSCSI userspace
1316         programs and the kernel.  ctladm, ctld, iscsictl, and iscsid must be
1317         rebuilt to work with new kernels.  __FreeBSD_version has been bumped
1318         to 1200005.
1319
1320 20160818:
1321         The UDP receive code has been updated to only treat incoming UDP
1322         packets that were addressed to an L2 broadcast address as L3
1323         broadcast packets.  It is not expected that this will affect any
1324         standards-conforming UDP application.  The new behaviour can be
1325         disabled by setting the sysctl net.inet.udp.require_l2_bcast to
1326         0.
1327
1328 20160818:
1329         Remove the openbsd_poll system call.
1330         __FreeBSD_version has been bumped because of this.
1331
1332 20160708:
1333         The stable/11 branch has been created from head@r302406.
1334
1335 20160622:
1336         The libc stub for the pipe(2) system call has been replaced with
1337         a wrapper that calls the pipe2(2) system call and the pipe(2)
1338         system call is now only implemented by the kernels that include
1339         "options COMPAT_FREEBSD10" in their config file (this is the
1340         default).  Users should ensure that this option is enabled in
1341         their kernel or upgrade userspace to r302092 before upgrading their
1342         kernel.
1343
1344 20160527:
1345         CAM will now strip leading spaces from SCSI disks' serial numbers.
1346         This will affect users who create UFS filesystems on SCSI disks using
1347         those disk's diskid device nodes.  For example, if /etc/fstab
1348         previously contained a line like
1349         "/dev/diskid/DISK-%20%20%20%20%20%20%20ABCDEFG0123456", you should
1350         change it to "/dev/diskid/DISK-ABCDEFG0123456".  Users of geom
1351         transforms like gmirror may also be affected.  ZFS users should
1352         generally be fine.
1353
1354 20160523:
1355         The bitstring(3) API has been updated with new functionality and
1356         improved performance.  But it is binary-incompatible with the old API.
1357         Objects built with the new headers may not be linked against objects
1358         built with the old headers.
1359
1360 20160520:
1361         The brk and sbrk functions have been removed from libc on arm64.
1362         Binutils from ports has been updated to not link to these
1363         functions and should be updated to the latest version before
1364         installing a new libc.
1365
1366 20160517:
1367         The armv6 port now defaults to hard float ABI. Limited support
1368         for running both hardfloat and soft float on the same system
1369         is available using the libraries installed with -DWITH_LIBSOFT.
1370         This has only been tested as an upgrade path for installworld
1371         and packages may fail or need manual intervention to run. New
1372         packages will be needed.
1373
1374         To update an existing self-hosted armv6hf system, you must add
1375         TARGET_ARCH=armv6 on the make command line for both the build
1376         and the install steps.
1377
1378 20160510:
1379         Kernel modules compiled outside of a kernel build now default to
1380         installing to /boot/modules instead of /boot/kernel.  Many kernel
1381         modules built this way (such as those in ports) already overrode
1382         KMODDIR explicitly to install into /boot/modules.  However,
1383         manually building and installing a module from /sys/modules will
1384         now install to /boot/modules instead of /boot/kernel.
1385
1386 20160414:
1387         The CAM I/O scheduler has been committed to the kernel. There should be
1388         no user visible impact. This does enable NCQ Trim on ada SSDs. While the
1389         list of known rogues that claim support for this but actually corrupt
1390         data is believed to be complete, be on the lookout for data
1391         corruption. The known rogue list is believed to be complete:
1392
1393                 o Crucial MX100, M550 drives with MU01 firmware.
1394                 o Micron M510 and M550 drives with MU01 firmware.
1395                 o Micron M500 prior to MU07 firmware
1396                 o Samsung 830, 840, and 850 all firmwares
1397                 o FCCT M500 all firmwares
1398
1399         Crucial has firmware http://www.crucial.com/usa/en/support-ssd-firmware
1400         with working NCQ TRIM. For Micron branded drives, see your sales rep for
1401         updated firmware. Black listed drives will work correctly because these
1402         drives work correctly so long as no NCQ TRIMs are sent to them. Given
1403         this list is the same as found in Linux, it's believed there are no
1404         other rogues in the market place. All other models from the above
1405         vendors work.
1406
1407         To be safe, if you are at all concerned, you can quirk each of your
1408         drives to prevent NCQ from being sent by setting:
1409                 kern.cam.ada.X.quirks="0x2"
1410         in loader.conf. If the drive requires the 4k sector quirk, set the
1411         quirks entry to 0x3.
1412
1413 20160330:
1414         The FAST_DEPEND build option has been removed and its functionality is
1415         now the one true way.  The old mkdep(1) style of 'make depend' has
1416         been removed.  See 20160311 for further details.
1417
1418 20160317:
1419         Resource range types have grown from unsigned long to uintmax_t.  All
1420         drivers, and anything using libdevinfo, need to be recompiled.
1421
1422 20160311:
1423         WITH_FAST_DEPEND is now enabled by default for in-tree and out-of-tree
1424         builds.  It no longer runs mkdep(1) during 'make depend', and the
1425         'make depend' stage can safely be skipped now as it is auto ran
1426         when building 'make all' and will generate all SRCS and DPSRCS before
1427         building anything else.  Dependencies are gathered at compile time with
1428         -MF flags kept in separate .depend files per object file.  Users should
1429         run 'make cleandepend' once if using -DNO_CLEAN to clean out older
1430         stale .depend files.
1431
1432 20160306:
1433         On amd64, clang 3.8.0 can now insert sections of type AMD64_UNWIND into
1434         kernel modules.  Therefore, if you load any kernel modules at boot time,
1435         please install the boot loaders after you install the kernel, but before
1436         rebooting, e.g.:
1437
1438         make buildworld
1439         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1440         make installkernel KERNCONF=YOUR_KERNEL_HERE
1441         make -C sys/boot install
1442         <reboot in single user>
1443
1444         Then follow the usual steps, described in the General Notes section,
1445         below.
1446
1447 20160305:
1448         Clang, llvm, lldb and compiler-rt have been upgraded to 3.8.0.  Please
1449         see the 20141231 entry below for information about prerequisites and
1450         upgrading, if you are not already using clang 3.5.0 or higher.
1451
1452 20160301:
1453         The AIO subsystem is now a standard part of the kernel.  The
1454         VFS_AIO kernel option and aio.ko kernel module have been removed.
1455         Due to stability concerns, asynchronous I/O requests are only
1456         permitted on sockets and raw disks by default.  To enable
1457         asynchronous I/O requests on all file types, set the
1458         vfs.aio.enable_unsafe sysctl to a non-zero value.
1459
1460 20160226:
1461         The ELF object manipulation tool objcopy is now provided by the
1462         ELF Tool Chain project rather than by GNU binutils. It should be a
1463         drop-in replacement, with the addition of arm64 support. The
1464         (temporary) src.conf knob WITHOUT_ELFCOPY_AS_OBJCOPY knob may be set
1465         to obtain the GNU version if necessary.
1466
1467 20160129:
1468         Building ZFS pools on top of zvols is prohibited by default.  That
1469         feature has never worked safely; it's always been prone to deadlocks.
1470         Using a zvol as the backing store for a VM guest's virtual disk will
1471         still work, even if the guest is using ZFS.  Legacy behavior can be
1472         restored by setting vfs.zfs.vol.recursive=1.
1473
1474 20160119:
1475         The NONE and HPN patches has been removed from OpenSSH.  They are
1476         still available in the security/openssh-portable port.
1477
1478 20160113:
1479         With the addition of ypldap(8), a new _ypldap user is now required
1480         during installworld. "mergemaster -p" can be used to add the user
1481         prior to installworld, as documented in the handbook.
1482
1483 20151216:
1484         The tftp loader (pxeboot) now uses the option root-path directive. As a
1485         consequence it no longer looks for a pxeboot.4th file on the tftp
1486         server. Instead it uses the regular /boot infrastructure as with the
1487         other loaders.
1488
1489 20151211:
1490         The code to start recording plug and play data into the modules has
1491         been committed. While the old tools will properly build a new kernel,
1492         a number of warnings about "unknown metadata record 4" will be produced
1493         for an older kldxref. To avoid such warnings, make sure to rebuild
1494         the kernel toolchain (or world). Make sure that you have r292078 or
1495         later when trying to build 292077 or later before rebuilding.
1496
1497 20151207:
1498         Debug data files are now built by default with 'make buildworld' and
1499         installed with 'make installworld'. This facilitates debugging but
1500         requires more disk space both during the build and for the installed
1501         world. Debug files may be disabled by setting WITHOUT_DEBUG_FILES=yes
1502         in src.conf(5).
1503
1504 20151130:
1505         r291527 changed the internal interface between the nfsd.ko and
1506         nfscommon.ko modules. As such, they must both be upgraded to-gether.
1507         __FreeBSD_version has been bumped because of this.
1508
1509 20151108:
1510         Add support for unicode collation strings leads to a change of
1511         order of files listed by ls(1) for example. To get back to the old
1512         behaviour, set LC_COLLATE environment variable to "C".
1513
1514         Databases administrators will need to reindex their databases given
1515         collation results will be different.
1516
1517         Due to a bug in install(1) it is recommended to remove the ancient
1518         locales before running make installworld.
1519
1520         rm -rf /usr/share/locale/*
1521
1522 20151030:
1523         The OpenSSL has been upgraded to 1.0.2d.  Any binaries requiring
1524         libcrypto.so.7 or libssl.so.7 must be recompiled.
1525
1526 20151020:
1527         Qlogic 24xx/25xx firmware images were updated from 5.5.0 to 7.3.0.
1528         Kernel modules isp_2400_multi and isp_2500_multi were removed and
1529         should be replaced with isp_2400 and isp_2500 modules respectively.
1530
1531 20151017:
1532         The build previously allowed using 'make -n' to not recurse into
1533         sub-directories while showing what commands would be executed, and
1534         'make -n -n' to recursively show commands.  Now 'make -n' will recurse
1535         and 'make -N' will not.
1536
1537 20151012:
1538         If you specify SENDMAIL_MC or SENDMAIL_CF in make.conf, mergemaster
1539         and etcupdate will now use this file. A custom sendmail.cf is now
1540         updated via this mechanism rather than via installworld.  If you had
1541         excluded sendmail.cf in mergemaster.rc or etcupdate.conf, you may
1542         want to remove the exclusion or change it to "always install".
1543         /etc/mail/sendmail.cf is now managed the same way regardless of
1544         whether SENDMAIL_MC/SENDMAIL_CF is used.  If you are not using
1545         SENDMAIL_MC/SENDMAIL_CF there should be no change in behavior.
1546
1547 20151011:
1548         Compatibility shims for legacy ATA device names have been removed.
1549         It includes ATA_STATIC_ID kernel option, kern.cam.ada.legacy_aliases
1550         and kern.geom.raid.legacy_aliases loader tunables, kern.devalias.*
1551         environment variables, /dev/ad* and /dev/ar* symbolic links.
1552
1553 20151006:
1554         Clang, llvm, lldb, compiler-rt and libc++ have been upgraded to 3.7.0.
1555         Please see the 20141231 entry below for information about prerequisites
1556         and upgrading, if you are not already using clang 3.5.0 or higher.
1557
1558 20150924:
1559         Kernel debug files have been moved to /usr/lib/debug/boot/kernel/,
1560         and renamed from .symbols to .debug. This reduces the size requirements
1561         on the boot partition or file system and provides consistency with
1562         userland debug files.
1563
1564         When using the supported kernel installation method the
1565         /usr/lib/debug/boot/kernel directory will be renamed (to kernel.old)
1566         as is done with /boot/kernel.
1567
1568         Developers wishing to maintain the historical behavior of installing
1569         debug files in /boot/kernel/ can set KERN_DEBUGDIR="" in src.conf(5).
1570
1571 20150827:
1572         The wireless drivers had undergone changes that remove the 'parent
1573         interface' from the ifconfig -l output. The rc.d network scripts
1574         used to check presence of a parent interface in the list, so old
1575         scripts would fail to start wireless networking. Thus, etcupdate(3)
1576         or mergemaster(8) run is required after kernel update, to update your
1577         rc.d scripts in /etc.
1578
1579 20150827:
1580         pf no longer supports 'scrub fragment crop' or 'scrub fragment drop-ovl'
1581         These configurations are now automatically interpreted as
1582         'scrub fragment reassemble'.
1583
1584 20150817:
1585         Kernel-loadable modules for the random(4) device are back. To use
1586         them, the kernel must have
1587
1588         device  random
1589         options RANDOM_LOADABLE
1590
1591         kldload(8) can then be used to load random_fortuna.ko
1592         or random_yarrow.ko. Please note that due to the indirect
1593         function calls that the loadable modules need to provide,
1594         the build-in variants will be slightly more efficient.
1595
1596         The random(4) kernel option RANDOM_DUMMY has been retired due to
1597         unpopularity. It was not all that useful anyway.
1598
1599 20150813:
1600         The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
1601         Control over building the ELF Tool Chain tools is now provided by
1602         the WITHOUT_TOOLCHAIN knob.
1603
1604 20150810:
1605         The polarity of Pulse Per Second (PPS) capture events with the
1606         uart(4) driver has been corrected.  Prior to this change the PPS
1607         "assert" event corresponded to the trailing edge of a positive PPS
1608         pulse and the "clear" event was the leading edge of the next pulse.
1609
1610         As the width of a PPS pulse in a typical GPS receiver is on the
1611         order of 1 millisecond, most users will not notice any significant
1612         difference with this change.
1613
1614         Anyone who has compensated for the historical polarity reversal by
1615         configuring a negative offset equal to the pulse width will need to
1616         remove that workaround.
1617
1618 20150809:
1619         The default group assigned to /dev/dri entries has been changed
1620         from 'wheel' to 'video' with the id of '44'. If you want to have
1621         access to the dri devices please add yourself to the video group
1622         with:
1623
1624         # pw groupmod video -m $USER
1625
1626 20150806:
1627         The menu.rc and loader.rc files will now be replaced during
1628         upgrades. Please migrate local changes to menu.rc.local and
1629         loader.rc.local instead.
1630
1631 20150805:
1632         GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
1633         strings and strip have been removed. The src.conf(5) knob
1634         WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
1635
1636 20150728:
1637         As ZFS requires more kernel stack pages than is the default on some
1638         architectures e.g. i386, it now warns if KSTACK_PAGES is less than
1639         ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
1640
1641         Please consider using 'options KSTACK_PAGES=X' where X is greater
1642         than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
1643
1644 20150706:
1645         sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
1646         and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
1647         default, i.e., they will not contain "::".  For example, instead
1648         of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
1649         to have a more specific match, such as different map entries for
1650         IPv6:0:0 vs IPv6:0.  This change requires that configuration
1651         data (including maps, files, classes, custom ruleset, etc.) must
1652         use the same format, so make certain such configuration data is
1653         upgrading.  As a very simple check search for patterns like
1654         'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
1655         behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
1656         the cf option UseCompressedIPv6Addresses.
1657
1658 20150630:
1659         The default kernel entropy-processing algorithm is now
1660         Fortuna, replacing Yarrow.
1661
1662         Assuming you have 'device random' in your kernel config
1663         file, the configurations allow a kernel option to override
1664         this default. You may choose *ONE* of:
1665
1666         options RANDOM_YARROW   # Legacy /dev/random algorithm.
1667         options RANDOM_DUMMY    # Blocking-only driver.
1668
1669         If you have neither, you get Fortuna.  For most people,
1670         read no further, Fortuna will give a /dev/random that works
1671         like it always used to, and the difference will be irrelevant.
1672
1673         If you remove 'device random', you get *NO* kernel-processed
1674         entropy at all. This may be acceptable to folks building
1675         embedded systems, but has complications. Carry on reading,
1676         and it is assumed you know what you need.
1677
1678         *PLEASE* read random(4) and random(9) if you are in the
1679         habit of tweaking kernel configs, and/or if you are a member
1680         of the embedded community, wanting specific and not-usual
1681         behaviour from your security subsystems.
1682
1683         NOTE!! If you use RANDOM_DUMMY and/or have no 'device
1684         random', you will NOT have a functioning /dev/random, and
1685         many cryptographic features will not work, including SSH.
1686         You may also find strange behaviour from the random(3) set
1687         of library functions, in particular sranddev(3), srandomdev(3)
1688         and arc4random(3). The reason for this is that the KERN_ARND
1689         sysctl only returns entropy if it thinks it has some to
1690         share, and with RANDOM_DUMMY or no 'device random' this
1691         will never happen.
1692
1693 20150623:
1694         An additional fix for the issue described in the 20150614 sendmail
1695         entry below has been committed in revision 284717.
1696
1697 20150616:
1698         FreeBSD's old make (fmake) has been removed from the system. It is
1699         available as the devel/fmake port or via pkg install fmake.
1700
1701 20150615:
1702         The fix for the issue described in the 20150614 sendmail entry
1703         below has been committed in revision 284436.  The work
1704         around described in that entry is no longer needed unless the
1705         default setting is overridden by a confDH_PARAMETERS configuration
1706         setting of '5' or pointing to a 512 bit DH parameter file.
1707
1708 20150614:
1709         ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
1710         atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
1711         and devel/kyua to version 0.20+ and adjust any calling code to work
1712         with Kyuafile and kyua.
1713
1714 20150614:
1715         The import of openssl to address the FreeBSD-SA-15:10.openssl
1716         security advisory includes a change which rejects handshakes
1717         with DH parameters below 768 bits.  sendmail releases prior
1718         to 8.15.2 (not yet released), defaulted to a 512 bit
1719         DH parameter setting for client connections.  To work around
1720         this interoperability, sendmail can be configured to use a
1721         2048 bit DH parameter by:
1722
1723         1. Edit /etc/mail/`hostname`.mc
1724         2. If a setting for confDH_PARAMETERS does not exist or
1725            exists and is set to a string beginning with '5',
1726            replace it with '2'.
1727         3. If a setting for confDH_PARAMETERS exists and is set to
1728            a file path, create a new file with:
1729                 openssl dhparam -out /path/to/file 2048
1730         4. Rebuild the .cf file:
1731                 cd /etc/mail/; make; make install
1732         5. Restart sendmail:
1733                 cd /etc/mail/; make restart
1734
1735         A sendmail patch is coming, at which time this file will be
1736         updated.
1737
1738 20150604:
1739         Generation of legacy formatted entries have been disabled by default
1740         in pwd_mkdb(8), as all base system consumers of the legacy formatted
1741         entries were converted to use the new format by default when the new,
1742         machine independent format have been added and supported since FreeBSD
1743         5.x.
1744
1745         Please see the pwd_mkdb(8) manual page for further details.
1746
1747 20150525:
1748         Clang and llvm have been upgraded to 3.6.1 release.  Please see the
1749         20141231 entry below for information about prerequisites and upgrading,
1750         if you are not already using 3.5.0 or higher.
1751
1752 20150521:
1753         TI platform code switched to using vendor DTS files and this update
1754         may break existing systems running on Beaglebone, Beaglebone Black,
1755         and Pandaboard:
1756
1757         - dtb files should be regenerated/reinstalled. Filenames are the
1758           same but content is different now
1759         - GPIO addressing was changed, now each GPIO bank (32 pins per bank)
1760           has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
1761           addressing scheme is now pin 25 on /dev/gpioc3.
1762         - Pandaboard: /etc/ttys should be updated, serial console device is
1763           now /dev/ttyu2, not /dev/ttyu0
1764
1765 20150501:
1766         soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
1767         If you need the GNU extension from groff soelim(1), install groff
1768         from package: pkg install groff, or via ports: textproc/groff.
1769
1770 20150423:
1771         chmod, chflags, chown and chgrp now affect symlinks in -R mode as
1772         defined in symlink(7); previously symlinks were silently ignored.
1773
1774 20150415:
1775         The const qualifier has been removed from iconv(3) to comply with
1776         POSIX.  The ports tree is aware of this from r384038 onwards.
1777
1778 20150416:
1779         Libraries specified by LIBADD in Makefiles must have a corresponding
1780         DPADD_<lib> variable to ensure correct dependencies.  This is now
1781         enforced in src.libnames.mk.
1782
1783 20150324:
1784         From legacy ata(4) driver was removed support for SATA controllers
1785         supported by more functional drivers ahci(4), siis(4) and mvs(4).
1786         Kernel modules ataahci and ataadaptec were removed completely,
1787         replaced by ahci and mvs modules respectively.
1788
1789 20150315:
1790         Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
1791         the 20141231 entry below for information about prerequisites and
1792         upgrading, if you are not already using 3.5.0 or higher.
1793
1794 20150307:
1795         The 32-bit PowerPC kernel has been changed to a position-independent
1796         executable. This can only be booted with a version of loader(8)
1797         newer than January 31, 2015, so make sure to update both world and
1798         kernel before rebooting.
1799
1800 20150217:
1801         If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
1802         but before r278950, the RNG was not seeded properly.  Immediately
1803         upgrade the kernel to r278950 or later and regenerate any keys (e.g.
1804         ssh keys or openssl keys) that were generated w/ a kernel from that
1805         range.  This does not affect programs that directly used /dev/random
1806         or /dev/urandom.  All userland uses of arc4random(3) are affected.
1807
1808 20150210:
1809         The autofs(4) ABI was changed in order to restore binary compatibility
1810         with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
1811         with the new kernel.
1812
1813 20150131:
1814         The powerpc64 kernel has been changed to a position-independent
1815         executable. This can only be booted with a new version of loader(8),
1816         so make sure to update both world and kernel before rebooting.
1817
1818 20150118:
1819         Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
1820         only release, no new features have been added.  Please see the 20141231
1821         entry below for information about prerequisites and upgrading, if you
1822         are not already using 3.5.0.
1823
1824 20150107:
1825         ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
1826         taken from the ELF Tool Chain project rather than GNU binutils. They
1827         should be drop-in replacements, with the addition of arm64 support.
1828         The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
1829         binutils tools, if necessary. See 20150805 for updated information.
1830
1831 20150105:
1832         The default Unbound configuration now enables remote control
1833         using a local socket.  Users who have already enabled the
1834         local_unbound service should regenerate their configuration
1835         by running "service local_unbound setup" as root.
1836
1837 20150102:
1838         The GNU texinfo and GNU info pages have been removed.
1839         To be able to view GNU info pages please install texinfo from ports.
1840
1841 20141231:
1842         Clang, llvm and lldb have been upgraded to 3.5.0 release.
1843
1844         As of this release, a prerequisite for building clang, llvm and lldb is
1845         a C++11 capable compiler and C++11 standard library.  This means that to
1846         be able to successfully build the cross-tools stage of buildworld, with
1847         clang as the bootstrap compiler, your system compiler or cross compiler
1848         should either be clang 3.3 or later, or gcc 4.8 or later, and your
1849         system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
1850         later.
1851
1852         On any standard FreeBSD 10.x or 11.x installation, where clang and
1853         libc++ are on by default (that is, on x86 or arm), this should work out
1854         of the box.
1855
1856         On 9.x installations where clang is enabled by default, e.g. on x86 and
1857         powerpc, libc++ will not be enabled by default, so libc++ should be
1858         built (with clang) and installed first.  If both clang and libc++ are
1859         missing, build clang first, then use it to build libc++.
1860
1861         On 8.x and earlier installations, upgrade to 9.x first, and then follow
1862         the instructions for 9.x above.
1863
1864         Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
1865         default, and do not build clang.
1866
1867         Many embedded systems are resource constrained, and will not be able to
1868         build clang in a reasonable time, or in some cases at all.  In those
1869         cases, cross building bootable systems on amd64 is a workaround.
1870
1871         This new version of clang introduces a number of new warnings, of which
1872         the following are most likely to appear:
1873
1874         -Wabsolute-value
1875
1876         This warns in two cases, for both C and C++:
1877         * When the code is trying to take the absolute value of an unsigned
1878           quantity, which is effectively a no-op, and almost never what was
1879           intended.  The code should be fixed, if at all possible.  If you are
1880           sure that the unsigned quantity can be safely cast to signed, without
1881           loss of information or undefined behavior, you can add an explicit
1882           cast, or disable the warning.
1883
1884         * When the code is trying to take an absolute value, but the called
1885           abs() variant is for the wrong type, which can lead to truncation.
1886           If you want to disable the warning instead of fixing the code, please
1887           make sure that truncation will not occur, or it might lead to unwanted
1888           side-effects.
1889
1890         -Wtautological-undefined-compare and
1891         -Wundefined-bool-conversion
1892
1893         These warn when C++ code is trying to compare 'this' against NULL, while
1894         'this' should never be NULL in well-defined C++ code.  However, there is
1895         some legacy (pre C++11) code out there, which actively abuses this
1896         feature, which was less strictly defined in previous C++ versions.
1897
1898         Squid and openjdk do this, for example.  The warning can be turned off
1899         for C++98 and earlier, but compiling the code in C++11 mode might result
1900         in unexpected behavior; for example, the parts of the program that are
1901         unreachable could be optimized away.
1902
1903 20141222:
1904         The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
1905         kernel sources have been removed. The .h files remain, since some
1906         utilities include them. This will need to be fixed later.
1907         If "mount -t oldnfs ..." is attempted, it will fail.
1908         If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
1909         the utilities will report errors.
1910
1911 20141121:
1912         The handling of LOCAL_LIB_DIRS has been altered to skip addition of
1913         directories to top level SUBDIR variable when their parent
1914         directory is included in LOCAL_DIRS.  Users with build systems with
1915         such hierarchies and without SUBDIR entries in the parent
1916         directory Makefiles should add them or add the directories to
1917         LOCAL_DIRS.
1918
1919 20141109:
1920         faith(4) and faithd(8) have been removed from the base system. Faith
1921         has been obsolete for a very long time.
1922
1923 20141104:
1924         vt(4), the new console driver, is enabled by default. It brings
1925         support for Unicode and double-width characters, as well as
1926         support for UEFI and integration with the KMS kernel video
1927         drivers.
1928
1929         You may need to update your console settings in /etc/rc.conf,
1930         most probably the keymap. During boot, /etc/rc.d/syscons will
1931         indicate what you need to do.
1932
1933         vt(4) still has issues and lacks some features compared to
1934         syscons(4). See the wiki for up-to-date information:
1935           https://wiki.freebsd.org/Newcons
1936
1937         If you want to keep using syscons(4), you can do so by adding
1938         the following line to /boot/loader.conf:
1939           kern.vty=sc
1940
1941 20141102:
1942         pjdfstest has been integrated into kyua as an opt-in test suite.
1943         Please see share/doc/pjdfstest/README for more details on how to
1944         execute it.
1945
1946 20141009:
1947         gperf has been removed from the base system for architectures
1948         that use clang. Ports that require gperf will obtain it from the
1949         devel/gperf port.
1950
1951 20140923:
1952         pjdfstest has been moved from tools/regression/pjdfstest to
1953         contrib/pjdfstest .
1954
1955 20140922:
1956         At svn r271982, The default linux compat kernel ABI has been adjusted
1957         to 2.6.18 in support of the linux-c6 compat ports infrastructure
1958         update.  If you wish to continue using the linux-f10 compat ports,
1959         add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
1960         encouraged to update their linux-compat packages to linux-c6 during
1961         their next update cycle.
1962
1963 20140729:
1964         The ofwfb driver, used to provide a graphics console on PowerPC when
1965         using vt(4), no longer allows mmap() of all physical memory. This
1966         will prevent Xorg on PowerPC with some ATI graphics cards from
1967         initializing properly unless x11-servers/xorg-server is updated to
1968         1.12.4_8 or newer.
1969
1970 20140723:
1971         The xdev targets have been converted to using TARGET and
1972         TARGET_ARCH instead of XDEV and XDEV_ARCH.
1973
1974 20140719:
1975         The default unbound configuration has been modified to address
1976         issues with reverse lookups on networks that use private
1977         address ranges.  If you use the local_unbound service, run
1978         "service local_unbound setup" as root to regenerate your
1979         configuration, then "service local_unbound reload" to load the
1980         new configuration.
1981
1982 20140709:
1983         The GNU texinfo and GNU info pages are not built and installed
1984         anymore, WITH_INFO knob has been added to allow to built and install
1985         them again.
1986         UPDATE: see 20150102 entry on texinfo's removal
1987
1988 20140708:
1989         The GNU readline library is now an INTERNALLIB - that is, it is
1990         statically linked into consumers (GDB and variants) in the base
1991         system, and the shared library is no longer installed.  The
1992         devel/readline port is available for third party software that
1993         requires readline.
1994
1995 20140702:
1996         The Itanium architecture (ia64) has been removed from the list of
1997         known architectures. This is the first step in the removal of the
1998         architecture.
1999
2000 20140701:
2001         Commit r268115 has added NFSv4.1 server support, merged from
2002         projects/nfsv4.1-server.  Since this includes changes to the
2003         internal interfaces between the NFS related modules, a full
2004         build of the kernel and modules will be necessary.
2005         __FreeBSD_version has been bumped.
2006
2007 20140629:
2008         The WITHOUT_VT_SUPPORT kernel config knob has been renamed
2009         WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
2010         which differs from the behaviour controlled by this knob.)
2011
2012 20140619:
2013         Maximal length of the serial number in CTL was increased from 16 to
2014         64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
2015         and ctld, need to be rebuilt to work with a new kernel.
2016
2017 20140606:
2018         The libatf-c and libatf-c++ major versions were downgraded to 0 and
2019         1 respectively to match the upstream numbers.  They were out of
2020         sync because, when they were originally added to FreeBSD, the
2021         upstream versions were not respected.  These libraries are private
2022         and not yet built by default, so renumbering them should be a
2023         non-issue.  However, unclean source trees will yield broken test
2024         programs once the operator executes "make delete-old-libs" after a
2025         "make installworld".
2026
2027         Additionally, the atf-sh binary was made private by moving it into
2028         /usr/libexec/.  Already-built shell test programs will keep the
2029         path to the old binary so they will break after "make delete-old"
2030         is run.
2031
2032         If you are using WITH_TESTS=yes (not the default), wipe the object
2033         tree and rebuild from scratch to prevent spurious test failures.
2034         This is only needed once: the misnumbered libraries and misplaced
2035         binaries have been added to OptionalObsoleteFiles.inc so they will
2036         be removed during a clean upgrade.
2037
2038 20140512:
2039         Clang and llvm have been upgraded to 3.4.1 release.
2040
2041 20140508:
2042         We bogusly installed src.opts.mk in /usr/share/mk. This file should
2043         be removed to avoid issues in the future (and has been added to
2044         ObsoleteFiles.inc).
2045
2046 20140505:
2047         /etc/src.conf now affects only builds of the FreeBSD src tree. In the
2048         past, it affected all builds that used the bsd.*.mk files. The old
2049         behavior was a bug, but people may have relied upon it. To get this
2050         behavior back, you can .include /etc/src.conf from /etc/make.conf
2051         (which is still global and isn't changed). This also changes the
2052         behavior of incremental builds inside the tree of individual
2053         directories. Set MAKESYSPATH to ".../share/mk" to do that.
2054         Although this has survived make universe and some upgrade scenarios,
2055         other upgrade scenarios may have broken. At least one form of
2056         temporary breakage was fixed with MAKESYSPATH settings for buildworld
2057         as well... In cases where MAKESYSPATH isn't working with this
2058         setting, you'll need to set it to the full path to your tree.
2059
2060         One side effect of all this cleaning up is that bsd.compiler.mk
2061         is no longer implicitly included by bsd.own.mk. If you wish to
2062         use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
2063         as well.
2064
2065 20140430:
2066         The lindev device has been removed since /dev/full has been made a
2067         standard device.  __FreeBSD_version has been bumped.
2068
2069 20140424:
2070         The knob WITHOUT_VI was added to the base system, which controls
2071         building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
2072         in order to reorder files share/termcap and didn't build ex(1) as a
2073         build tool, so building/installing with WITH_VI is highly advised for
2074         build hosts for older releases.
2075
2076         This issue has been fixed in stable/9 and stable/10 in r277022 and
2077         r276991, respectively.
2078
2079 20140418:
2080         The YES_HESIOD knob has been removed. It has been obsolete for
2081         a decade. Please move to using WITH_HESIOD instead or your builds
2082         will silently lack HESIOD.
2083
2084 20140405:
2085         The uart(4) driver has been changed with respect to its handling
2086         of the low-level console. Previously the uart(4) driver prevented
2087         any process from changing the baudrate or the CLOCAL and HUPCL
2088         control flags. By removing the restrictions, operators can make
2089         changes to the serial console port without having to reboot.
2090         However, when getty(8) is started on the serial device that is
2091         associated with the low-level console, a misconfigured terminal
2092         line in /etc/ttys will now have a real impact.
2093         Before upgrading the kernel, make sure that /etc/ttys has the
2094         serial console device configured as 3wire without baudrate to
2095         preserve the previous behaviour. E.g:
2096             ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
2097
2098 20140306:
2099         Support for libwrap (TCP wrappers) in rpcbind was disabled by default
2100         to improve performance.  To re-enable it, if needed, run rpcbind
2101         with command line option -W.
2102
2103 20140226:
2104         Switched back to the GPL dtc compiler due to updates in the upstream
2105         dts files not being supported by the BSDL dtc compiler. You will need
2106         to rebuild your kernel toolchain to pick up the new compiler. Core dumps
2107         may result while building dtb files during a kernel build if you fail
2108         to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
2109
2110 20140216:
2111         Clang and llvm have been upgraded to 3.4 release.
2112
2113 20140216:
2114         The nve(4) driver has been removed.  Please use the nfe(4) driver
2115         for NVIDIA nForce MCP Ethernet adapters instead.
2116
2117 20140212:
2118         An ABI incompatibility crept into the libc++ 3.4 import in r261283.
2119         This could cause certain C++ applications using shared libraries built
2120         against the previous version of libc++ to crash.  The incompatibility
2121         has now been fixed, but any C++ applications or shared libraries built
2122         between r261283 and r261801 should be recompiled.
2123
2124 20140204:
2125         OpenSSH will now ignore errors caused by kernel lacking of Capsicum
2126         capability mode support.  Please note that enabling the feature in
2127         kernel is still highly recommended.
2128
2129 20140131:
2130         OpenSSH is now built with sandbox support, and will use sandbox as
2131         the default privilege separation method.  This requires Capsicum
2132         capability mode support in kernel.
2133
2134 20140128:
2135         The libelf and libdwarf libraries have been updated to newer
2136         versions from upstream. Shared library version numbers for
2137         these two libraries were bumped. Any ports or binaries
2138         requiring these two libraries should be recompiled.
2139         __FreeBSD_version is bumped to 1100006.
2140
2141 20140110:
2142         If a Makefile in a tests/ directory was auto-generating a Kyuafile
2143         instead of providing an explicit one, this would prevent such
2144         Makefile from providing its own Kyuafile in the future during
2145         NO_CLEAN builds.  This has been fixed in the Makefiles but manual
2146         intervention is needed to clean an objdir if you use NO_CLEAN:
2147           # find /usr/obj -name Kyuafile | xargs rm -f
2148
2149 20131213:
2150         The behavior of gss_pseudo_random() for the krb5 mechanism
2151         has changed, for applications requesting a longer random string
2152         than produced by the underlying enctype's pseudo-random() function.
2153         In particular, the random string produced from a session key of
2154         enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
2155         be different at the 17th octet and later, after this change.
2156         The counter used in the PRF+ construction is now encoded as a
2157         big-endian integer in accordance with RFC 4402.
2158         __FreeBSD_version is bumped to 1100004.
2159
2160 20131108:
2161         The WITHOUT_ATF build knob has been removed and its functionality
2162         has been subsumed into the more generic WITHOUT_TESTS.  If you were
2163         using the former to disable the build of the ATF libraries, you
2164         should change your settings to use the latter.
2165
2166 20131025:
2167         The default version of mtree is nmtree which is obtained from
2168         NetBSD.  The output is generally the same, but may vary
2169         slightly.  If you found you need identical output adding
2170         "-F freebsd9" to the command line should do the trick.  For the
2171         time being, the old mtree is available as fmtree.
2172
2173 20131014:
2174         libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
2175         This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
2176         1.1.4_8 and verify bsdyml not linked in, before running "make
2177         delete-old-libs":
2178           # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
2179           or
2180           # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
2181
2182 20131010:
2183         The stable/10 branch has been created in subversion from head
2184         revision r256279.
2185
2186 COMMON ITEMS:
2187
2188         General Notes
2189         -------------
2190         Sometimes, obscure build problems are the result of environment
2191         poisoning.  This can happen because the make utility reads its
2192         environment when searching for values for global variables.  To run
2193         your build attempts in an "environmental clean room", prefix all make
2194         commands with 'env -i '.  See the env(1) manual page for more details.
2195         Occasionally a build failure will occur with "make -j" due to a race
2196         condition.  If this happens try building again without -j, and please
2197         report a bug if it happens consistently.
2198
2199         When upgrading from one major version to another it is generally best to
2200         upgrade to the latest code in the currently installed branch first, then
2201         do an upgrade to the new branch. This is the best-tested upgrade path,
2202         and has the highest probability of being successful.  Please try this
2203         approach if you encounter problems with a major version upgrade.  Since
2204         the stable 4.x branch point, one has generally been able to upgrade from
2205         anywhere in the most recent stable branch to head / current (or even the
2206         last couple of stable branches). See the top of this file when there's
2207         an exception.
2208
2209         The update process will emit an error on an attempt to perform a build
2210         or install from a FreeBSD version below the earliest supported version.
2211         When updating from an older version the update should be performed one
2212         major release at a time, including running `make delete-old` at each
2213         step.
2214
2215         When upgrading a live system, having a root shell around before
2216         installing anything can help undo problems. Not having a root shell
2217         around can lead to problems if pam has changed too much from your
2218         starting point to allow continued authentication after the upgrade.
2219
2220         This file should be read as a log of events. When a later event changes
2221         information of a prior event, the prior event should not be deleted.
2222         Instead, a pointer to the entry with the new information should be
2223         placed in the old entry. Readers of this file should also sanity check
2224         older entries before relying on them blindly. Authors of new entries
2225         should write them with this in mind.
2226
2227         ZFS notes
2228         ---------
2229         When upgrading the boot ZFS pool to a new version, always follow
2230         these two steps:
2231
2232         1.) recompile and reinstall the ZFS boot loader and boot block
2233         (this is part of "make buildworld" and "make installworld")
2234
2235         2.) update the ZFS boot block on your boot drive
2236
2237         The following example updates the ZFS boot block on the
2238         freebsd-boot partition of a GPT partitioned drive ada0:
2239         "gpart bootcode -p /boot/gptzfsboot -i $N ada0"
2240         The value $N will typically be 1 (if booting from BIOS) or 2 (if
2241         booting from EFI).
2242
2243         Non-boot pools do not need these updates.
2244
2245         To build a kernel
2246         -----------------
2247         If you are updating from a prior version of FreeBSD (even one just
2248         a few days old), you should follow this procedure.  It is the most
2249         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
2250
2251         make kernel-toolchain
2252         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
2253         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
2254
2255         To test a kernel once
2256         ---------------------
2257         If you just want to boot a kernel once (because you are not sure
2258         if it works, or if you want to boot a known bad kernel to provide
2259         debugging information) run
2260         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
2261         nextboot -k testkernel
2262
2263         To rebuild everything and install it on the current system.
2264         -----------------------------------------------------------
2265         # Note: sometimes if you are running current you gotta do more than
2266         # is listed here if you are upgrading from a really old current.
2267
2268         <make sure you have good level 0 dumps>
2269         make buildworld
2270         make buildkernel KERNCONF=YOUR_KERNEL_HERE
2271         make installkernel KERNCONF=YOUR_KERNEL_HERE
2272                                                         [1]
2273         <reboot in single user>                         [3]
2274         mergemaster -Fp                                 [5]
2275         make installworld
2276         mergemaster -Fi                                 [4]
2277         make delete-old                                 [6]
2278         <reboot>
2279
2280         To cross-install current onto a separate partition
2281         --------------------------------------------------
2282         # In this approach we use a separate partition to hold
2283         # current's root, 'usr', and 'var' directories.   A partition
2284         # holding "/", "/usr" and "/var" should be about 2GB in
2285         # size.
2286
2287         <make sure you have good level 0 dumps>
2288         <boot into -stable>
2289         make buildworld
2290         make buildkernel KERNCONF=YOUR_KERNEL_HERE
2291         <maybe newfs current's root partition>
2292         <mount current's root partition on directory ${CURRENT_ROOT}>
2293         make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
2294         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
2295         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
2296         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
2297         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
2298         <reboot into current>
2299         <do a "native" rebuild/install as described in the previous section>
2300         <maybe install compatibility libraries from ports/misc/compat*>
2301         <reboot>
2302
2303
2304         To upgrade in-place from stable to current
2305         ----------------------------------------------
2306         <make sure you have good level 0 dumps>
2307         make buildworld                                 [9]
2308         make buildkernel KERNCONF=YOUR_KERNEL_HERE      [8]
2309         make installkernel KERNCONF=YOUR_KERNEL_HERE
2310                                                         [1]
2311         <reboot in single user>                         [3]
2312         mergemaster -Fp                                 [5]
2313         make installworld
2314         mergemaster -Fi                                 [4]
2315         make delete-old                                 [6]
2316         <reboot>
2317
2318         Make sure that you've read the UPDATING file to understand the
2319         tweaks to various things you need.  At this point in the life
2320         cycle of current, things change often and you are on your own
2321         to cope.  The defaults can also change, so please read ALL of
2322         the UPDATING entries.
2323
2324         Also, if you are tracking -current, you must be subscribed to
2325         freebsd-current@freebsd.org.  Make sure that before you update
2326         your sources that you have read and understood all the recent
2327         messages there.  If in doubt, please track -stable which has
2328         much fewer pitfalls.
2329
2330         [1] If you have third party modules, such as vmware, you should disable
2331         them at this point so they don't crash your system on
2332         reboot. Alternatively, you should rebuild all the modules you have in
2333         your system and install them as well.  If you are running -current, you
2334         should seriously consider placing all sources to all the modules for
2335         your system (or symlinks to them) in /usr/local/sys/modules so this
2336         happens automatically. If all your modules come from ports, then adding
2337         the port origin directories to PORTS_MODULES instead is also automatic
2338         and effective, eg:
2339              PORTS_MODULES+=x11/nvidia-driver
2340
2341         [3] From the bootblocks, boot -s, and then do
2342                 fsck -p
2343                 mount -u /
2344                 mount -a
2345                 sh /etc/rc.d/zfs start  # mount zfs filesystem, if needed
2346                 cd src                  # full path to source
2347                 adjkerntz -i            # if CMOS is wall time
2348         Also, when doing a major release upgrade, it is required that you boot
2349         into single user mode to do the installworld.
2350
2351         [4] Note: This step is non-optional.  Failure to do this step
2352         can result in a significant reduction in the functionality of the
2353         system.  Attempting to do it by hand is not recommended and those
2354         that pursue this avenue should read this file carefully, as well
2355         as the archives of freebsd-current and freebsd-hackers mailing lists
2356         for potential gotchas.  The -U option is also useful to consider.
2357         See mergemaster(8) for more information.
2358
2359         [5] Usually this step is a no-op.  However, from time to time
2360         you may need to do this if you get unknown user in the following
2361         step.  It never hurts to do it all the time.  You may need to
2362         install a new mergemaster (cd src/usr.sbin/mergemaster && make
2363         install) after the buildworld before this step if you last updated
2364         from current before 20130425 or from -stable before 20130430.
2365
2366         [6] This only deletes old files and directories. Old libraries
2367         can be deleted by "make delete-old-libs", but you have to make
2368         sure that no program is using those libraries anymore.
2369
2370         [8] The new kernel must be able to run existing binaries used by an
2371         installworld.  When upgrading across major versions, the new kernel's
2372         configuration must include the correct COMPAT_FREEBSD<n> option for
2373         existing binaries (e.g. COMPAT_FREEBSD11 to run 11.x binaries).  Failure
2374         to do so may leave you with a system that is hard to boot to recover. A
2375         GENERIC kernel will include suitable compatibility options to run
2376         binaries from older branches.  Note that the ability to run binaries
2377         from unsupported branches is not guaranteed.
2378
2379         Make sure that you merge any new devices from GENERIC since the
2380         last time you updated your kernel config file. Options also
2381         change over time, so you may need to adjust your custom kernels
2382         for these as well.
2383
2384         [9] If CPUTYPE is defined in your /etc/make.conf, make sure to use the
2385         "?=" instead of the "=" assignment operator, so that buildworld can
2386         override the CPUTYPE if it needs to.
2387
2388         MAKEOBJDIRPREFIX must be defined in an environment variable, and
2389         not on the command line, or in /etc/make.conf.  buildworld will
2390         warn if it is improperly defined.
2391 FORMAT:
2392
2393 This file contains a list, in reverse chronological order, of major
2394 breakages in tracking -current.  It is not guaranteed to be a complete
2395 list of such breakages, and only contains entries since September 23, 2011.
2396 If you need to see UPDATING entries from before that date, you will need
2397 to fetch an UPDATING file from an older FreeBSD release.
2398
2399 Copyright information:
2400
2401 Copyright 1998-2009 M. Warner Losh <imp@FreeBSD.org>
2402
2403 Redistribution, publication, translation and use, with or without
2404 modification, in full or in part, in any form or format of this
2405 document are permitted without further permission from the author.
2406
2407 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
2408 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
2409 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
2410 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
2411 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
2412 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
2413 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
2414 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
2415 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
2416 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
2417 POSSIBILITY OF SUCH DAMAGE.
2418
2419 Contact Warner Losh if you have any questions about your use of
2420 this document.
2421
2422 $FreeBSD$