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