xref: /freebsd/UPDATING (revision 6441fe959813cb24c38aa2a3e333ee11f536b282)
1Updating Information for FreeBSD current users
2
3This file is maintained and copyrighted by M. Warner Losh
4<imp@village.org>.  See end of file for further details.  For commonly
5done items, please see the COMMON ITEMS: section later in the file.
6
7Items affecting the ports and packages system can be found in
8/usr/ports/UPDATING.  Please read that file before running
9portupgrade.
10
11NOTE TO PEOPLE WHO THINK THAT FreeBSD 6.x IS SLOW:
12	FreeBSD 6.x has many debugging features turned on, in
13	both the kernel and userland.  These features attempt to detect
14	incorrect use of system primitives, and encourage loud failure
15	through extra sanity checking and fail stop semantics.  They
16	also substantially impact system performance.  If you want to
17	do performance measurement, benchmarking, and optimization,
18	you'll want to turn them off.  This includes various WITNESS-
19	related kernel options, INVARIANTS, malloc debugging flags
20	in userland, and various verbose features in the kernel.  Many
21	developers choose to disable these features on build machines
22	to maximize performance.
23
2420050503:
25	The packet filter (pf) code has been updated to OpenBSD 3.7
26	Please note the changed anchor syntax and the fact that
27	authpf(8) now needs a mounted fdescfs(5) to function.
28
2920050415:
30	The NO_MIXED_MODE kernel option has been removed from the i386
31	amd64 platforms as its use has been superceded by the new local
32	APIC timer code.  Any kernel config files containing this option
33	should be updated.
34
3520050227:
36	The on-disk format of LC_CTYPE files was changed to be machine
37	independent.  Please make sure NOT to use NO_CLEAN buildworld
38	when crossing this point.
39
4020050225:
41	The ifi_epoch member of struct if_data has been changed to
42	contain the uptime at which the interface was created or the
43	statistics zeroed rather then the wall clock time because
44	wallclock time may go backwards.  This should have no impact
45	unless an snmp implementation is using this value (I know of
46	none at this point.)
47
4820050224:
49	The acpi_perf and acpi_throttle drivers are now part of the
50	acpi(4) main module.  They are no longer built separately.
51
5220050223:
53	The layout of struct image_params has changed. You have to
54	recompile all compatibility modules (linux, svr4, etc) for use
55	with the new kernel.
56
5720050223:
58	The p4tcc driver has been merged into cpufreq(4).  This makes
59	"options CPU_ENABLE_TCC" obsolete.  Please load cpufreq.ko or
60	compile in "device cpufreq" to restore this functionality.
61
6220050220:
63	The responsibility of recomputing the file system summary of
64	a SoftUpdates-enabled dirty volume has been transferred to the
65	background fsck.  A rebuild of fsck(8) utility is recommended
66	if you have updated the kernel.
67
68	To get the old behavior (recompute file system summary at mount
69	time), you can set vfs.ffs.compute_summary_at_mount=1 before
70	mounting the new volume.
71
7220050206:
73	The cpufreq import is complete.  As part of this, the sysctls for
74	acpi(4) throttling have been removed.  The power_profile script
75	has been updated, so you can use performance/economy_cpu_freq in
76	rc.conf(5) to set AC on/offline cpu frequencies.
77
7820050206:
79	NG_VERSION has been increased. Recompiling kernel (or ng_socket.ko)
80	requires recompiling libnetgraph and userland netgraph utilities.
81
8220050114:
83	Support for abbreviated forms of a number of ipfw options is
84	now deprecated.  Warnings are printed to stderr indicating the
85	correct full form when a match occurs.  Some abbreviations may
86	be supported at a later date based on user feedback.  To be
87	considered for support, abbreviations must be in use prior to
88	this commit and unlikely to be confused with current key words.
89
9020041221:
91	By a popular demand, a lot of NOFOO options were renamed
92	to NO_FOO (see bsd.compat.mk for a full list).  The old
93	spellings are still supported, but will cause annoying
94	warnings on stderr.  Make sure you upgrade properly (see
95	the COMMON ITEMS: section later in this file).
96
9720041219:
98	Auto-loading of ancillary wlan modules such as wlan_wep has
99	been temporarily disabled; you need to statically configure
100	the modules you need into your kernel or explicitly load them
101	prior to use.  Specifically, if you intend to use WEP encryption
102	with an 802.11 device load/configure wlan_wep; if you want to
103	use WPA with the ath driver load/configure wlan_tkip, wlan_ccmp,
104	and wlan_xauth as required.
105
10620041213:
107	The behaviour of ppp(8) has changed slightly.  If lqr is enabled
108	(``enable lqr''), older versions would revert to LCP ECHO mode on
109	negotiation failure.  Now, ``enable echo'' is required for this
110	behaviour.  The ppp version number has been bumped to 3.4.2 to
111	reflect the change.
112
11320041201:
114	The wlan support has been updated to split the crypto support
115	into separate modules.  For static WEP you must configure the
116	wlan_wep module in your system or build and install the module
117	in place where it can be loaded (the kernel will auto-load
118	the module when a wep key is configured).
119
12020041201:
121	The ath driver has been updated to split the tx rate control
122	algorithm into a separate module.  You need to include either
123	ath_rate_onoe or ath_rate_amrr when configuring the kernel.
124
12520041116:
126	Support for systems with an 80386 CPU has been removed.  Please
127	use FreeBSD 5.x or earlier on systems with an 80386.
128
12920041110:
130	We have had a hack which would mount the root filesystem
131	R/W if the device were named 'md*'.  As part of the vnode
132	work I'm doing I have had to remove this hack.  People
133	building systems which use preloaded MD root filesystems
134	may need to insert a "/sbin/mount -u -o rw /dev/md0 /" in
135	their /etc/rc scripts.
136
13720041104:
138	FreeBSD 5.3 shipped here.
139
14020041102:
141	The size of struct tcpcb has changed again due to the removal
142	of RFC1644 T/TCP.  You have to recompile userland programs that
143	read kmem for tcp sockets directly (netstat, sockstat, etc.)
144
14520041022:
146	The size of struct tcpcb has changed.  You have to recompile
147	userland programs that read kmem for tcp sockets directly
148	(netstat, sockstat, etc.)
149
15020041016:
151	RELENG_5 branched here.  For older entries, please see updating
152	in the RELENG_5 branch.
153
154COMMON ITEMS:
155
156	General Notes
157	-------------
158	Avoid using make -j when upgrading.  From time to time in the
159	past there have been problems using -j with buildworld and/or
160	installworld.  This is especially true when upgrading between
161	"distant" versions (eg one that cross a major release boundary
162	or several minor releases, or when several months have passed
163	on the -current branch).
164
165	Sometimes, obscure build problems are the result of environment
166	poisoning.  This can happen because the make utility reads its
167	environment when searching for values for global variables.
168	To run your build attempts in an "environmental clean room",
169	prefix all make commands with 'env -i '.  See the env(1) manual
170	page for more details.
171
172	To build a kernel
173	-----------------
174	If you are updating from a prior version of FreeBSD (even one just
175	a few days old), you should follow this procedure. With a
176	/usr/obj tree with a fresh buildworld,
177	make -DALWAYS_CHECK_MAKE buildkernel KERNCONF=YOUR_KERNEL_HERE
178	make -DALWAYS_CHECK_MAKE installkernel KERNCONF=YOUR_KERNEL_HERE
179
180	To just build a kernel when you know that it won't mess you up
181	--------------------------------------------------------------
182	This assumes you are already running a 5.X system.  Replace
183	${arch} with the architecture of your machine (e.g. "i386",
184	"alpha", "amd64", "ia64", "pc98", "sparc64", etc).
185
186	cd src/sys/${arch}/conf
187	config KERNEL_NAME_HERE
188	cd ../compile/KERNEL_NAME_HERE
189	make depend
190	make
191	make install
192
193	If this fails, go to the "To build a kernel" section.
194
195	To rebuild everything and install it on the current system.
196	-----------------------------------------------------------
197	# Note: sometimes if you are running current you gotta do more than
198	# is listed here if you are upgrading from a really old current.
199
200	<make sure you have good level 0 dumps>
201	<maybe fix /etc/fstab>				[7]
202	make buildworld
203	make kernel KERNCONF=YOUR_KERNEL_HERE
204							[1]
205	<reboot in single user>				[3]
206	src/etc/rc.d/preseedrandom			[10]
207	mergemaster -p					[5]
208	make installworld
209	mergemaster					[4]
210	<reboot>
211
212
213	To cross-install current onto a separate partition
214	--------------------------------------------------
215	# In this approach we use a separate partition to hold
216	# current's root, 'usr', and 'var' directories.   A partition
217	# holding "/", "/usr" and "/var" should be about 2GB in
218	# size.
219
220	<make sure you have good level 0 dumps>
221	<boot into -stable>
222	make buildworld
223	make buildkernel KERNCONF=YOUR_KERNEL_HERE
224	<maybe newfs current's root partition>
225	<mount current's root partition on directory ${CURRENT_ROOT}>
226	make installworld DESTDIR=${CURRENT_ROOT}
227	cd src/etc; make distribution DESTDIR=${CURRENT_ROOT} # if newfs'd
228	make installkernel KERNCONF=YOUR_KERNEL_HERE DESTDIR=${CURRENT_ROOT}
229	cp /etc/fstab ${CURRENT_ROOT}/etc/fstab 		   # if newfs'd
230	<edit ${CURRENT_ROOT}/etc/fstab to mount "/" from the correct partition>
231	<reboot into current>
232	<do a "native" rebuild/install as described in the previous section>
233	<maybe install compatibility libraries from src/lib/compat>
234 	<reboot>
235
236
237	To upgrade in-place from 5.x-stable to current
238	----------------------------------------------
239	<make sure you have good level 0 dumps>
240	make buildworld					[9]
241	make kernel KERNCONF=YOUR_KERNEL_HERE		[8]
242							[1]
243	<reboot in single user>				[3]
244	mergemaster -p					[5]
245	make installworld
246	mergemaster -i					[4]
247	<reboot>
248
249	Make sure that you've read the UPDATING file to understand the
250	tweaks to various things you need.  At this point in the life
251	cycle of current, things change often and you are on your own
252	to cope.  The defaults can also change, so please read ALL of
253	the UPDATING entries.
254
255	Also, if you are tracking -current, you must be subscribed to
256	freebsd-current@freebsd.org.  Make sure that before you update
257	your sources that you have read and understood all the recent
258	messages there.  If in doubt, please track -stable which has
259	much fewer pitfalls.
260
261	[1] If you have third party modules, such as vmware, you
262	should disable them at this point so they don't crash your
263	system on reboot.
264
265	[3] From the bootblocks, boot -s, and then do
266		fsck -p
267		mount -u /
268		mount -a
269		cd src
270		adjkerntz -i		# if CMOS is wall time
271	Also, when doing a major release upgrade, it is required that
272	you boot into single user mode to do the installworld.
273
274	[4] Note: This step is non-optional.  Failure to do this step
275	can result in a significant reduction in the functionality of the
276	system.  Attempting to do it by hand is not recommended and those
277	that pursue this avenue should read this file carefully, as well
278	as the archives of freebsd-current and freebsd-hackers mailing lists
279	for potential gotchas.
280
281	[5] Usually this step is a noop.  However, from time to time
282	you may need to do this if you get unknown user in the following
283	step.  It never hurts to do it all the time.  You may need to
284	install a new mergemaster (cd src/usr.sbin/mergemaster && make
285	install) after the buildworld before this step if you last updated
286	from current before 20020224 or from -stable before 20020408.
287
288	[8] In order to have a kernel that can run the 4.x binaries
289	needed to do an installworld, you must include the COMPAT_FREEBSD4
290	option in your kernel.  Failure to do so may leave you with a system
291	that is hard to boot to recover.
292
293	Make sure that you merge any new devices from GENERIC since the
294	last time you updated your kernel config file.
295
296	[9] When checking out sources, you must include the -P flag to have
297	cvs prune empty directories.
298
299	If CPUTYPE is defined in your /etc/make.conf, make sure to use the
300	"?=" instead of the "=" assignment operator, so that buildworld can
301	override the CPUTYPE if it needs to.
302
303	MAKEOBJDIRPREFIX must be defined in an environment variable, and
304	not on the command line, or in /etc/make.conf.  buildworld will
305	warn if it is improperly defined.
306FORMAT:
307
308This file contains a list, in reverse chronological order, of major
309breakages in tracking -current.  Not all things will be listed here,
310and it only starts on October 16, 2004.  Updating files can found in
311previous releases if your system is older than this.
312
313Copyright information:
314
315Copyright 1998-2005 M. Warner Losh.  All Rights Reserved.
316
317Redistribution, publication, translation and use, with or without
318modification, in full or in part, in any form or format of this
319document are permitted without further permission from the author.
320
321THIS DOCUMENT IS PROVIDED BY WARNER LOSH ``AS IS'' AND ANY EXPRESS OR
322IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
323WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
324DISCLAIMED.  IN NO EVENT SHALL WARNER LOSH BE LIABLE FOR ANY DIRECT,
325INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
326(INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
327SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
328HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
329STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING
330IN ANY WAY OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE
331POSSIBILITY OF SUCH DAMAGE.
332
333If you find this document useful, and you want to, you may buy the
334author a beer.
335
336Contact Warner Losh if you have any questions about your use of
337this document.
338
339$FreeBSD$
340