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