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