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