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