]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
MFV r285025: 6033 arc_adjust() should search MFU lists for oldest buffer
[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     http://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 from
17 older version of current across the gcc/clang cutover is a bit fragile.
18
19 NOTE TO PEOPLE WHO THINK THAT FreeBSD 11.x IS SLOW:
20         FreeBSD 11.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 20150813:
35         The WITHOUT_ELFTOOLCHAIN_TOOLS src.conf(5) knob has been retired.
36         Control over building the ELF Tool Chain tools is now provided by
37         the WITHOUT_TOOLCHAIN knob.
38
39 20150810:
40         The polarity of Pulse Per Second (PPS) capture events with the
41         uart(4) driver has been corrected.  Prior to this change the PPS
42         "assert" event corresponded to the trailing edge of a positive PPS
43         pulse and the "clear" event was the leading edge of the next pulse.
44
45         As the width of a PPS pulse in a typical GPS receiver is on the
46         order of 1 millisecond, most users will not notice any significant
47         difference with this change.
48
49         Anyone who has compensated for the historical polarity reversal by
50         configuring a negative offset equal to the pulse width will need to
51         remove that workaround.
52
53 20150809:
54         The default group assigned to /dev/dri entries has been changed
55         from 'wheel' to 'video' with the id of '44'. If you want to have
56         access to the dri devices please add yourself to the video group
57         with:
58
59         # pw groupmod video -m $USER
60
61 20150806:
62         The menu.rc and loader.rc files will now be replaced during 
63         upgrades. Please migrate local changes to menu.rc.local and
64         loader.rc.local instead.
65
66 20150805:
67         GNU Binutils versions of addr2line, c++filt, nm, readelf, size,
68         strings and strip have been removed. The src.conf(5) knob
69         WITHOUT_ELFTOOLCHAIN_TOOLS no longer provides the binutils tools.
70
71 20150728:
72         As ZFS requires more kernel stack pages than is the default on some
73         architectures e.g. i386, it now warns if KSTACK_PAGES is less than
74         ZFS_MIN_KSTACK_PAGES (which is 4 at the time of writing).
75
76         Please consider using 'options KSTACK_PAGES=X' where X is greater
77         than or equal to ZFS_MIN_KSTACK_PAGES i.e. 4 in such configurations.
78
79 20150706:
80         sendmail has been updated to 8.15.2.  Starting with FreeBSD 11.0
81         and sendmail 8.15, sendmail uses uncompressed IPv6 addresses by
82         default, i.e., they will not contain "::".  For example, instead
83         of ::1, it will be 0:0:0:0:0:0:0:1.  This permits a zero subnet
84         to have a more specific match, such as different map entries for
85         IPv6:0:0 vs IPv6:0.  This change requires that configuration
86         data (including maps, files, classes, custom ruleset, etc.) must
87         use the same format, so make certain such configuration data is
88         upgrading.  As a very simple check search for patterns like
89         'IPv6:[0-9a-fA-F:]*::' and 'IPv6::'.  To return to the old
90         behavior, set the m4 option confUSE_COMPRESSED_IPV6_ADDRESSES or
91         the cf option UseCompressedIPv6Addresses.
92
93 20150630:
94         The default kernel entropy-processing algorithm is now
95         Fortuna, replacing Yarrow.
96
97         Assuming you have 'device random' in your kernel config
98         file, the configurations allow a kernel option to override
99         this default. You may choose *ONE* of:
100
101         options RANDOM_YARROW   # Legacy /dev/random algorithm.
102         options RANDOM_DUMMY    # Blocking-only driver.
103
104         If you have neither, you get Fortuna.  For most people,
105         read no further, Fortuna will give a /dev/random that works
106         like it always used to, and the difference will be irrelevant.
107
108         If you remove 'device random', you get *NO* kernel-processed
109         entopy at all. This may be acceptable to folks building
110         embedded systems, but has complications. Carry on reading,
111         and it is assumed you know what you need.
112
113         *PLEASE* read random(4) and random(9) if you are in the
114         habit of tweeking kernel configs, and/or if you are a member
115         of the embedded community, wanting specific and not-usual
116         behaviour from your security subsystems.
117
118         NOTE!! If you use RANDOM_DUMMY and/or have no 'device
119         random', you will NOT have a functioning /dev/random, and
120         many cryptographic features will not work, including SSH.
121         You may also find strange behaviour from the random(3) set
122         of library functions, in particular sranddev(3), srandomdev(3)
123         and arc4random(3). The reason for this is that the KERN_ARND
124         sysctl only returns entropy if it thinks it has some to
125         share, and with RANDOM_DUMMY or no 'device random' this
126         will never happen.
127
128 20150623:
129         An additional fix for the issue described in the 20150614 sendmail
130         entry below has been been committed in revision 284717.
131
132 20150616:
133         FreeBSD's old make (fmake) has been removed from the system. It is
134         available as the devel/fmake port or via pkg install fmake.
135
136 20150615:
137         The fix for the issue described in the 20150614 sendmail entry
138         below has been been committed in revision 284436.  The work
139         around described in that entry is no longer needed unless the
140         default setting is overridden by a confDH_PARAMETERS configuration
141         setting of '5' or pointing to a 512 bit DH parameter file.
142
143 20150614:
144         ALLOW_DEPRECATED_ATF_TOOLS/ATFFILE support has been removed from
145         atf.test.mk (included from bsd.test.mk). Please upgrade devel/atf
146         and devel/kyua to version 0.20+ and adjust any calling code to work
147         with Kyuafile and kyua.
148
149 20150614:
150         The import of openssl to address the FreeBSD-SA-15:10.openssl
151         security advisory includes a change which rejects handshakes
152         with DH parameters below 768 bits.  sendmail releases prior
153         to 8.15.2 (not yet released), defaulted to a 512 bit
154         DH parameter setting for client connections.  To work around
155         this interoperability, sendmail can be configured to use a
156         2048 bit DH parameter by:
157
158         1. Edit /etc/mail/`hostname`.mc
159         2. If a setting for confDH_PARAMETERS does not exist or
160            exists and is set to a string beginning with '5',
161            replace it with '2'.
162         3. If a setting for confDH_PARAMETERS exists and is set to
163            a file path, create a new file with:
164                 openssl dhparam -out /path/to/file 2048
165         4. Rebuild the .cf file:
166                 cd /etc/mail/; make; make install
167         5. Restart sendmail:
168                 cd /etc/mail/; make restart
169
170         A sendmail patch is coming, at which time this file will be
171         updated.
172
173 20150604:
174         Generation of legacy formatted entries have been disabled by default
175         in pwd_mkdb(8), as all base system consumers of the legacy formatted
176         entries were converted to use the new format by default when the new,
177         machine independent format have been added and supported since FreeBSD
178         5.x.
179
180         Please see the pwd_mkdb(8) manual page for further details.
181
182 20150525:
183         Clang and llvm have been upgraded to 3.6.1 release.  Please see the
184         20141231 entry below for information about prerequisites and upgrading,
185         if you are not already using 3.5.0 or higher.
186
187 20150521:
188         TI platform code switched to using vendor DTS files and this update
189         may break existing systems running on Beaglebone, Beaglebone Black,
190         and Pandaboard:
191
192         - dtb files should be regenerated/reinstalled. Filenames are the
193           same but content is different now
194         - GPIO addressing was changed, now each GPIO bank (32 pins per bank)
195           has its own /dev/gpiocX device, e.g. pin 121 on /dev/gpioc0 in old
196           addressing scheme is now pin 25 on /dev/gpioc3.
197         - Pandaboard: /etc/ttys should be updated, serial console device is
198           now /dev/ttyu2, not /dev/ttyu0
199
200 20150501:
201         soelim(1) from gnu/usr.bin/groff has been replaced by usr.bin/soelim.
202         If you need the GNU extension from groff soelim(1), install groff
203         from package: pkg install groff, or via ports: textproc/groff.
204
205 20150423:
206         chmod, chflags, chown and chgrp now affect symlinks in -R mode as
207         defined in symlink(7); previously symlinks were silently ignored.
208
209 20150415:
210         The const qualifier has been removed from iconv(3) to comply with
211         POSIX.  The ports tree is aware of this from r384038 onwards.
212
213 20150416:
214         Libraries specified by LIBADD in Makefiles must have a corresponding
215         DPADD_<lib> variable to ensure correct dependencies.  This is now
216         enforced in src.libnames.mk.
217
218 20150324:
219         From legacy ata(4) driver was removed support for SATA controllers
220         supported by more functional drivers ahci(4), siis(4) and mvs(4).
221         Kernel modules ataahci and ataadaptec were removed completely,
222         replaced by ahci and mvs modules respectively.
223
224 20150315:
225         Clang, llvm and lldb have been upgraded to 3.6.0 release.  Please see
226         the 20141231 entry below for information about prerequisites and
227         upgrading, if you are not already using 3.5.0 or higher.
228
229 20150307:
230         The 32-bit PowerPC kernel has been changed to a position-independent
231         executable. This can only be booted with a version of loader(8)
232         newer than January 31, 2015, so make sure to update both world and
233         kernel before rebooting.
234
235 20150217:
236         If you are running a -CURRENT kernel since r273872 (Oct 30th, 2014),
237         but before r278950, the RNG was not seeded properly.  Immediately
238         upgrade the kernel to r278950 or later and regenerate any keys (e.g.
239         ssh keys or openssl keys) that were generated w/ a kernel from that
240         range.  This does not affect programs that directly used /dev/random
241         or /dev/urandom.  All userland uses of arc4random(3) are affected.
242
243 20150210:
244         The autofs(4) ABI was changed in order to restore binary compatibility
245         with 10.1-RELEASE.  The automountd(8) daemon needs to be rebuilt to work
246         with the new kernel.
247
248 20150131:
249         The powerpc64 kernel has been changed to a position-independent
250         executable. This can only be booted with a new version of loader(8),
251         so make sure to update both world and kernel before rebooting.
252
253 20150118:
254         Clang and llvm have been upgraded to 3.5.1 release.  This is a bugfix
255         only release, no new features have been added.  Please see the 20141231
256         entry below for information about prerequisites and upgrading, if you
257         are not already using 3.5.0.
258
259 20150107:
260         ELF tools addr2line, elfcopy (strip), nm, size, and strings are now
261         taken from the ELF Tool Chain project rather than GNU binutils. They
262         should be drop-in replacements, with the addition of arm64 support.
263         The WITHOUT_ELFTOOLCHAIN_TOOLS= knob may be used to obtain the
264         binutils tools, if necessary. See 20150805 for updated information.
265
266 20150105:
267         The default Unbound configuration now enables remote control
268         using a local socket.  Users who have already enabled the
269         local_unbound service should regenerate their configuration
270         by running "service local_unbound setup" as root.
271
272 20150102:
273         The GNU texinfo and GNU info pages have been removed.
274         To be able to view GNU info pages please install texinfo from ports.
275
276 20141231:
277         Clang, llvm and lldb have been upgraded to 3.5.0 release.
278
279         As of this release, a prerequisite for building clang, llvm and lldb is
280         a C++11 capable compiler and C++11 standard library.  This means that to
281         be able to successfully build the cross-tools stage of buildworld, with
282         clang as the bootstrap compiler, your system compiler or cross compiler
283         should either be clang 3.3 or later, or gcc 4.8 or later, and your
284         system C++ library should be libc++, or libdstdc++ from gcc 4.8 or
285         later.
286
287         On any standard FreeBSD 10.x or 11.x installation, where clang and
288         libc++ are on by default (that is, on x86 or arm), this should work out
289         of the box.
290
291         On 9.x installations where clang is enabled by default, e.g. on x86 and
292         powerpc, libc++ will not be enabled by default, so libc++ should be
293         built (with clang) and installed first.  If both clang and libc++ are
294         missing, build clang first, then use it to build libc++.
295
296         On 8.x and earlier installations, upgrade to 9.x first, and then follow
297         the instructions for 9.x above.
298
299         Sparc64 and mips users are unaffected, as they still use gcc 4.2.1 by
300         default, and do not build clang.
301
302         Many embedded systems are resource constrained, and will not be able to
303         build clang in a reasonable time, or in some cases at all.  In those
304         cases, cross building bootable systems on amd64 is a workaround.
305
306         This new version of clang introduces a number of new warnings, of which
307         the following are most likely to appear:
308
309         -Wabsolute-value
310
311         This warns in two cases, for both C and C++:
312         * When the code is trying to take the absolute value of an unsigned
313           quantity, which is effectively a no-op, and almost never what was
314           intended.  The code should be fixed, if at all possible.  If you are
315           sure that the unsigned quantity can be safely cast to signed, without
316           loss of information or undefined behavior, you can add an explicit
317           cast, or disable the warning.
318
319         * When the code is trying to take an absolute value, but the called
320           abs() variant is for the wrong type, which can lead to truncation.
321           If you want to disable the warning instead of fixing the code, please
322           make sure that truncation will not occur, or it might lead to unwanted
323           side-effects.
324
325         -Wtautological-undefined-compare and
326         -Wundefined-bool-conversion
327
328         These warn when C++ code is trying to compare 'this' against NULL, while
329         'this' should never be NULL in well-defined C++ code.  However, there is
330         some legacy (pre C++11) code out there, which actively abuses this
331         feature, which was less strictly defined in previous C++ versions.
332
333         Squid and openjdk do this, for example.  The warning can be turned off
334         for C++98 and earlier, but compiling the code in C++11 mode might result
335         in unexpected behavior; for example, the parts of the program that are
336         unreachable could be optimized away.
337
338 20141222:
339         The old NFS client and server (kernel options NFSCLIENT, NFSSERVER)
340         kernel sources have been removed. The .h files remain, since some
341         utilities include them. This will need to be fixed later.
342         If "mount -t oldnfs ..." is attempted, it will fail.
343         If the "-o" option on mountd(8), nfsd(8) or nfsstat(1) is used,
344         the utilities will report errors.
345
346 20141121:
347         The handling of LOCAL_LIB_DIRS has been altered to skip addition of
348         directories to top level SUBDIR variable when their parent
349         directory is included in LOCAL_DIRS.  Users with build systems with
350         such hierarchies and without SUBDIR entries in the parent
351         directory Makefiles should add them or add the directories to
352         LOCAL_DIRS.
353
354 20141109:
355         faith(4) and faithd(8) have been removed from the base system. Faith
356         has been obsolete for a very long time.
357
358 20141104:
359         vt(4), the new console driver, is enabled by default. It brings
360         support for Unicode and double-width characters, as well as
361         support for UEFI and integration with the KMS kernel video
362         drivers.
363
364         You may need to update your console settings in /etc/rc.conf,
365         most probably the keymap. During boot, /etc/rc.d/syscons will
366         indicate what you need to do.
367
368         vt(4) still has issues and lacks some features compared to
369         syscons(4). See the wiki for up-to-date information:
370           https://wiki.freebsd.org/Newcons
371
372         If you want to keep using syscons(4), you can do so by adding
373         the following line to /boot/loader.conf:
374           kern.vty=sc
375
376 20141102:
377         pjdfstest has been integrated into kyua as an opt-in test suite.
378         Please see share/doc/pjdfstest/README for more details on how to
379         execute it.
380
381 20141009:
382         gperf has been removed from the base system for architectures
383         that use clang. Ports that require gperf will obtain it from the
384         devel/gperf port.
385
386 20140923:
387         pjdfstest has been moved from tools/regression/pjdfstest to
388         contrib/pjdfstest .
389
390 20140922:
391         At svn r271982, The default linux compat kernel ABI has been adjusted
392         to 2.6.18 in support of the linux-c6 compat ports infrastructure
393         update.  If you wish to continue using the linux-f10 compat ports,
394         add compat.linux.osrelease=2.6.16 to your local sysctl.conf.  Users are
395         encouraged to update their linux-compat packages to linux-c6 during
396         their next update cycle.
397
398 20140729:
399         The ofwfb driver, used to provide a graphics console on PowerPC when
400         using vt(4), no longer allows mmap() of all physical memory. This
401         will prevent Xorg on PowerPC with some ATI graphics cards from
402         initializing properly unless x11-servers/xorg-server is updated to
403         1.12.4_8 or newer.
404
405 20140723:
406         The xdev targets have been converted to using TARGET and
407         TARGET_ARCH instead of XDEV and XDEV_ARCH.
408
409 20140719:
410         The default unbound configuration has been modified to address
411         issues with reverse lookups on networks that use private
412         address ranges.  If you use the local_unbound service, run
413         "service local_unbound setup" as root to regenerate your
414         configuration, then "service local_unbound reload" to load the
415         new configuration.
416
417 20140709:
418         The GNU texinfo and GNU info pages are not built and installed
419         anymore, WITH_INFO knob has been added to allow to built and install
420         them again.
421         UPDATE: see 20150102 entry on texinfo's removal
422
423 20140708:
424         The GNU readline library is now an INTERNALLIB - that is, it is
425         statically linked into consumers (GDB and variants) in the base
426         system, and the shared library is no longer installed.  The
427         devel/readline port is available for third party software that
428         requires readline.
429
430 20140702:
431         The Itanium architecture (ia64) has been removed from the list of
432         known architectures. This is the first step in the removal of the
433         architecture.
434
435 20140701:
436         Commit r268115 has added NFSv4.1 server support, merged from
437         projects/nfsv4.1-server.  Since this includes changes to the
438         internal interfaces between the NFS related modules, a full
439         build of the kernel and modules will be necessary.
440         __FreeBSD_version has been bumped.
441
442 20140629:
443         The WITHOUT_VT_SUPPORT kernel config knob has been renamed
444         WITHOUT_VT.  (The other _SUPPORT knobs have a consistent meaning
445         which differs from the behaviour controlled by this knob.)
446
447 20140619:
448         Maximal length of the serial number in CTL was increased from 16 to
449         64 chars, that breaks ABI.  All CTL-related tools, such as ctladm
450         and ctld, need to be rebuilt to work with a new kernel.
451
452 20140606:
453         The libatf-c and libatf-c++ major versions were downgraded to 0 and
454         1 respectively to match the upstream numbers.  They were out of
455         sync because, when they were originally added to FreeBSD, the
456         upstream versions were not respected.  These libraries are private
457         and not yet built by default, so renumbering them should be a
458         non-issue.  However, unclean source trees will yield broken test
459         programs once the operator executes "make delete-old-libs" after a
460         "make installworld".
461
462         Additionally, the atf-sh binary was made private by moving it into
463         /usr/libexec/.  Already-built shell test programs will keep the
464         path to the old binary so they will break after "make delete-old"
465         is run.
466
467         If you are using WITH_TESTS=yes (not the default), wipe the object
468         tree and rebuild from scratch to prevent spurious test failures.
469         This is only needed once: the misnumbered libraries and misplaced
470         binaries have been added to OptionalObsoleteFiles.inc so they will
471         be removed during a clean upgrade.
472
473 20140512:
474         Clang and llvm have been upgraded to 3.4.1 release.
475
476 20140508:
477         We bogusly installed src.opts.mk in /usr/share/mk. This file should
478         be removed to avoid issues in the future (and has been added to
479         ObsoleteFiles.inc).
480
481 20140505:
482         /etc/src.conf now affects only builds of the FreeBSD src tree. In the
483         past, it affected all builds that used the bsd.*.mk files. The old
484         behavior was a bug, but people may have relied upon it. To get this
485         behavior back, you can .include /etc/src.conf from /etc/make.conf
486         (which is still global and isn't changed). This also changes the
487         behavior of incremental builds inside the tree of individual
488         directories. Set MAKESYSPATH to ".../share/mk" to do that.
489         Although this has survived make universe and some upgrade scenarios,
490         other upgrade scenarios may have broken. At least one form of
491         temporary breakage was fixed with MAKESYSPATH settings for buildworld
492         as well... In cases where MAKESYSPATH isn't working with this
493         setting, you'll need to set it to the full path to your tree.
494
495         One side effect of all this cleaning up is that bsd.compiler.mk
496         is no longer implicitly included by bsd.own.mk. If you wish to
497         use COMPILER_TYPE, you must now explicitly include bsd.compiler.mk
498         as well.
499
500 20140430:
501         The lindev device has been removed since /dev/full has been made a
502         standard device.  __FreeBSD_version has been bumped.
503
504 20140424:
505         The knob WITHOUT_VI was added to the base system, which controls
506         building ex(1), vi(1), etc. Older releases of FreeBSD required ex(1)
507         in order to reorder files share/termcap and didn't build ex(1) as a
508         build tool, so building/installing with WITH_VI is highly advised for
509         build hosts for older releases.
510
511         This issue has been fixed in stable/9 and stable/10 in r277022 and
512         r276991, respectively.
513
514 20140418:
515         The YES_HESIOD knob has been removed. It has been obsolete for
516         a decade. Please move to using WITH_HESIOD instead or your builds
517         will silently lack HESIOD.
518
519 20140405:
520         The uart(4) driver has been changed with respect to its handling
521         of the low-level console. Previously the uart(4) driver prevented
522         any process from changing the baudrate or the CLOCAL and HUPCL
523         control flags. By removing the restrictions, operators can make
524         changes to the serial console port without having to reboot.
525         However, when getty(8) is started on the serial device that is
526         associated with the low-level console, a misconfigured terminal
527         line in /etc/ttys will now have a real impact.
528         Before upgrading the kernel, make sure that /etc/ttys has the
529         serial console device configured as 3wire without baudrate to
530         preserve the previous behaviour. E.g:
531             ttyu0  "/usr/libexec/getty 3wire"  vt100  on  secure
532
533 20140306:
534         Support for libwrap (TCP wrappers) in rpcbind was disabled by default
535         to improve performance.  To re-enable it, if needed, run rpcbind
536         with command line option -W.
537
538 20140226:
539         Switched back to the GPL dtc compiler due to updates in the upstream
540         dts files not being supported by the BSDL dtc compiler. You will need
541         to rebuild your kernel toolchain to pick up the new compiler. Core dumps
542         may result while building dtb files during a kernel build if you fail
543         to do so. Set WITHOUT_GPL_DTC if you require the BSDL compiler.
544
545 20140216:
546         Clang and llvm have been upgraded to 3.4 release.
547
548 20140216:
549         The nve(4) driver has been removed.  Please use the nfe(4) driver
550         for NVIDIA nForce MCP Ethernet adapters instead.
551
552 20140212:
553         An ABI incompatibility crept into the libc++ 3.4 import in r261283.
554         This could cause certain C++ applications using shared libraries built
555         against the previous version of libc++ to crash.  The incompatibility
556         has now been fixed, but any C++ applications or shared libraries built
557         between r261283 and r261801 should be recompiled.
558
559 20140204:
560         OpenSSH will now ignore errors caused by kernel lacking of Capsicum
561         capability mode support.  Please note that enabling the feature in
562         kernel is still highly recommended.
563
564 20140131:
565         OpenSSH is now built with sandbox support, and will use sandbox as
566         the default privilege separation method.  This requires Capsicum
567         capability mode support in kernel.
568
569 20140128:
570         The libelf and libdwarf libraries have been updated to newer
571         versions from upstream. Shared library version numbers for
572         these two libraries were bumped. Any ports or binaries
573         requiring these two libraries should be recompiled.
574         __FreeBSD_version is bumped to 1100006.
575
576 20140110:
577         If a Makefile in a tests/ directory was auto-generating a Kyuafile
578         instead of providing an explicit one, this would prevent such
579         Makefile from providing its own Kyuafile in the future during
580         NO_CLEAN builds.  This has been fixed in the Makefiles but manual
581         intervention is needed to clean an objdir if you use NO_CLEAN:
582           # find /usr/obj -name Kyuafile | xargs rm -f
583
584 20131213:
585         The behavior of gss_pseudo_random() for the krb5 mechanism
586         has changed, for applications requesting a longer random string
587         than produced by the underlying enctype's pseudo-random() function.
588         In particular, the random string produced from a session key of
589         enctype aes256-cts-hmac-sha1-96 or aes256-cts-hmac-sha1-96 will
590         be different at the 17th octet and later, after this change.
591         The counter used in the PRF+ construction is now encoded as a
592         big-endian integer in accordance with RFC 4402.
593         __FreeBSD_version is bumped to 1100004.
594
595 20131108:
596         The WITHOUT_ATF build knob has been removed and its functionality
597         has been subsumed into the more generic WITHOUT_TESTS.  If you were
598         using the former to disable the build of the ATF libraries, you
599         should change your settings to use the latter.
600
601 20131025:
602         The default version of mtree is nmtree which is obtained from
603         NetBSD.  The output is generally the same, but may vary
604         slightly.  If you found you need identical output adding
605         "-F freebsd9" to the command line should do the trick.  For the
606         time being, the old mtree is available as fmtree.
607
608 20131014:
609         libbsdyml has been renamed to libyaml and moved to /usr/lib/private.
610         This will break ports-mgmt/pkg. Rebuild the port, or upgrade to pkg
611         1.1.4_8 and verify bsdyml not linked in, before running "make
612         delete-old-libs":
613           # make -C /usr/ports/ports-mgmt/pkg build deinstall install clean
614           or
615           # pkg install pkg; ldd /usr/local/sbin/pkg | grep bsdyml
616
617 20131010:
618         The stable/10 branch has been created in subversion from head
619         revision r256279.
620
621 20131010:
622         The rc.d/jail script has been updated to support jail(8)
623         configuration file.  The "jail_<jname>_*" rc.conf(5) variables
624         for per-jail configuration are automatically converted to
625         /var/run/jail.<jname>.conf before the jail(8) utility is invoked.
626         This is transparently backward compatible.  See below about some
627         incompatibilities and rc.conf(5) manual page for more details.
628
629         These variables are now deprecated in favor of jail(8) configuration
630         file.  One can use "rc.d/jail config <jname>" command to generate
631         a jail(8) configuration file in /var/run/jail.<jname>.conf without
632         running the jail(8) utility.   The default pathname of the
633         configuration file is /etc/jail.conf and can be specified by
634         using $jail_conf or $jail_<jname>_conf variables.
635
636         Please note that jail_devfs_ruleset accepts an integer at
637         this moment.  Please consider to rewrite the ruleset name
638         with an integer.
639
640 20130930:
641         BIND has been removed from the base system.  If all you need
642         is a local resolver, simply enable and start the local_unbound
643         service instead.  Otherwise, several versions of BIND are
644         available in the ports tree.   The dns/bind99 port is one example.
645
646         With this change, nslookup(1) and dig(1) are no longer in the base
647         system.  Users should instead use host(1) and drill(1) which are
648         in the base system.  Alternatively, nslookup and dig can
649         be obtained by installing the dns/bind-tools port.
650
651 20130916:
652         With the addition of unbound(8), a new unbound user is now
653         required during installworld.  "mergemaster -p" can be used to
654         add the user prior to installworld, as documented in the handbook.
655
656 20130911:
657         OpenSSH is now built with DNSSEC support, and will by default
658         silently trust signed SSHFP records.  This can be controlled with
659         the VerifyHostKeyDNS client configuration setting.  DNSSEC support
660         can be disabled entirely with the WITHOUT_LDNS option in src.conf.
661
662 20130906:
663         The GNU Compiler Collection and C++ standard library (libstdc++)
664         are no longer built by default on platforms where clang is the system
665         compiler.  You can enable them with the WITH_GCC and WITH_GNUCXX
666         options in src.conf.
667
668 20130905:
669         The PROCDESC kernel option is now part of the GENERIC kernel
670         configuration and is required for the rwhod(8) to work.
671         If you are using custom kernel configuration, you should include
672         'options PROCDESC'.
673
674 20130905:
675         The API and ABI related to the Capsicum framework was modified
676         in backward incompatible way. The userland libraries and programs
677         have to be recompiled to work with the new kernel. This includes the
678         following libraries and programs, but the whole buildworld is
679         advised: libc, libprocstat, dhclient, tcpdump, hastd, hastctl,
680         kdump, procstat, rwho, rwhod, uniq.
681
682 20130903:
683         AES-NI intrinsic support has been added to gcc.  The AES-NI module
684         has been updated to use this support.  A new gcc is required to build
685         the aesni module on both i386 and amd64.
686
687 20130821:
688         The PADLOCK_RNG and RDRAND_RNG kernel options are now devices.
689         Thus "device padlock_rng" and "device rdrand_rng" should be
690         used instead of "options PADLOCK_RNG" & "options RDRAND_RNG".
691
692 20130813:
693         WITH_ICONV has been split into two feature sets.  WITH_ICONV now
694         enables just the iconv* functionality and is now on by default.
695         WITH_LIBICONV_COMPAT enables the libiconv api and link time
696         compatability.  Set WITHOUT_ICONV to build the old way.
697         If you have been using WITH_ICONV before, you will very likely
698         need to turn on WITH_LIBICONV_COMPAT.
699
700 20130806:
701         INVARIANTS option now enables DEBUG for code with OpenSolaris and
702         Illumos origin, including ZFS.  If you have INVARIANTS in your
703         kernel configuration, then there is no need to set DEBUG or ZFS_DEBUG
704         explicitly.
705         DEBUG used to enable witness(9) tracking of OpenSolaris (mostly ZFS)
706         locks if WITNESS option was set.  Because that generated a lot of
707         witness(9) reports and all of them were believed to be false
708         positives, this is no longer done.  New option OPENSOLARIS_WITNESS
709         can be used to achieve the previous behavior.
710
711 20130806:
712         Timer values in IPv6 data structures now use time_uptime instead
713         of time_second.  Although this is not a user-visible functional
714         change, userland utilities which directly use them---ndp(8),
715         rtadvd(8), and rtsold(8) in the base system---need to be updated
716         to r253970 or later.
717
718 20130802:
719         find -delete can now delete the pathnames given as arguments,
720         instead of only files found below them or if the pathname did
721         not contain any slashes. Formerly, the following error message
722         would result:
723
724         find: -delete: <path>: relative path potentially not safe
725
726         Deleting the pathnames given as arguments can be prevented
727         without error messages using -mindepth 1 or by changing
728         directory and passing "." as argument to find. This works in the
729         old as well as the new version of find.
730
731 20130726:
732         Behavior of devfs rules path matching has been changed.
733         Pattern is now always matched against fully qualified devfs
734         path and slash characters must be explicitly matched by
735         slashes in pattern (FNM_PATHNAME). Rulesets involving devfs
736         subdirectories must be reviewed.
737
738 20130716:
739         The default ARM ABI has changed to the ARM EABI. The old ABI is
740         incompatible with the ARM EABI and all programs and modules will
741         need to be rebuilt to work with a new kernel.
742
743         To keep using the old ABI ensure the WITHOUT_ARM_EABI knob is set.
744
745         NOTE: Support for the old ABI will be removed in the future and
746         users are advised to upgrade.
747
748 20130709:
749         pkg_install has been disconnected from the build if you really need it
750         you should add WITH_PKGTOOLS in your src.conf(5).
751
752 20130709:
753         Most of network statistics structures were changed to be able
754         keep 64-bits counters. Thus all tools, that work with networking
755         statistics, must be rebuilt (netstat(1), bsnmpd(1), etc.)
756
757 20130629:
758         Fix targets that run multiple make's to use && rather than ;
759         so that subsequent steps depend on success of previous.
760
761         NOTE: if building 'universe' with -j* on stable/8 or stable/9
762         it would be better to start the build using bmake, to avoid
763         overloading the machine.
764
765 20130618:
766         Fix a bug that allowed a tracing process (e.g. gdb) to write
767         to a memory-mapped file in the traced process's address space
768         even if neither the traced process nor the tracing process had
769         write access to that file.
770
771 20130615:
772         CVS has been removed from the base system.  An exact copy
773         of the code is available from the devel/cvs port.
774
775 20130613:
776         Some people report the following error after the switch to bmake:
777
778                 make: illegal option -- J
779                 usage: make [-BPSXeiknpqrstv] [-C directory] [-D variable]
780                         ...
781                 *** [buildworld] Error code 2
782
783         this likely due to an old instance of make in
784         ${MAKEPATH} (${MAKEOBJDIRPREFIX}${.CURDIR}/make.${MACHINE})
785         which src/Makefile will use that blindly, if it exists, so if
786         you see the above error:
787
788                 rm -rf `make -V MAKEPATH`
789
790         should resolve it.
791
792 20130516:
793         Use bmake by default.
794         Whereas before one could choose to build with bmake via
795         -DWITH_BMAKE one must now use -DWITHOUT_BMAKE to use the old
796         make. The goal is to remove these knobs for 10-RELEASE.
797
798         It is worth noting that bmake (like gmake) treats the command
799         line as the unit of failure, rather than statements within the
800         command line.  Thus '(cd some/where && dosomething)' is safer
801         than 'cd some/where; dosomething'. The '()' allows consistent
802         behavior in parallel build.
803
804 20130429:
805         Fix a bug that allows NFS clients to issue READDIR on files.
806
807 20130426:
808         The WITHOUT_IDEA option has been removed because
809         the IDEA patent expired.
810
811 20130426:
812         The sysctl which controls TRIM support under ZFS has been renamed
813         from vfs.zfs.trim_disable -> vfs.zfs.trim.enabled and has been
814         enabled by default.
815
816 20130425:
817         The mergemaster command now uses the default MAKEOBJDIRPREFIX
818         rather than creating it's own in the temporary directory in
819         order allow access to bootstrapped versions of tools such as
820         install and mtree.  When upgrading from version of FreeBSD where
821         the install command does not support -l, you will need to
822         install a new mergemaster command if mergemaster -p is required.
823         This can be accomplished with the command (cd src/usr.sbin/mergemaster
824         && make install).
825
826 20130404:
827         Legacy ATA stack, disabled and replaced by new CAM-based one since
828         FreeBSD 9.0, completely removed from the sources.  Kernel modules
829         atadisk and atapi*, user-level tools atacontrol and burncd are
830         removed.  Kernel option `options ATA_CAM` is now permanently enabled
831         and removed.
832
833 20130319:
834         SOCK_CLOEXEC and SOCK_NONBLOCK flags have been added to socket(2)
835         and socketpair(2). Software, in particular Kerberos, may
836         automatically detect and use these during building. The resulting
837         binaries will not work on older kernels.
838
839 20130308:
840         CTL_DISABLE has also been added to the sparc64 GENERIC (for further
841         information, see the respective 20130304 entry).
842
843 20130304:
844         Recent commits to callout(9) changed the size of struct callout,
845         so the KBI is probably heavily disturbed. Also, some functions
846         in callout(9)/sleep(9)/sleepqueue(9)/condvar(9) KPIs were replaced
847         by macros. Every kernel module using it won't load, so rebuild
848         is requested.
849
850         The ctl device has been re-enabled in GENERIC for i386 and amd64,
851         but does not initialize by default (because of the new CTL_DISABLE
852         option) to save memory.  To re-enable it, remove the CTL_DISABLE
853         option from the kernel config file or set kern.cam.ctl.disable=0
854         in /boot/loader.conf.
855
856 20130301:
857         The ctl device has been disabled in GENERIC for i386 and amd64.
858         This was done due to the extra memory being allocated at system
859         initialisation time by the ctl driver which was only used if
860         a CAM target device was created.  This makes a FreeBSD system
861         unusable on 128MB or less of RAM.
862
863 20130208:
864         A new compression method (lz4) has been merged to -HEAD.  Please
865         refer to zpool-features(7) for more information.
866
867         Please refer to the "ZFS notes" section of this file for information
868         on upgrading boot ZFS pools.
869
870 20130129:
871         A BSD-licensed patch(1) variant has been added and is installed
872         as bsdpatch, being the GNU version the default patch.
873         To inverse the logic and use the BSD-licensed one as default,
874         while having the GNU version installed as gnupatch, rebuild
875         and install world with the WITH_BSD_PATCH knob set.
876
877 20130121:
878         Due to the use of the new -l option to install(1) during build
879         and install, you must take care not to directly set the INSTALL
880         make variable in your /etc/make.conf, /etc/src.conf, or on the
881         command line.  If you wish to use the -C flag for all installs
882         you may be able to add INSTALL+=-C to /etc/make.conf or
883         /etc/src.conf.
884
885 20130118:
886         The install(1) option -M has changed meaning and now takes an
887         argument that is a file or path to append logs to.  In the
888         unlikely event that -M was the last option on the command line
889         and the command line contained at least two files and a target
890         directory the first file will have logs appended to it.  The -M
891         option served little practical purpose in the last decade so its
892         use is expected to be extremely rare.
893
894 20121223:
895         After switching to Clang as the default compiler some users of ZFS
896         on i386 systems started to experience stack overflow kernel panics.
897         Please consider using 'options KSTACK_PAGES=4' in such configurations.
898
899 20121222:
900         GEOM_LABEL now mangles label names read from file system metadata.
901         Mangling affect labels containing spaces, non-printable characters,
902         '%' or '"'. Device names in /etc/fstab and other places may need to
903         be updated.
904
905 20121217:
906         By default, only the 10 most recent kernel dumps will be saved.  To
907         restore the previous behaviour (no limit on the number of kernel dumps
908         stored in the dump directory) add the following line to /etc/rc.conf:
909
910                 savecore_flags=""
911
912 20121201:
913         With the addition of auditdistd(8), a new auditdistd user is now
914         required during installworld.  "mergemaster -p" can be used to
915         add the user prior to installworld, as documented in the handbook.
916
917 20121117:
918         The sin6_scope_id member variable in struct sockaddr_in6 is now
919         filled by the kernel before passing the structure to the userland via
920         sysctl or routing socket.  This means the KAME-specific embedded scope
921         id in sin6_addr.s6_addr[2] is always cleared in userland application.
922         This behavior can be controlled by net.inet6.ip6.deembed_scopeid.
923         __FreeBSD_version is bumped to 1000025.
924
925 20121105:
926         On i386 and amd64 systems WITH_CLANG_IS_CC is now the default.
927         This means that the world and kernel will be compiled with clang
928         and that clang will be installed as /usr/bin/cc, /usr/bin/c++,
929         and /usr/bin/cpp.  To disable this behavior and revert to building
930         with gcc, compile with WITHOUT_CLANG_IS_CC. Really old versions
931         of current may need to bootstrap WITHOUT_CLANG first if the clang
932         build fails (its compatibility window doesn't extend to the 9 stable
933         branch point).
934
935 20121102:
936         The IPFIREWALL_FORWARD kernel option has been removed. Its
937         functionality now turned on by default.
938
939 20121023:
940         The ZERO_COPY_SOCKET kernel option has been removed and
941         split into SOCKET_SEND_COW and SOCKET_RECV_PFLIP.
942         NB: SOCKET_SEND_COW uses the VM page based copy-on-write
943         mechanism which is not safe and may result in kernel crashes.
944         NB: The SOCKET_RECV_PFLIP mechanism is useless as no current
945         driver supports disposeable external page sized mbuf storage.
946         Proper replacements for both zero-copy mechanisms are under
947         consideration and will eventually lead to complete removal
948         of the two kernel options.
949
950 20121023:
951         The IPv4 network stack has been converted to network byte
952         order. The following modules need to be recompiled together
953         with kernel: carp(4), divert(4), gif(4), siftr(4), gre(4),
954         pf(4), ipfw(4), ng_ipfw(4), stf(4).
955
956 20121022:
957         Support for non-MPSAFE filesystems was removed from VFS. The
958         VFS_VERSION was bumped, all filesystem modules shall be
959         recompiled.
960
961 20121018:
962         All the non-MPSAFE filesystems have been disconnected from
963         the build. The full list includes: codafs, hpfs, ntfs, nwfs,
964         portalfs, smbfs, xfs.
965
966 20121016:
967         The interface cloning API and ABI has changed. The following
968         modules need to be recompiled together with kernel:
969         ipfw(4), pfsync(4), pflog(4), usb(4), wlan(4), stf(4),
970         vlan(4), disc(4), edsc(4), if_bridge(4), gif(4), tap(4),
971         faith(4), epair(4), enc(4), tun(4), if_lagg(4), gre(4).
972
973 20121015:
974         The sdhci driver was split in two parts: sdhci (generic SD Host
975         Controller logic) and sdhci_pci (actual hardware driver).
976         No kernel config modifications are required, but if you
977         load sdhc as a module you must switch to sdhci_pci instead.
978
979 20121014:
980         Import the FUSE kernel and userland support into base system.
981
982 20121013:
983         The GNU sort(1) program has been removed since the BSD-licensed
984         sort(1) has been the default for quite some time and no serious
985         problems have been reported.  The corresponding WITH_GNU_SORT
986         knob has also gone.
987
988 20121006:
989         The pfil(9) API/ABI for AF_INET family has been changed. Packet
990         filtering modules: pf(4), ipfw(4), ipfilter(4) need to be recompiled
991         with new kernel.
992
993 20121001:
994         The net80211(4) ABI has been changed to allow for improved driver
995         PS-POLL and power-save support.  All wireless drivers need to be
996         recompiled to work with the new kernel.
997
998 20120913:
999         The random(4) support for the VIA hardware random number
1000         generator (`PADLOCK') is no longer enabled unconditionally.
1001         Add the padlock_rng device in the custom kernel config if
1002         needed.  The GENERIC kernels on i386 and amd64 do include the
1003         device, so the change only affects the custom kernel
1004         configurations.
1005
1006 20120908:
1007         The pf(4) packet filter ABI has been changed. pfctl(8) and
1008         snmp_pf module need to be recompiled to work with new kernel.
1009
1010 20120828:
1011         A new ZFS feature flag "com.delphix:empty_bpobj" has been merged
1012         to -HEAD. Pools that have empty_bpobj in active state can not be
1013         imported read-write with ZFS implementations that do not support
1014         this feature. For more information read the zpool-features(5)
1015         manual page.
1016
1017 20120727:
1018         The sparc64 ZFS loader has been changed to no longer try to auto-
1019         detect ZFS providers based on diskN aliases but now requires these
1020         to be explicitly listed in the OFW boot-device environment variable.
1021
1022 20120712:
1023         The OpenSSL has been upgraded to 1.0.1c.  Any binaries requiring
1024         libcrypto.so.6 or libssl.so.6 must be recompiled.  Also, there are
1025         configuration changes.  Make sure to merge /etc/ssl/openssl.cnf.
1026
1027 20120712:
1028         The following sysctls and tunables have been renamed for consistency
1029         with other variables:
1030           kern.cam.da.da_send_ordered   -> kern.cam.da.send_ordered
1031           kern.cam.ada.ada_send_ordered -> kern.cam.ada.send_ordered
1032
1033 20120628:
1034         The sort utility has been replaced with BSD sort.  For now, GNU sort
1035         is also available as "gnusort" or the default can be set back to
1036         GNU sort by setting WITH_GNU_SORT.  In this case, BSD sort will be
1037         installed as "bsdsort".
1038
1039 20120611:
1040         A new version of ZFS (pool version 5000) has been merged to -HEAD.
1041         Starting with this version the old system of ZFS pool versioning
1042         is superseded by "feature flags". This concept enables forward
1043         compatibility against certain future changes in functionality of ZFS
1044         pools. The first read-only compatible "feature flag" for ZFS pools
1045         is named "com.delphix:async_destroy". For more information
1046         read the new zpool-features(5) manual page.
1047         Please refer to the "ZFS notes" section of this file for information
1048         on upgrading boot ZFS pools.
1049
1050 20120417:
1051         The malloc(3) implementation embedded in libc now uses sources imported
1052         as contrib/jemalloc.  The most disruptive API change is to
1053         /etc/malloc.conf.  If your system has an old-style /etc/malloc.conf,
1054         delete it prior to installworld, and optionally re-create it using the
1055         new format after rebooting.  See malloc.conf(5) for details
1056         (specifically the TUNING section and the "opt.*" entries in the MALLCTL
1057         NAMESPACE section).
1058
1059 20120328:
1060         Big-endian MIPS TARGET_ARCH values no longer end in "eb".  mips64eb
1061         is now spelled mips64.  mipsn32eb is now spelled mipsn32.  mipseb is
1062         now spelled mips.  This is to aid compatibility with third-party
1063         software that expects this naming scheme in uname(3).  Little-endian
1064         settings are unchanged. If you are updating a big-endian mips64 machine
1065         from before this change, you may need to set MACHINE_ARCH=mips64 in
1066         your environment before the new build system will recognize your machine.
1067
1068 20120306:
1069         Disable by default the option VFS_ALLOW_NONMPSAFE for all supported
1070         platforms.
1071
1072 20120229:
1073         Now unix domain sockets behave "as expected" on nullfs(5). Previously
1074         nullfs(5) did not pass through all behaviours to the underlying layer,
1075         as a result if we bound to a socket on the lower layer we could connect
1076         only to the lower path; if we bound to the upper layer we could connect
1077         only to the upper path. The new behavior is one can connect to both the
1078         lower and the upper paths regardless what layer path one binds to.
1079
1080 20120211:
1081         The getifaddrs upgrade path broken with 20111215 has been restored.
1082         If you have upgraded in between 20111215 and 20120209 you need to
1083         recompile libc again with your kernel.  You still need to recompile
1084         world to be able to configure CARP but this restriction already
1085         comes from 20111215.
1086
1087 20120114:
1088         The set_rcvar() function has been removed from /etc/rc.subr.  All
1089         base and ports rc.d scripts have been updated, so if you have a
1090         port installed with a script in /usr/local/etc/rc.d you can either
1091         hand-edit the rcvar= line, or reinstall the port.
1092
1093         An easy way to handle the mass-update of /etc/rc.d:
1094         rm /etc/rc.d/* && mergemaster -i
1095
1096 20120109:
1097         panic(9) now stops other CPUs in the SMP systems, disables interrupts
1098         on the current CPU and prevents other threads from running.
1099         This behavior can be reverted using the kern.stop_scheduler_on_panic
1100         tunable/sysctl.
1101         The new behavior can be incompatible with kern.sync_on_panic.
1102
1103 20111215:
1104         The carp(4) facility has been changed significantly. Configuration
1105         of the CARP protocol via ifconfig(8) has changed, as well as format
1106         of CARP events submitted to devd(8) has changed. See manual pages
1107         for more information. The arpbalance feature of carp(4) is currently
1108         not supported anymore.
1109
1110         Size of struct in_aliasreq, struct in6_aliasreq has changed. User
1111         utilities using SIOCAIFADDR, SIOCAIFADDR_IN6, e.g. ifconfig(8),
1112         need to be recompiled.
1113
1114 20111122:
1115         The acpi_wmi(4) status device /dev/wmistat has been renamed to
1116         /dev/wmistat0.
1117
1118 20111108:
1119         The option VFS_ALLOW_NONMPSAFE option has been added in order to
1120         explicitely support non-MPSAFE filesystems.
1121         It is on by default for all supported platform at this present
1122         time.
1123
1124 20111101:
1125         The broken amd(4) driver has been replaced with esp(4) in the amd64,
1126         i386 and pc98 GENERIC kernel configuration files.
1127
1128 20110930:
1129         sysinstall has been removed
1130
1131 20110923:
1132         The stable/9 branch created in subversion.  This corresponds to the
1133         RELENG_9 branch in CVS.
1134
1135 COMMON ITEMS:
1136
1137         General Notes
1138         -------------
1139         Avoid using make -j when upgrading.  While generally safe, there are
1140         sometimes problems using -j to upgrade.  If your upgrade fails with
1141         -j, please try again without -j.  From time to time in the past there
1142         have been problems using -j with buildworld and/or installworld.  This
1143         is especially true when upgrading between "distant" versions (eg one
1144         that cross a major release boundary or several minor releases, or when
1145         several months have passed on the -current branch).
1146
1147         Sometimes, obscure build problems are the result of environment
1148         poisoning.  This can happen because the make utility reads its
1149         environment when searching for values for global variables.  To run
1150         your build attempts in an "environmental clean room", prefix all make
1151         commands with 'env -i '.  See the env(1) manual page for more details.
1152
1153         When upgrading from one major version to another it is generally best
1154         to upgrade to the latest code in the currently installed branch first,
1155         then do an upgrade to the new branch. This is the best-tested upgrade
1156         path, and has the highest probability of being successful.  Please try
1157         this approach before reporting problems with a major version upgrade.
1158
1159         When upgrading a live system, having a root shell around before
1160         installing anything can help undo problems. Not having a root shell
1161         around can lead to problems if pam has changed too much from your
1162         starting point to allow continued authentication after the upgrade.
1163
1164         This file should be read as a log of events. When a later event changes
1165         information of a prior event, the prior event should not be deleted.
1166         Instead, a pointer to the entry with the new information should be
1167         placed in the old entry. Readers of this file should also sanity check
1168         older entries before relying on them blindly. Authors of new entries
1169         should write them with this in mind.
1170
1171         ZFS notes
1172         ---------
1173         When upgrading the boot ZFS pool to a new version, always follow
1174         these two steps:
1175
1176         1.) recompile and reinstall the ZFS boot loader and boot block
1177         (this is part of "make buildworld" and "make installworld")
1178
1179         2.) update the ZFS boot block on your boot drive
1180
1181         The following example updates the ZFS boot block on the first
1182         partition (freebsd-boot) of a GPT partitioned drive ada0:
1183         "gpart bootcode -p /boot/gptzfsboot -i 1 ada0"
1184
1185         Non-boot pools do not need these updates.
1186
1187         To build a kernel
1188         -----------------
1189         If you are updating from a prior version of FreeBSD (even one just
1190         a few days old), you should follow this procedure.  It is the most
1191         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1192
1193         make kernel-toolchain
1194         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1195         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1196
1197         To test a kernel once
1198         ---------------------
1199         If you just want to boot a kernel once (because you are not sure
1200         if it works, or if you want to boot a known bad kernel to provide
1201         debugging information) run
1202         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1203         nextboot -k testkernel
1204
1205         To just build a kernel when you know that it won't mess you up
1206         --------------------------------------------------------------
1207         This assumes you are already running a CURRENT system.  Replace
1208         ${arch} with the architecture of your machine (e.g. "i386",
1209         "arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1210
1211         cd src/sys/${arch}/conf
1212         config KERNEL_NAME_HERE
1213         cd ../compile/KERNEL_NAME_HERE
1214         make depend
1215         make
1216         make install
1217
1218         If this fails, go to the "To build a kernel" section.
1219
1220         To rebuild everything and install it on the current system.
1221         -----------------------------------------------------------
1222         # Note: sometimes if you are running current you gotta do more than
1223         # is listed here if you are upgrading from a really old current.
1224
1225         <make sure you have good level 0 dumps>
1226         make buildworld
1227         make kernel KERNCONF=YOUR_KERNEL_HERE
1228                                                         [1]
1229         <reboot in single user>                         [3]
1230         mergemaster -Fp                                 [5]
1231         make installworld
1232         mergemaster -Fi                                 [4]
1233         make delete-old                                 [6]
1234         <reboot>
1235
1236         To cross-install current onto a separate partition
1237         --------------------------------------------------
1238         # In this approach we use a separate partition to hold
1239         # current's root, 'usr', and 'var' directories.   A partition
1240         # holding "/", "/usr" and "/var" should be about 2GB in
1241         # size.
1242
1243         <make sure you have good level 0 dumps>
1244         <boot into -stable>
1245         make buildworld
1246         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1247         <maybe newfs current's root partition>
1248         <mount current's root partition on directory ${CURRENT_ROOT}>
1249         make installworld DESTDIR=${CURRENT_ROOT} -DDB_FROM_SRC
1250         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1251         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1252         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1253         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1254         <reboot into current>
1255         <do a "native" rebuild/install as described in the previous section>
1256         <maybe install compatibility libraries from ports/misc/compat*>
1257         <reboot>
1258
1259
1260         To upgrade in-place from stable to current
1261         ----------------------------------------------
1262         <make sure you have good level 0 dumps>
1263         make buildworld                                 [9]
1264         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
1265                                                         [1]
1266         <reboot in single user>                         [3]
1267         mergemaster -Fp                                 [5]
1268         make installworld
1269         mergemaster -Fi                                 [4]
1270         make delete-old                                 [6]
1271         <reboot>
1272
1273         Make sure that you've read the UPDATING file to understand the
1274         tweaks to various things you need.  At this point in the life
1275         cycle of current, things change often and you are on your own
1276         to cope.  The defaults can also change, so please read ALL of
1277         the UPDATING entries.
1278
1279         Also, if you are tracking -current, you must be subscribed to
1280         freebsd-current@freebsd.org.  Make sure that before you update
1281         your sources that you have read and understood all the recent
1282         messages there.  If in doubt, please track -stable which has
1283         much fewer pitfalls.
1284
1285         [1] If you have third party modules, such as vmware, you
1286         should disable them at this point so they don't crash your
1287         system on reboot.
1288
1289         [3] From the bootblocks, boot -s, and then do
1290                 fsck -p
1291                 mount -u /
1292                 mount -a
1293                 cd src
1294                 adjkerntz -i            # if CMOS is wall time
1295         Also, when doing a major release upgrade, it is required that
1296         you boot into single user mode to do the installworld.
1297
1298         [4] Note: This step is non-optional.  Failure to do this step
1299         can result in a significant reduction in the functionality of the
1300         system.  Attempting to do it by hand is not recommended and those
1301         that pursue this avenue should read this file carefully, as well
1302         as the archives of freebsd-current and freebsd-hackers mailing lists
1303         for potential gotchas.  The -U option is also useful to consider.
1304         See mergemaster(8) for more information.
1305
1306         [5] Usually this step is a noop.  However, from time to time
1307         you may need to do this if you get unknown user in the following
1308         step.  It never hurts to do it all the time.  You may need to
1309         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1310         install) after the buildworld before this step if you last updated
1311         from current before 20130425 or from -stable before 20130430.
1312
1313         [6] This only deletes old files and directories. Old libraries
1314         can be deleted by "make delete-old-libs", but you have to make
1315         sure that no program is using those libraries anymore.
1316
1317         [8] In order to have a kernel that can run the 4.x binaries needed to
1318         do an installworld, you must include the COMPAT_FREEBSD4 option in
1319         your kernel.  Failure to do so may leave you with a system that is
1320         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1321         required to run the 5.x binaries on more recent kernels.  And so on
1322         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1323
1324         Make sure that you merge any new devices from GENERIC since the
1325         last time you updated your kernel config file.
1326
1327         [9] When checking out sources, you must include the -P flag to have
1328         cvs prune empty directories.
1329
1330         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1331         "?=" instead of the "=" assignment operator, so that buildworld can
1332         override the CPUTYPE if it needs to.
1333
1334         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1335         not on the command line, or in /etc/make.conf.  buildworld will
1336         warn if it is improperly defined.
1337 FORMAT:
1338
1339 This file contains a list, in reverse chronological order, of major
1340 breakages in tracking -current.  It is not guaranteed to be a complete
1341 list of such breakages, and only contains entries since September 23, 2011.
1342 If you need to see UPDATING entries from before that date, you will need
1343 to fetch an UPDATING file from an older FreeBSD release.
1344
1345 Copyright information:
1346
1347 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1348
1349 Redistribution, publication, translation and use, with or without
1350 modification, in full or in part, in any form or format of this
1351 document are permitted without further permission from the author.
1352
1353 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1354 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1355 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1356 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1357 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1358 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1359 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1360 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1361 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1362 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1363 POSSIBILITY OF SUCH DAMAGE.
1364
1365 Contact Warner Losh if you have any questions about your use of
1366 this document.
1367
1368 $FreeBSD$