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