]> CyberLeo.Net >> Repos - FreeBSD/FreeBSD.git/blob - UPDATING
Install iodev.h.
[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 Items affecting the ports and packages system can be found in
10 /usr/ports/UPDATING.  Please read that file before running portupgrade.
11
12 NOTE TO PEOPLE WHO THINK THAT FreeBSD 9.x IS SLOW:
13         FreeBSD 9.x has many debugging features turned on, in both the kernel
14         and userland.  These features attempt to detect incorrect use of
15         system primitives, and encourage loud failure through extra sanity
16         checking and fail stop semantics.  They also substantially impact
17         system performance.  If you want to do performance measurement,
18         benchmarking, and optimization, you'll want to turn them off.  This
19         includes various WITNESS- related kernel options, INVARIANTS, malloc
20         debugging flags in userland, and various verbose features in the
21         kernel.  Many developers choose to disable these features on build
22         machines to maximize performance.  (To disable malloc debugging, run
23         ln -s aj /etc/malloc.conf.)
24
25 20110207:
26         Remove the uio_yield prototype and symbol.  This function has
27         been misnamed since it was introduced and should not be
28         globally exposed with this name.  The equivalent functionality
29         is now available using kern_yield(curthread->td_user_pri).
30         The function remains undocumented.
31
32 20110112:
33         A SYSCTL_[ADD_]UQUAD was added for unsigned uint64_t pointers,
34         symmetric with the existing SYSCTL_[ADD_]QUAD.  Type checking
35         for scalar sysctls is defined but disabled.  Code that needs
36         UQUAD to pass the type checking that must compile on older
37         systems where the define is not present can check against
38         __FreeBSD_version >= 900030.
39
40         The system dialog(1) has been replaced with a new version previously
41         in ports as devel/cdialog. dialog(1) is mostly command-line compatible
42         with the previous version, but the libdialog associated with it has
43         a largely incompatible API. As such, the original version of libdialog
44         will be kept temporarily as libodialog, until its base system consumers
45         are replaced or updated. Bump __FreeBSD_version to 900030.
46
47 20110103:
48         If you are trying to run make universe on a -stable system, and you get
49         the following warning:
50         "Makefile", line 356: "Target architecture for i386/conf/GENERIC 
51         unknown.  config(8) likely too old."
52         or something similar to it, then you must upgrade your -stable system
53         to 8.2-Release or newer (really, any time after r210146 7/15/2010 in
54         stable/8) or build the config from the latest stable/8 branch and
55         install it on your system.
56
57         Prior to this date, building a current universe on 8-stable system from
58         between 7/15/2010 and 1/2/2011 would result in a weird shell parsing
59         error in the first kernel build phase.  A new config on those old 
60         systems will fix that problem for older versions of -current.
61
62 20101228:
63         The TCP stack has been modified to allow Khelp modules to interact with
64         it via helper hook points and store per-connection data in the TCP
65         control block. Bump __FreeBSD_version to 900029. User space tools that
66         rely on the size of struct tcpcb in tcp_var.h (e.g. sockstat) need to
67         be recompiled.
68
69 20101114:
70         Generic IEEE 802.3 annex 31B full duplex flow control support has been
71         added to mii(4) and bge(4), bce(4), msk(4), nfe(4) and stge(4) along
72         with brgphy(4), e1000phy(4) as well as ip1000phy() have been converted
73         to take advantage of it instead of using custom implementations.  This
74         means that these drivers now no longer unconditionally advertise
75         support for flow control but only do so if flow control is a selected
76         media option.  This was implemented in the generic support that way in
77         order to allow flow control to be switched on and off via ifconfig(8)
78         with the PHY specific default to typically off in order to protect
79         from unwanted effects.  Consequently, if you used flow control with
80         one of the above mentioned drivers you now need to explicitly enable
81         it, for example via:
82                 ifconfig bge0 media auto mediaopt flowcontrol
83
84         Along with the above mentioned changes generic support for setting
85         1000baseT master mode also has been added and brgphy(4), ciphy(4),
86         e1000phy(4) as well as ip1000phy(4) have been converted to take
87         advantage of it.  This means that these drivers now no longer take the
88         link0 parameter for selecting master mode but the master media option
89         has to be used instead, for example like in the following:
90                 ifconfig bge0 media 1000baseT mediaopt full-duplex,master
91
92         Selection of master mode now is also available with all other PHY
93         drivers supporting 1000baseT.
94
95 20101111:
96         The TCP stack has received a significant update to add support for
97         modularised congestion control and generally improve the clarity of
98         congestion control decisions. Bump __FreeBSD_version to 900025. User
99         space tools that rely on the size of struct tcpcb in tcp_var.h (e.g.
100         sockstat) need to be recompiled.
101
102 20101002:
103         The man(1) utility has been replaced by a new version that no longer
104         uses /etc/manpath.config. Please consult man.conf(5) for how to
105         migrate local entries to the new format.
106
107 20100928:
108         The copyright strings printed by login(1) and sshd(8) at the time of a
109         new connection have been removed to follow other operating systems and
110         upstream sshd.
111
112 20100915:
113         A workaround for a fixed ld bug has been removed in kernel code,
114         so make sure that your system ld is built from sources after
115         revision 210245 from 2010-07-19 (r211583 if building head kernel
116         on stable/8, r211584 for stable/7; both from 2010-08-21).
117         A symptom of incorrect ld version is different addresses for
118         set_pcpu section and __start_set_pcpu symbol in kernel and/or modules.
119
120 20100913:
121         The $ipv6_prefer variable in rc.conf(5) has been split into
122         $ip6addrctl_policy and $ipv6_activate_all_interfaces.
123
124         The $ip6addrctl_policy is a variable to choose a pre-defined
125         address selection policy set by ip6addrctl(8).  A value
126         "ipv4_prefer", "ipv6_prefer" or "AUTO" can be specified.  The
127         default is "AUTO".
128
129         The $ipv6_activate_all_interfaces specifies whether IFDISABLED
130         flag (see an entry of 20090926) is set on an interface with no
131         corresponding $ifconfig_IF_ipv6 line.  The default is "NO" for
132         security reason.  If you want IPv6 link-local address on all
133         interfaces by default, set this to "YES".
134
135         The old ipv6_prefer="YES" is equivalent to
136         ipv6_activate_all_interfaces="YES" and
137         ip6addrctl_policy="ipv6_prefer".
138
139 20100913:
140         DTrace has grown support for userland tracing. Due to this, DTrace is
141         now i386 and amd64 only.
142         dtruss(1) is now installed by default on those systems and a new
143         kernel module is needed for userland tracing: fasttrap.
144         No changes to your kernel config file are necessary to enable
145         userland tracing, but you might consider adding 'STRIP=' and
146         'CFLAGS+=-fno-omit-frame-pointer' to your make.conf if you want
147         to have informative userland stack traces in DTrace (ustack).
148
149 20100725:
150         The acpi_aiboost(4) driver has been removed in favor of the new
151         aibs(4) driver. You should update your kernel configuration file.
152
153 20100722:
154         BSD grep has been imported to the base system and it is built by
155         default.  It is completely BSD licensed, highly GNU-compatible, uses
156         less memory than its GNU counterpart and has a small codebase.
157         However, it is slower than its GNU counterpart, which is mostly
158         noticeable for larger searches, for smaller ones it is measurable
159         but not significant.  The reason is complex, the most important factor
160         is that we lack a modern and efficient regex library and GNU
161         overcomes this by optimizing the searches internally.  Future work
162         on improving the regex performance is planned, for the meantime,
163         users that need better performance, can build GNU grep instead by
164         setting the WITH_GNU_GREP knob.
165
166 20100713:
167         Due to the import of powerpc64 support, all existing powerpc kernel
168         configuration files must be updated with a machine directive like this:
169             machine powerpc powerpc
170
171         In addition, an updated config(8) is required to build powerpc kernels
172         after this change.
173
174 20100713:
175         A new version of ZFS (version 15) has been merged to -HEAD.
176         This version uses a python library for the following subcommands:
177         zfs allow, zfs unallow, zfs groupspace, zfs userspace.
178         For full functionality of these commands the following port must
179         be installed: sysutils/py-zfs
180
181 20100429:
182         'vm_page's are now hashed by physical address to an array of mutexes.
183         Currently this is only used to serialize access to hold_count. Over 
184         time the page queue mutex will be peeled away. This changes the size
185         of pmap on every architecture. And requires all callers of vm_page_hold
186         and vm_page_unhold to be updated. 
187  
188 20100402:
189         WITH_CTF can now be specified in src.conf (not recommended, there
190         are some problems with static executables), make.conf (would also
191         affect ports which do not use GNU make and do not override the
192         compile targets) or in the kernel config (via "makeoptions
193         WITH_CTF=yes").
194         When WITH_CTF was specified there before this was silently ignored,
195         so make sure that WITH_CTF is not used in places which could lead
196         to unwanted behavior.
197
198 20100311:
199         The kernel option COMPAT_IA32 has been replaced with COMPAT_FREEBSD32
200         to allow 32-bit compatibility on non-x86 platforms. All kernel
201         configurations on amd64 and ia64 platforms using these options must
202         be modified accordingly.
203
204 20100113:
205         The utmp user accounting database has been replaced with utmpx,
206         the user accounting interface standardized by POSIX.
207         Unfortunately the semantics of utmp and utmpx don't match,
208         making it practically impossible to support both interfaces.
209         The user accounting database is used by tools like finger(1),
210         last(1), talk(1), w(1) and ac(8).
211
212         All applications in the base system use utmpx.  This means only
213         local binaries (e.g. from the ports tree) may still use these
214         utmp database files.  These applications must be rebuilt to make
215         use of utmpx.
216
217         After the system has been upgraded, it is safe to remove the old
218         log files (/var/run/utmp, /var/log/lastlog and /var/log/wtmp*),
219         assuming their contents is of no importance anymore.  Old wtmp
220         databases can only be used by last(1) and ac(8) after they have
221         been converted to the new format using wtmpcvt(1).
222
223 20100108:
224         Introduce the kernel thread "deadlock resolver" (which can be enabled
225         via the DEADLKRES option, see NOTES for more details) and the
226         sleepq_type() function for sleepqueues.
227
228 20091202:
229         The rc.firewall and rc.firewall6 were unified, and
230         rc.firewall6 and rc.d/ip6fw were removed.
231         According to the removal of rc.d/ip6fw, ipv6_firewall_* rc
232         variables are obsoleted.  Instead, the following new rc
233         variables are added to rc.d/ipfw:
234
235                 firewall_client_net_ipv6, firewall_simple_iif_ipv6,
236                 firewall_simple_inet_ipv6, firewall_simple_oif_ipv6,
237                 firewall_simple_onet_ipv6, firewall_trusted_ipv6
238
239         The meanings correspond to the relevant IPv4 variables.
240
241 20091125:
242         8.0-RELEASE.
243
244 20091113:
245         The default terminal emulation for syscons(4) has been changed
246         from cons25 to xterm on all platforms except pc98.  This means
247         that the /etc/ttys file needs to be updated to ensure correct
248         operation of applications on the console.
249
250         The terminal emulation style can be toggled per window by using
251         vidcontrol(1)'s -T flag.  The TEKEN_CONS25 kernel configuration
252         options can be used to change the compile-time default back to
253         cons25.
254
255         To prevent graphical artifacts, make sure the TERM environment
256         variable is set to match the terminal emulation that is being
257         performed by syscons(4).
258
259 20091109:
260         The layout of the structure ieee80211req_scan_result has changed.
261         Applications that require wireless scan results (e.g. ifconfig(8))
262         from net80211 need to be recompiled.
263
264         Applications such as wpa_supplicant(8) may require a full world
265         build without using NO_CLEAN in order to get synchronized with the
266         new structure.
267
268 20091025:
269         The iwn(4) driver has been updated to support the 5000 and 5150 series.
270         There's one kernel module for each firmware. Adding "device iwnfw"
271         to the kernel configuration file means including all three firmware
272         images inside the kernel. If you want to include just the one for
273         your wireless card, use the the devices iwn4965fw, iwn5000fw or
274         iwn5150fw.
275
276 20090926:
277         The rc.d/network_ipv6, IPv6 configuration script has been integrated
278         into rc.d/netif.  The changes are the following:
279
280         1. To use IPv6, simply define $ifconfig_IF_ipv6 like $ifconfig_IF
281            for IPv4.  For aliases, $ifconfig_IF_aliasN should be used.
282            Note that both variables need the "inet6" keyword at the head.
283
284            Do not set $ipv6_network_interfaces manually if you do not
285            understand what you are doing.  It is not needed in most cases. 
286
287            $ipv6_ifconfig_IF and $ipv6_ifconfig_IF_aliasN still work, but
288            they are obsolete.
289
290         2. $ipv6_enable is obsolete.  Use $ipv6_prefer and
291            "inet6 accept_rtadv" keyword in ifconfig(8) instead.
292
293            If you define $ipv6_enable=YES, it means $ipv6_prefer=YES and
294            all configured interfaces have "inet6 accept_rtadv" in the
295            $ifconfig_IF_ipv6.  These are for backward compatibility.
296
297         3. A new variable $ipv6_prefer has been added.  If NO, IPv6
298            functionality of interfaces with no corresponding
299            $ifconfig_IF_ipv6 is disabled by using "inet6 ifdisabled" flag,
300            and the default address selection policy of ip6addrctl(8) 
301            is the IPv4-preferred one (see rc.d/ip6addrctl for more details).
302            Note that if you want to configure IPv6 functionality on the
303            disabled interfaces after boot, first you need to clear the flag by
304            using ifconfig(8) like:
305
306                 ifconfig em0 inet6 -ifdisabled
307
308            If YES, the default address selection policy is set as
309            IPv6-preferred.
310
311            The default value of $ipv6_prefer is NO.
312
313         4. If your system need to receive Router Advertisement messages,
314            define "inet6 accept_rtadv" in $ifconfig_IF_ipv6.  The rc(8)
315            scripts automatically invoke rtsol(8) when the interface becomes
316            UP.  The Router Advertisement messages are used for SLAAC
317            (State-Less Address AutoConfiguration).
318
319 20090922:
320         802.11s D3.03 support was committed. This is incompatible with the
321         previous code, which was based on D3.0.
322
323 20090912:
324         A sysctl variable net.inet6.ip6.accept_rtadv now sets the default value
325         of a per-interface flag ND6_IFF_ACCEPT_RTADV, not a global knob to
326         control whether accepting Router Advertisement messages or not.
327         Also, a per-interface flag ND6_IFF_AUTO_LINKLOCAL has been added and
328         a sysctl variable net.inet6.ip6.auto_linklocal is its default value.
329         The ifconfig(8) utility now supports these flags.
330
331 20090910:
332         ZFS snapshots are now mounted with MNT_IGNORE flag. Use -v option for
333         mount(8) and -a option for df(1) to see them.
334
335 20090825:
336         The old tunable hw.bus.devctl_disable has been superseded by
337         hw.bus.devctl_queue.  hw.bus.devctl_disable=1 in loader.conf should be
338         replaced by hw.bus.devctl_queue=0.  The default for this new tunable
339         is 1000.
340
341 20090813:
342         Remove the option STOP_NMI.  The default action is now to use NMI only
343         for KDB via the newly introduced function stop_cpus_hard() and
344         maintain stop_cpus() to just use a normal IPI_STOP on ia32 and amd64.
345
346 20090803:
347         The stable/8 branch created in subversion.  This corresponds to the
348         RELENG_8 branch in CVS.
349
350 20090719:
351         Bump the shared library version numbers for all libraries that do not
352         use symbol versioning as part of the 8.0-RELEASE cycle.  Bump
353         __FreeBSD_version to 800105.
354
355 20090714:
356         Due to changes in the implementation of virtual network stack support,
357         all network-related kernel modules must be recompiled.  As this change
358         breaks the ABI, bump __FreeBSD_version to 800104.
359
360 20090713:
361         The TOE interface to the TCP syncache has been modified to remove
362         struct tcpopt (<netinet/tcp_var.h>) from the ABI of the network stack.
363         The cxgb driver is the only TOE consumer affected by this change, and
364         needs to be recompiled along with the kernel. As this change breaks
365         the ABI, bump __FreeBSD_version to 800103.
366
367 20090712: 
368         Padding has been added to struct tcpcb, sackhint and tcpstat in
369         <netinet/tcp_var.h> to facilitate future MFCs and bug fixes whilst
370         maintaining the ABI. However, this change breaks the ABI, so bump
371         __FreeBSD_version to 800102. User space tools that rely on the size of
372         any of these structs (e.g. sockstat) need to be recompiled.
373
374 20090630:
375         The NFS_LEGACYRPC option has been removed along with the old kernel
376         RPC implementation that this option selected. Kernel configurations
377         may need to be adjusted.
378
379 20090629:
380         The network interface device nodes at /dev/net/<interface> have been
381         removed.  All ioctl operations can be performed the normal way using
382         routing sockets.  The kqueue functionality can generally be replaced
383         with routing sockets.
384
385 20090628:
386         The documentation from the FreeBSD Documentation Project (Handbook,
387         FAQ, etc.) is now installed via packages by sysinstall(8) and under
388         the /usr/local/share/doc/freebsd directory instead of /usr/share/doc.
389
390 20090624:
391         The ABI of various structures related to the SYSV IPC API have been
392         changed.  As a result, the COMPAT_FREEBSD[456] and COMPAT_43 kernel
393         options now all require COMPAT_FREEBSD7.  Bump __FreeBSD_version to
394         800100.
395
396 20090622:
397         Layout of struct vnet has changed as routing related variables were
398         moved to their own Vimage module. Modules need to be recompiled.  Bump
399         __FreeBSD_version to 800099.
400
401 20090619:
402         NGROUPS_MAX and NGROUPS have been increased from 16 to 1023 and 1024
403         respectively.  As long as no more than 16 groups per process are used,
404         no changes should be visible.  When more than 16 groups are used, old
405         binaries may fail if they call getgroups() or getgrouplist() with
406         statically sized storage.  Recompiling will work around this, but
407         applications should be modified to use dynamically allocated storage
408         for group arrays as POSIX.1-2008 does not cap an implementation's
409         number of supported groups at NGROUPS_MAX+1 as previous versions did.
410
411         NFS and portalfs mounts may also be affected as the list of groups is
412         truncated to 16.  Users of NFS who use more than 16 groups, should
413         take care that negative group permissions are not used on the exported
414         file systems as they will not be reliable unless a GSSAPI based
415         authentication method is used.
416
417 20090616: 
418         The compiling option ADAPTIVE_LOCKMGRS has been introduced.  This
419         option compiles in the support for adaptive spinning for lockmgrs
420         which want to enable it.  The lockinit() function now accepts the flag
421         LK_ADAPTIVE in order to make the lock object subject to adaptive
422         spinning when both held in write and read mode.
423
424 20090613:
425         The layout of the structure returned by IEEE80211_IOC_STA_INFO has
426         changed.  User applications that use this ioctl need to be rebuilt.
427
428 20090611:
429         The layout of struct thread has changed.  Kernel and modules need to
430         be rebuilt.
431
432 20090608:
433         The layout of structs ifnet, domain, protosw and vnet_net has changed.
434         Kernel modules need to be rebuilt.  Bump __FreeBSD_version to 800097.
435
436 20090602:
437         window(1) has been removed from the base system. It can now be
438         installed from ports. The port is called misc/window.
439
440 20090601:
441         The way we are storing and accessing `routing table' entries has
442         changed. Programs reading the FIB, like netstat, need to be
443         re-compiled.
444
445 20090601:
446         A new netisr implementation has been added for FreeBSD 8.  Network
447         file system modules, such as igmp, ipdivert, and others, should be
448         rebuilt.
449         Bump __FreeBSD_version to 800096.
450
451 20090530:
452         Remove the tunable/sysctl debug.mpsafevfs as its initial purpose is no
453         more valid.
454
455 20090530:
456         Add VOP_ACCESSX(9).  File system modules need to be rebuilt.
457         Bump __FreeBSD_version to 800094.
458
459 20090529:
460         Add mnt_xflag field to 'struct mount'.  File system modules need to be
461         rebuilt.
462         Bump __FreeBSD_version to 800093.
463
464 20090528:
465         The compiling option ADAPTIVE_SX has been retired while it has been
466         introduced the option NO_ADAPTIVE_SX which handles the reversed logic.
467         The KPI for sx_init_flags() changes as accepting flags:
468         SX_ADAPTIVESPIN flag has been retired while the SX_NOADAPTIVE flag has
469         been introduced in order to handle the reversed logic.
470         Bump __FreeBSD_version to 800092.
471
472 20090527:
473         Add support for hierarchical jails.  Remove global securelevel.
474         Bump __FreeBSD_version to 800091.
475
476 20090523:
477         The layout of struct vnet_net has changed, therefore modules
478         need to be rebuilt.
479         Bump __FreeBSD_version to 800090.
480
481 20090523:
482         The newly imported zic(8) produces a new format in the output. Please
483         run tzsetup(8) to install the newly created data to /etc/localtime.
484
485 20090520:
486         The sysctl tree for the usb stack has renamed from hw.usb2.* to
487         hw.usb.* and is now consistent again with previous releases.
488
489 20090520:
490         802.11 monitor mode support was revised and driver api's were changed.
491         Drivers dependent on net80211 now support DLT_IEEE802_11_RADIO instead
492         of DLT_IEEE802_11.  No user-visible data structures were changed but
493         applications that use DLT_IEEE802_11 may require changes.
494         Bump __FreeBSD_version to 800088.
495
496 20090430:
497         The layout of the following structs has changed: sysctl_oid,
498         socket, ifnet, inpcbinfo, tcpcb, syncache_head, vnet_inet,
499         vnet_inet6 and vnet_ipfw.  Most modules need to be rebuild or
500         panics may be experienced.  World rebuild is required for
501         correctly checking networking state from userland.
502         Bump __FreeBSD_version to 800085.
503
504 20090429:
505         MLDv2 and Source-Specific Multicast (SSM) have been merged
506         to the IPv6 stack. VIMAGE hooks are in but not yet used.
507         The implementation of SSM within FreeBSD's IPv6 stack closely
508         follows the IPv4 implementation.
509
510         For kernel developers:
511
512         * The most important changes are that the ip6_output() and
513           ip6_input() paths no longer take the IN6_MULTI_LOCK,
514           and this lock has been downgraded to a non-recursive mutex.
515
516         * As with the changes to the IPv4 stack to support SSM, filtering
517           of inbound multicast traffic must now be performed by transport
518           protocols within the IPv6 stack. This does not apply to TCP and
519           SCTP, however, it does apply to UDP in IPv6 and raw IPv6.
520
521         * The KPIs used by IPv6 multicast are similar to those used by
522           the IPv4 stack, with the following differences:
523            * im6o_mc_filter() is analogous to imo_multicast_filter().
524            * The legacy KAME entry points in6_joingroup and in6_leavegroup()
525              are shimmed to in6_mc_join() and in6_mc_leave() respectively.
526            * IN6_LOOKUP_MULTI() has been deprecated and removed.
527            * IPv6 relies on MLD for the DAD mechanism. KAME's internal KPIs
528              for MLDv1 have an additional 'timer' argument which is used to
529              jitter the initial membership report for the solicited-node
530              multicast membership on-link.
531            * This is not strictly needed for MLDv2, which already jitters
532              its report transmissions.  However, the 'timer' argument is
533              preserved in case MLDv1 is active on the interface.
534
535         * The KAME linked-list based IPv6 membership implementation has
536           been refactored to use a vector similar to that used by the IPv4
537           stack.
538           Code which maintains a list of its own multicast memberships
539           internally, e.g. carp, has been updated to reflect the new
540           semantics.
541
542         * There is a known Lock Order Reversal (LOR) due to in6_setscope()
543           acquiring the IF_AFDATA_LOCK and being called within ip6_output().
544           Whilst MLDv2 tries to avoid this otherwise benign LOR, it is an
545           implementation constraint which needs to be addressed in HEAD.
546
547         For application developers:
548
549         * The changes are broadly similar to those made for the IPv4
550           stack.
551
552         * The use of IPv4 and IPv6 multicast socket options on the same
553           socket, using mapped addresses, HAS NOT been tested or supported.
554
555         * There are a number of issues with the implementation of various
556           IPv6 multicast APIs which need to be resolved in the API surface
557           before the implementation is fully compatible with KAME userland
558           use, and these are mostly to do with interface index treatment.
559
560         * The literature available discusses the use of either the delta / ASM
561           API with setsockopt(2)/getsockopt(2), or the full-state / ASM API
562           using setsourcefilter(3)/getsourcefilter(3). For more information
563           please refer to RFC 3768, 'Socket Interface Extensions for
564           Multicast Source Filters'.
565
566         * Applications which use the published RFC 3678 APIs should be fine.
567
568         For systems administrators:
569
570         * The mtest(8) utility has been refactored to support IPv6, in
571           addition to IPv4. Interface addresses are no longer accepted
572           as arguments, their names must be used instead. The utility
573           will map the interface name to its first IPv4 address as
574           returned by getifaddrs(3).
575
576         * The ifmcstat(8) utility has also been updated to print the MLDv2
577           endpoint state and source filter lists via sysctl(3).
578
579         * The net.inet6.ip6.mcast.loop sysctl may be tuned to 0 to disable
580           loopback of IPv6 multicast datagrams by default; it defaults to 1
581           to preserve the existing behaviour. Disabling multicast loopback is
582           recommended for optimal system performance.
583
584         * The IPv6 MROUTING code has been changed to examine this sysctl
585           instead of attempting to perform a group lookup before looping
586           back forwarded datagrams.
587
588         Bump __FreeBSD_version to 800084.
589
590 20090422:
591         Implement low-level Bluetooth HCI API.
592         Bump __FreeBSD_version to 800083.
593
594 20090419:
595         The layout of struct malloc_type, used by modules to register new
596         memory allocation types, has changed.  Most modules will need to
597         be rebuilt or panics may be experienced.
598         Bump __FreeBSD_version to 800081.
599
600 20090415:
601         Anticipate overflowing inp_flags - add inp_flags2.
602         This changes most offsets in inpcb, so checking v4 connection
603         state will require a world rebuild.
604         Bump __FreeBSD_version to 800080.
605
606 20090415:
607         Add an llentry to struct route and struct route_in6. Modules
608         embedding a struct route will need to be recompiled.
609         Bump __FreeBSD_version to 800079.
610
611 20090414:
612         The size of rt_metrics_lite and by extension rtentry has changed.
613         Networking administration apps will need to be recompiled.
614         The route command now supports show as an alias for get, weighting
615         of routes, sticky and nostick flags to alter the behavior of stateful
616         load balancing.
617         Bump __FreeBSD_version to 800078.
618
619 20090408:
620         Do not use Giant for kbdmux(4) locking. This is wrong and
621         apparently causing more problems than it solves. This will
622         re-open the issue where interrupt handlers may race with
623         kbdmux(4) in polling mode. Typical symptoms include (but
624         not limited to) duplicated and/or missing characters when
625         low level console functions (such as gets) are used while
626         interrupts are enabled (for example geli password prompt,
627         mountroot prompt etc.). Disabling kbdmux(4) may help.
628
629 20090407:
630         The size of structs vnet_net, vnet_inet and vnet_ipfw has changed;
631         kernel modules referencing any of the above need to be recompiled.
632         Bump __FreeBSD_version to 800075.
633
634 20090320:
635         GEOM_PART has become the default partition slicer for storage devices,
636         replacing GEOM_MBR, GEOM_BSD, GEOM_PC98 and GEOM_GPT slicers. It
637         introduces some changes:
638
639         MSDOS/EBR: the devices created from MSDOS extended partition entries
640         (EBR) can be named differently than with GEOM_MBR and are now symlinks
641         to devices with offset-based names. fstabs may need to be modified.
642
643         BSD: the "geometry does not match label" warning is harmless in most
644         cases but it points to problems in file system misalignment with
645         disk geometry. The "c" partition is now implicit, covers the whole
646         top-level drive and cannot be (mis)used by users.
647
648         General: Kernel dumps are now not allowed to be written to devices
649         whose partition types indicate they are meant to be used for file
650         systems (or, in case of MSDOS partitions, as something else than
651         the "386BSD" type).
652
653         Most of these changes date approximately from 200812.
654
655 20090319:
656         The uscanner(4) driver has been removed from the kernel. This follows
657         Linux removing theirs in 2.6 and making libusb the default interface
658         (supported by sane).
659
660 20090319:
661         The multicast forwarding code has been cleaned up. netstat(1)
662         only relies on KVM now for printing bandwidth upcall meters.
663         The IPv4 and IPv6 modules are split into ip_mroute_mod and
664         ip6_mroute_mod respectively. The config(5) options for statically
665         compiling this code remain the same, i.e. 'options MROUTING'.
666
667 20090315:
668         Support for the IFF_NEEDSGIANT network interface flag has been
669         removed, which means that non-MPSAFE network device drivers are no
670         longer supported.  In particular, if_ar, if_sr, and network device
671         drivers from the old (legacy) USB stack can no longer be built or
672         used.
673
674 20090313:
675         POSIX.1 Native Language Support (NLS) has been enabled in libc and
676         a bunch of new language catalog files have also been added.
677         This means that some common libc messages are now localized and
678         they depend on the LC_MESSAGES environmental variable.
679
680 20090313:
681         The k8temp(4) driver has been renamed to amdtemp(4) since
682         support for Family 10 and Family 11 CPU families was added.
683
684 20090309:
685         IGMPv3 and Source-Specific Multicast (SSM) have been merged
686         to the IPv4 stack. VIMAGE hooks are in but not yet used.
687
688         For kernel developers, the most important changes are that the
689         ip_output() and ip_input() paths no longer take the IN_MULTI_LOCK(),
690         and this lock has been downgraded to a non-recursive mutex.
691
692         Transport protocols (UDP, Raw IP) are now responsible for filtering
693         inbound multicast traffic according to group membership and source
694         filters. The imo_multicast_filter() KPI exists for this purpose.
695         Transports which do not use multicast (SCTP, TCP) already reject
696         multicast by default. Forwarding and receive performance may improve
697         as a mutex acquisition is no longer needed in the ip_input()
698         low-level input path.  in_addmulti() and in_delmulti() are shimmed
699         to new KPIs which exist to support SSM in-kernel.
700
701         For application developers, it is recommended that loopback of
702         multicast datagrams be disabled for best performance, as this
703         will still cause the lock to be taken for each looped-back
704         datagram transmission. The net.inet.ip.mcast.loop sysctl may
705         be tuned to 0 to disable loopback by default; it defaults to 1
706         to preserve the existing behaviour.
707
708         For systems administrators, to obtain best performance with
709         multicast reception and multiple groups, it is always recommended
710         that a card with a suitably precise hash filter is used. Hash
711         collisions will still result in the lock being taken within the
712         transport protocol input path to check group membership.
713
714         If deploying FreeBSD in an environment with IGMP snooping switches,
715         it is recommended that the net.inet.igmp.sendlocal sysctl remain
716         enabled; this forces 224.0.0.0/24 group membership to be announced
717         via IGMP.
718
719         The size of 'struct igmpstat' has changed; netstat needs to be
720         recompiled to reflect this.
721         Bump __FreeBSD_version to 800070.
722
723 20090309:
724         libusb20.so.1 is now installed as libusb.so.1 and the ports system
725         updated to use it. This requires a buildworld/installworld in order to
726         update the library and dependencies (usbconfig, etc). Its advisable to
727         rebuild all ports which uses libusb. More specific directions are given
728         in the ports collection UPDATING file. Any /etc/libmap.conf entries for
729         libusb are no longer required and can be removed.
730
731 20090302:
732         A workaround is committed to allow the creation of System V shared
733         memory segment of size > 2 GB on the 64-bit architectures.
734         Due to a limitation of the existing ABI, the shm_segsz member
735         of the struct shmid_ds, returned by shmctl(IPC_STAT) call is
736         wrong for large segments. Note that limits must be explicitly
737         raised to allow such segments to be created.
738
739 20090301:
740         The layout of struct ifnet has changed, requiring a rebuild of all
741         network device driver modules.
742
743 20090227:
744         The /dev handling for the new USB stack has changed, a
745         buildworld/installworld is required for libusb20.
746
747 20090223:
748         The new USB2 stack has now been permanently moved in and all kernel and
749         module names reverted to their previous values (eg, usb, ehci, ohci,
750         ums, ...).  The old usb stack can be compiled in by prefixing the name
751         with the letter 'o', the old usb modules have been removed.
752         Updating entry 20090216 for xorg and 20090215 for libmap may still
753         apply.
754
755 20090217:
756         The rc.conf(5) option if_up_delay has been renamed to
757         defaultroute_delay to better reflect its purpose. If you have
758         customized this setting in /etc/rc.conf you need to update it to
759         use the new name.
760
761 20090216:
762         xorg 7.4 wants to configure its input devices via hald which does not
763         yet work with USB2. If the keyboard/mouse does not work in xorg then
764         add
765                 Option "AllowEmptyInput" "off"
766         to your ServerLayout section.  This will cause X to use the configured
767         kbd and mouse sections from your xorg.conf.
768
769 20090215:
770         The GENERIC kernels for all architectures now default to the new USB2
771         stack. No kernel config options or code have been removed so if a
772         problem arises please report it and optionally revert to the old USB
773         stack. If you are loading USB kernel modules or have a custom kernel
774         that includes GENERIC then ensure that usb names are also changed over,
775         eg uftdi -> usb2_serial_ftdi.
776
777         Older programs linked against the ports libusb 0.1 need to be
778         redirected to the new stack's libusb20.  /etc/libmap.conf can
779         be used for this:
780                 # Map old usb library to new one for usb2 stack
781                 libusb-0.1.so.8 libusb20.so.1
782
783 20090209:
784         All USB ethernet devices now attach as interfaces under the name ueN
785         (eg. ue0). This is to provide a predictable name as vendors often
786         change usb chipsets in a product without notice.
787
788 20090203:
789         The ichsmb(4) driver has been changed to require SMBus slave
790         addresses be left-justified (xxxxxxx0b) rather than right-justified.
791         All of the other SMBus controller drivers require left-justified
792         slave addresses, so this change makes all the drivers provide the
793         same interface.
794
795 20090201:
796         INET6 statistics (struct ip6stat) was updated.
797         netstat(1) needs to be recompiled.
798
799 20090119:
800         NTFS has been removed from GENERIC kernel on amd64 to match
801         GENERIC on i386. Should not cause any issues since mount_ntfs(8)
802         will load ntfs.ko module automatically when NTFS support is
803         actually needed, unless ntfs.ko is not installed or security
804         level prohibits loading kernel modules. If either is the case,
805         "options NTFS" has to be added into kernel config.
806
807 20090115:
808         TCP Appropriate Byte Counting (RFC 3465) support added to kernel.
809         New field in struct tcpcb breaks ABI, so bump __FreeBSD_version to
810         800061. User space tools that rely on the size of struct tcpcb in
811         tcp_var.h (e.g. sockstat) need to be recompiled.
812
813 20081225:
814         ng_tty(4) module updated to match the new TTY subsystem.
815         Due to API change, user-level applications must be updated.
816         New API support added to mpd5 CVS and expected to be present
817         in next mpd5.3 release.
818
819 20081219:
820         With __FreeBSD_version 800060 the makefs tool is part of
821         the base system (it was a port).
822
823 20081216:
824         The afdata and ifnet locks have been changed from mutexes to
825         rwlocks, network modules will need to be re-compiled.
826
827 20081214:
828         __FreeBSD_version 800059 incorporates the new arp-v2 rewrite.
829         RTF_CLONING, RTF_LLINFO and RTF_WASCLONED flags are eliminated.
830         The new code reduced struct rtentry{} by 16 bytes on 32-bit
831         architecture and 40 bytes on 64-bit architecture. The userland
832         applications "arp" and "ndp" have been updated accordingly.
833         The output from "netstat -r" shows only routing entries and
834         none of the L2 information.
835
836 20081130:
837         __FreeBSD_version 800057 marks the switchover from the
838         binary ath hal to source code. Users must add the line:
839
840         options AH_SUPPORT_AR5416
841
842         to their kernel config files when specifying:
843
844         device  ath_hal
845
846         The ath_hal module no longer exists; the code is now compiled
847         together with the driver in the ath module.  It is now
848         possible to tailor chip support (i.e. reduce the set of chips
849         and thereby the code size); consult ath_hal(4) for details.
850
851 20081121:
852         __FreeBSD_version 800054 adds memory barriers to
853         <machine/atomic.h>, new interfaces to ifnet to facilitate
854         multiple hardware transmit queues for cards that support
855         them, and a lock-less ring-buffer implementation to
856         enable drivers to more efficiently manage queueing of
857         packets.
858
859 20081117:
860         A new version of ZFS (version 13) has been merged to -HEAD.
861         This version has zpool attribute "listsnapshots" off by
862         default, which means "zfs list" does not show snapshots,
863         and is the same as Solaris behavior.
864
865 20081028:
866         dummynet(4) ABI has changed. ipfw(8) needs to be recompiled.
867
868 20081009:
869         The uhci, ohci, ehci and slhci USB Host controller drivers have
870         been put into separate modules. If you load the usb module
871         separately through loader.conf you will need to load the
872         appropriate *hci module as well. E.g. for a UHCI-based USB 2.0
873         controller add the following to loader.conf:
874
875                 uhci_load="YES"
876                 ehci_load="YES"
877
878 20081009:
879         The ABI used by the PMC toolset has changed.  Please keep
880         userland (libpmc(3)) and the kernel module (hwpmc(4)) in
881         sync.
882
883 20081009:
884         atapci kernel module now includes only generic PCI ATA
885         driver. AHCI driver moved to ataahci kernel module.
886         All vendor-specific code moved into separate kernel modules:
887         ataacard, ataacerlabs, ataadaptec, ataamd, ataati, atacenatek,
888         atacypress, atacyrix, atahighpoint, ataintel, ataite, atajmicron,
889         atamarvell, atamicron, atanational, atanetcell, atanvidia,
890         atapromise, ataserverworks, atasiliconimage, atasis, atavia
891
892 20080820:
893         The TTY subsystem of the kernel has been replaced by a new
894         implementation, which provides better scalability and an
895         improved driver model. Most common drivers have been migrated to
896         the new TTY subsystem, while others have not. The following
897         drivers have not yet been ported to the new TTY layer:
898
899         PCI/ISA:
900                 cy, digi, rc, rp, sio
901
902         USB:
903                 ubser, ucycom
904
905         Line disciplines:
906                 ng_h4, ng_tty, ppp, sl, snp
907
908         Adding these drivers to your kernel configuration file shall
909         cause compilation to fail.
910
911 20080818:
912         ntpd has been upgraded to 4.2.4p5.
913
914 20080801:
915         OpenSSH has been upgraded to 5.1p1.
916
917         For many years, FreeBSD's version of OpenSSH preferred DSA
918         over RSA for host and user authentication keys.  With this
919         upgrade, we've switched to the vendor's default of RSA over
920         DSA.  This may cause upgraded clients to warn about unknown
921         host keys even for previously known hosts.  Users should
922         follow the usual procedure for verifying host keys before
923         accepting the RSA key.
924
925         This can be circumvented by setting the "HostKeyAlgorithms"
926         option to "ssh-dss,ssh-rsa" in ~/.ssh/config or on the ssh
927         command line.
928
929         Please note that the sequence of keys offered for
930         authentication has been changed as well.  You may want to
931         specify IdentityFile in a different order to revert this
932         behavior.
933
934 20080713:
935         The sio(4) driver has been removed from the i386 and amd64
936         kernel configuration files. This means uart(4) is now the
937         default serial port driver on those platforms as well.
938
939         To prevent collisions with the sio(4) driver, the uart(4) driver
940         uses different names for its device nodes. This means the
941         onboard serial port will now most likely be called "ttyu0"
942         instead of "ttyd0". You may need to reconfigure applications to
943         use the new device names.
944
945         When using the serial port as a boot console, be sure to update
946         /boot/device.hints and /etc/ttys before booting the new kernel.
947         If you forget to do so, you can still manually specify the hints
948         at the loader prompt:
949
950                 set hint.uart.0.at="isa"
951                 set hint.uart.0.port="0x3F8"
952                 set hint.uart.0.flags="0x10"
953                 set hint.uart.0.irq="4"
954                 boot -s
955
956 20080609:
957         The gpt(8) utility has been removed. Use gpart(8) to partition
958         disks instead.
959
960 20080603:
961         The version that Linuxulator emulates was changed from 2.4.2
962         to 2.6.16. If you experience any problems with Linux binaries
963         please try to set sysctl compat.linux.osrelease to 2.4.2 and
964         if it fixes the problem contact emulation mailing list.
965
966 20080525:
967         ISDN4BSD (I4B) was removed from the src tree. You may need to
968         update a your kernel configuration and remove relevant entries.
969
970 20080509:
971         I have checked in code to support multiple routing tables.
972         See the man pages setfib(1) and setfib(2).
973         This is a hopefully backwards compatible version,
974         but to make use of it you need to compile your kernel
975         with options ROUTETABLES=2 (or more up to 16).
976
977 20080420:
978         The 802.11 wireless support was redone to enable multi-bss
979         operation on devices that are capable.  The underlying device
980         is no longer used directly but instead wlanX devices are
981         cloned with ifconfig.  This requires changes to rc.conf files.
982         For example, change:
983                 ifconfig_ath0="WPA DHCP"
984         to
985                 wlans_ath0=wlan0
986                 ifconfig_wlan0="WPA DHCP"
987         see rc.conf(5) for more details.  In addition, mergemaster of
988         /etc/rc.d is highly recommended.  Simultaneous update of userland
989         and kernel wouldn't hurt either.
990
991         As part of the multi-bss changes the wlan_scan_ap and wlan_scan_sta
992         modules were merged into the base wlan module.  All references
993         to these modules (e.g. in kernel config files) must be removed.
994
995 20080408:
996         psm(4) has gained write(2) support in native operation level.
997         Arbitrary commands can be written to /dev/psm%d and status can
998         be read back from it.  Therefore, an application is responsible
999         for status validation and error recovery.  It is a no-op in
1000         other operation levels.
1001
1002 20080312:
1003         Support for KSE threading has been removed from the kernel.  To
1004         run legacy applications linked against KSE libmap.conf may
1005         be used.  The following libmap.conf may be used to ensure
1006         compatibility with any prior release:
1007
1008         libpthread.so.1 libthr.so.1
1009         libpthread.so.2 libthr.so.2
1010         libkse.so.3 libthr.so.3
1011
1012 20080301:
1013         The layout of struct vmspace has changed. This affects libkvm
1014         and any executables that link against libkvm and use the
1015         kvm_getprocs() function. In particular, but not exclusively,
1016         it affects ps(1), fstat(1), pkill(1), systat(1), top(1) and w(1).
1017         The effects are minimal, but it's advisable to upgrade world
1018         nonetheless.
1019
1020 20080229:
1021         The latest em driver no longer has support in it for the
1022         82575 adapter, this is now moved to the igb driver. The
1023         split was done to make new features that are incompatible
1024         with older hardware easier to do.
1025
1026 20080220:
1027         The new geom_lvm(4) geom class has been renamed to geom_linux_lvm(4),
1028         likewise the kernel option is now GEOM_LINUX_LVM.
1029
1030 20080211:
1031         The default NFS mount mode has changed from UDP to TCP for
1032         increased reliability.  If you rely on (insecurely) NFS
1033         mounting across a firewall you may need to update your
1034         firewall rules.
1035
1036 20080208:
1037         Belatedly note the addition of m_collapse for compacting
1038         mbuf chains.
1039
1040 20080126:
1041         The fts(3) structures have been changed to use adequate
1042         integer types for their members and so to be able to cope
1043         with huge file trees.  The old fts(3) ABI is preserved
1044         through symbol versioning in libc, so third-party binaries
1045         using fts(3) should still work, although they will not take
1046         advantage of the extended types.  At the same time, some
1047         third-party software might fail to build after this change
1048         due to unportable assumptions made in its source code about
1049         fts(3) structure members.  Such software should be fixed
1050         by its vendor or, in the worst case, in the ports tree.
1051         FreeBSD_version 800015 marks this change for the unlikely
1052         case that a portable fix is impossible.
1053
1054 20080123:
1055         To upgrade to -current after this date, you must be running
1056         FreeBSD not older than 6.0-RELEASE.  Upgrading to -current
1057         from 5.x now requires a stop over at RELENG_6 or RELENG_7 systems.
1058
1059 20071128:
1060         The ADAPTIVE_GIANT kernel option has been retired because its
1061         functionality is the default now.
1062
1063 20071118:
1064         The AT keyboard emulation of sunkbd(4) has been turned on
1065         by default. In order to make the special symbols of the Sun
1066         keyboards driven by sunkbd(4) work under X these now have
1067         to be configured the same way as Sun USB keyboards driven
1068         by ukbd(4) (which also does AT keyboard emulation), f.e.:
1069
1070         Option  "XkbLayout" "us"
1071         Option  "XkbRules" "xorg"
1072         Option  "XkbSymbols" "pc(pc105)+sun_vndr/usb(sun_usb)+us"
1073
1074 20071024:
1075         It has been decided that it is desirable to provide ABI
1076         backwards compatibility to the FreeBSD 4/5/6 versions of the
1077         PCIOCGETCONF, PCIOCREAD and PCIOCWRITE IOCTLs, which was
1078         broken with the introduction of PCI domain support (see the
1079         20070930 entry). Unfortunately, this required the ABI of
1080         PCIOCGETCONF to be broken again in order to be able to
1081         provide backwards compatibility to the old version of that
1082         IOCTL. Thus consumers of PCIOCGETCONF have to be recompiled
1083         again. As for prominent ports this affects neither pciutils
1084         nor xorg-server this time, the hal port needs to be rebuilt
1085         however.
1086
1087 20071020:
1088         The misnamed kthread_create() and friends have been renamed
1089         to kproc_create() etc. Many of the callers already
1090         used kproc_start()..
1091         I will return kthread_create() and friends in a while
1092         with implementations that actually create threads, not procs.
1093         Renaming corresponds with version 800002.
1094
1095 20071010:
1096         RELENG_7 branched.
1097
1098 COMMON ITEMS:
1099
1100         General Notes
1101         -------------
1102         Avoid using make -j when upgrading.  While generally safe, there are
1103         sometimes problems using -j to upgrade.  If your upgrade fails with
1104         -j, please try again without -j.  From time to time in the past there
1105         have been problems using -j with buildworld and/or installworld.  This
1106         is especially true when upgrading between "distant" versions (eg one
1107         that cross a major release boundary or several minor releases, or when
1108         several months have passed on the -current branch).
1109
1110         Sometimes, obscure build problems are the result of environment
1111         poisoning.  This can happen because the make utility reads its
1112         environment when searching for values for global variables.  To run
1113         your build attempts in an "environmental clean room", prefix all make
1114         commands with 'env -i '.  See the env(1) manual page for more details.
1115
1116         When upgrading from one major version to another it is generally best
1117         to upgrade to the latest code in the currently installed branch first,
1118         then do an upgrade to the new branch. This is the best-tested upgrade
1119         path, and has the highest probability of being successful.  Please try
1120         this approach before reporting problems with a major version upgrade.
1121
1122         ZFS notes
1123         ---------
1124         When upgrading the boot ZFS pool to a new version, always follow
1125         these two steps:
1126
1127         1.) recompile and reinstall the ZFS boot loader and boot block
1128         (this is part of "make buildworld" and "make installworld")
1129
1130         2.) update the ZFS boot block on your boot drive
1131
1132         The following example updates the ZFS boot block on the first
1133         partition (freebsd-boot) of a GPT partitioned drive ad0:
1134         "gpart bootcode -p /boot/gptzfsboot -i 1 ad0"
1135
1136         Non-boot pools do not need these updates.
1137
1138         To build a kernel
1139         -----------------
1140         If you are updating from a prior version of FreeBSD (even one just
1141         a few days old), you should follow this procedure.  It is the most
1142         failsafe as it uses a /usr/obj tree with a fresh mini-buildworld,
1143
1144         make kernel-toolchain
1145         make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
1146         make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
1147
1148         To test a kernel once
1149         ---------------------
1150         If you just want to boot a kernel once (because you are not sure
1151         if it works, or if you want to boot a known bad kernel to provide
1152         debugging information) run
1153         make installkernel KERNCONF=YOUR_KERNEL_HERE KODIR=/boot/testkernel
1154         nextboot -k testkernel
1155
1156         To just build a kernel when you know that it won't mess you up
1157         --------------------------------------------------------------
1158         This assumes you are already running a CURRENT system.  Replace
1159         ${arch} with the architecture of your machine (e.g. "i386",
1160         "arm", "amd64", "ia64", "pc98", "sparc64", "powerpc", "mips", etc).
1161
1162         cd src/sys/${arch}/conf
1163         config KERNEL_NAME_HERE
1164         cd ../compile/KERNEL_NAME_HERE
1165         make depend
1166         make
1167         make install
1168
1169         If this fails, go to the "To build a kernel" section.
1170
1171         To rebuild everything and install it on the current system.
1172         -----------------------------------------------------------
1173         # Note: sometimes if you are running current you gotta do more than
1174         # is listed here if you are upgrading from a really old current.
1175
1176         <make sure you have good level 0 dumps>
1177         make buildworld
1178         make kernel KERNCONF=YOUR_KERNEL_HERE
1179                                                         [1]
1180         <reboot in single user>                         [3]
1181         mergemaster -p                                  [5]
1182         make installworld
1183         mergemaster -i                                  [4]
1184         make delete-old                                 [6]
1185         <reboot>
1186
1187
1188         To cross-install current onto a separate partition
1189         --------------------------------------------------
1190         # In this approach we use a separate partition to hold
1191         # current's root, 'usr', and 'var' directories.   A partition
1192         # holding "/", "/usr" and "/var" should be about 2GB in
1193         # size.
1194
1195         <make sure you have good level 0 dumps>
1196         <boot into -stable>
1197         make buildworld
1198         make buildkernel KERNCONF=YOUR_KERNEL_HERE
1199         <maybe newfs current's root partition>
1200         <mount current's root partition on directory ${CURRENT_ROOT}>
1201         make installworld DESTDIR=${CURRENT_ROOT}
1202         make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
1203         make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
1204         cp /etc/fstab ${CURRENT_ROOT}/etc/fstab                    # if newfs'd
1205         <edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
1206         <reboot into current>
1207         <do a "native" rebuild/install as described in the previous section>
1208         <maybe install compatibility libraries from ports/misc/compat*>
1209         <reboot>
1210
1211
1212         To upgrade in-place from 8.x-stable to current
1213         ----------------------------------------------
1214         <make sure you have good level 0 dumps>
1215         make buildworld                                 [9]
1216         make kernel KERNCONF=YOUR_KERNEL_HERE           [8]
1217                                                         [1]
1218         <reboot in single user>                         [3]
1219         mergemaster -p                                  [5]
1220         make installworld
1221         mergemaster -i                                  [4]
1222         make delete-old                                 [6]
1223         <reboot>
1224
1225         Make sure that you've read the UPDATING file to understand the
1226         tweaks to various things you need.  At this point in the life
1227         cycle of current, things change often and you are on your own
1228         to cope.  The defaults can also change, so please read ALL of
1229         the UPDATING entries.
1230
1231         Also, if you are tracking -current, you must be subscribed to
1232         freebsd-current@freebsd.org.  Make sure that before you update
1233         your sources that you have read and understood all the recent
1234         messages there.  If in doubt, please track -stable which has
1235         much fewer pitfalls.
1236
1237         [1] If you have third party modules, such as vmware, you
1238         should disable them at this point so they don't crash your
1239         system on reboot.
1240
1241         [3] From the bootblocks, boot -s, and then do
1242                 fsck -p
1243                 mount -u /
1244                 mount -a
1245                 cd src
1246                 adjkerntz -i            # if CMOS is wall time
1247         Also, when doing a major release upgrade, it is required that
1248         you boot into single user mode to do the installworld.
1249
1250         [4] Note: This step is non-optional.  Failure to do this step
1251         can result in a significant reduction in the functionality of the
1252         system.  Attempting to do it by hand is not recommended and those
1253         that pursue this avenue should read this file carefully, as well
1254         as the archives of freebsd-current and freebsd-hackers mailing lists
1255         for potential gotchas.  The -U option is also useful to consider.
1256         See mergemaster(8) for more information.
1257
1258         [5] Usually this step is a noop.  However, from time to time
1259         you may need to do this if you get unknown user in the following
1260         step.  It never hurts to do it all the time.  You may need to
1261         install a new mergemaster (cd src/usr.sbin/mergemaster && make
1262         install) after the buildworld before this step if you last updated
1263         from current before 20020224 or from -stable before 20020408.
1264
1265         [6] This only deletes old files and directories. Old libraries
1266         can be deleted by "make delete-old-libs", but you have to make
1267         sure that no program is using those libraries anymore.
1268
1269         [8] In order to have a kernel that can run the 4.x binaries needed to
1270         do an installworld, you must include the COMPAT_FREEBSD4 option in
1271         your kernel.  Failure to do so may leave you with a system that is
1272         hard to boot to recover. A similar kernel option COMPAT_FREEBSD5 is
1273         required to run the 5.x binaries on more recent kernels.  And so on
1274         for COMPAT_FREEBSD6 and COMPAT_FREEBSD7.
1275
1276         Make sure that you merge any new devices from GENERIC since the
1277         last time you updated your kernel config file.
1278
1279         [9] When checking out sources, you must include the -P flag to have
1280         cvs prune empty directories.
1281
1282         If CPUTYPE is defined in your /etc/make.conf, make sure to use the
1283         "?=" instead of the "=" assignment operator, so that buildworld can
1284         override the CPUTYPE if it needs to.
1285
1286         MAKEOBJDIRPREFIX must be defined in an environment variable, and
1287         not on the command line, or in /etc/make.conf.  buildworld will
1288         warn if it is improperly defined.
1289 FORMAT:
1290
1291 This file contains a list, in reverse chronological order, of major
1292 breakages in tracking -current.  Not all things will be listed here,
1293 and it only starts on October 16, 2004.  Updating files can found in
1294 previous releases if your system is older than this.
1295
1296 Copyright information:
1297
1298 Copyright 1998-2009 M. Warner Losh.  All Rights Reserved.
1299
1300 Redistribution, publication, translation and use, with or without
1301 modification, in full or in part, in any form or format of this
1302 document are permitted without further permission from the author.
1303
1304 THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
1305 IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
1306 WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
1307 DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
1308 INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
1309 (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
1310 SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
1311 HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
1312 STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
1313 IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
1314 POSSIBILITY OF SUCH DAMAGE.
1315
1316 Contact Warner Losh if you have any questions about your use of
1317 this document.
1318
1319 $FreeBSD$