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