UPDATING revision 1.310
1$NetBSD: UPDATING,v 1.310 2020/06/15 21:52:03 christos Exp $
2
3This file (UPDATING) is intended to be a brief reference to recent
4changes that might cause problems in the build process, and a guide for
5what to do if something doesn't work.
6
7For a more detailed description of the recommended way to build NetBSD
8using build.sh, see the BUILDING file.
9
10Note that much of the advice in this UPDATING file was written before
11build.sh existed.  Nevertheless, the advice here may be useful for
12working around specific problems with build.sh.
13
14Sections are marked with "^^^^^".  After the section on "Recent changes"
15are several sections containing more general information.
16
17See also: BUILDING, build.sh, Makefile.
18
19Recent changes:
20^^^^^^^^^^^^^^^
21
2220200614:
23	blacklist* has been renamed to blocklist*. postinstall(8)
24	should handle the migration
25
2620200601:
27	Due to a mistake in LIBISPRIVATE handling, .so libraries were
28	created in the build directories and need cleaning.
29
3020200311:
31	GCC 8 ports will need cleaning in src/tools/gcc and
32	src/external/gpl3/gcc due to GCC 8.4 update.
33
3420191118:
35	More architectures were switched to gcc8:
36	    i386, ia64 powerpc64, sparc, sparc64, arm
37	The same comments as in 20191022 apply.
38
3920191112:
40	The LLVM update requires a clean rebuild for all architectures using
41	LLVM during the tools build phase (i386, amd64, aarch64).
42
4320191022:
44	Ports amd64 and aarch64 switched to GCC 8.3 by default.
45	In-place ("expert mode", build.sh -E) builds are not supported
46	when going from a GCC 7 userland to GCC 8. Do a regular
47	build to a different DESTDIR (or preferably: build.sh -U) at least
48	once and install sets, or download comp.{tar.xz,tgz} from the
49	daily builds and install that before doing the next in-place build.
50
5120191001:
52	GCC 8.3 was imported.  Builds of src/tools/gcc may fail if
53	old builds with GCC 7 output now uses GCC 8.  Clean this
54	directory, and also clean src/external/gpl3/gcc.
55
5620190903:
57	Files with names that coincide with existing files' names on
58	case-insensitive file systems were inadvertently committed, for
59	radeon GPU firmware.  We cannot mark these as obsolete for
60	postinstall to fix, so if you updated src since 2019-08-26, and
61	ran build.sh distribution or ran build.sh release, you must
62	manually delete the following files in your DESTDIR (which is
63	usually $OBJDIR/destir.$ARCH), or from / if you have installed
64	them:
65
66		/libdata/firmware/radeon/bonaire_ce.bin
67		/libdata/firmware/radeon/bonaire_mc.bin
68		/libdata/firmware/radeon/bonaire_me.bin
69		/libdata/firmware/radeon/bonaire_mec.bin
70		/libdata/firmware/radeon/bonaire_pfp.bin
71		/libdata/firmware/radeon/bonaire_rlc.bin
72		/libdata/firmware/radeon/bonaire_sdma.bin
73		/libdata/firmware/radeon/bonaire_smc.bin
74		/libdata/firmware/radeon/bonaire_uvd.bin
75		/libdata/firmware/radeon/hainan_ce.bin
76		/libdata/firmware/radeon/hainan_mc.bin
77		/libdata/firmware/radeon/hainan_me.bin
78		/libdata/firmware/radeon/hainan_pfp.bin
79		/libdata/firmware/radeon/hainan_rlc.bin
80		/libdata/firmware/radeon/hainan_smc.bin
81		/libdata/firmware/radeon/hawaii_ce.bin
82		/libdata/firmware/radeon/hawaii_mc.bin
83		/libdata/firmware/radeon/hawaii_me.bin
84		/libdata/firmware/radeon/hawaii_mec.bin
85		/libdata/firmware/radeon/hawaii_pfp.bin
86		/libdata/firmware/radeon/hawaii_rlc.bin
87		/libdata/firmware/radeon/hawaii_sdma.bin
88		/libdata/firmware/radeon/hawaii_smc.bin
89		/libdata/firmware/radeon/kabini_ce.bin
90		/libdata/firmware/radeon/kabini_me.bin
91		/libdata/firmware/radeon/kabini_mec.bin
92		/libdata/firmware/radeon/kabini_pfp.bin
93		/libdata/firmware/radeon/kabini_rlc.bin
94		/libdata/firmware/radeon/kabini_sdma.bin
95		/libdata/firmware/radeon/kaveri_ce.bin
96		/libdata/firmware/radeon/kaveri_me.bin
97		/libdata/firmware/radeon/kaveri_mec.bin
98		/libdata/firmware/radeon/kaveri_mec2.bin
99		/libdata/firmware/radeon/kaveri_pfp.bin
100		/libdata/firmware/radeon/kaveri_rlc.bin
101		/libdata/firmware/radeon/kaveri_sdma.bin
102		/libdata/firmware/radeon/mullins_ce.bin
103		/libdata/firmware/radeon/mullins_me.bin
104		/libdata/firmware/radeon/mullins_mec.bin
105		/libdata/firmware/radeon/mullins_pfp.bin
106		/libdata/firmware/radeon/mullins_rlc.bin
107		/libdata/firmware/radeon/mullins_sdma.bin
108		/libdata/firmware/radeon/oland_ce.bin
109		/libdata/firmware/radeon/oland_mc.bin
110		/libdata/firmware/radeon/oland_me.bin
111		/libdata/firmware/radeon/oland_pfp.bin
112		/libdata/firmware/radeon/oland_rlc.bin
113		/libdata/firmware/radeon/oland_smc.bin
114		/libdata/firmware/radeon/pitcairn_ce.bin
115		/libdata/firmware/radeon/pitcairn_mc.bin
116		/libdata/firmware/radeon/pitcairn_me.bin
117		/libdata/firmware/radeon/pitcairn_pfp.bin
118		/libdata/firmware/radeon/pitcairn_rlc.bin
119		/libdata/firmware/radeon/pitcairn_smc.bin
120		/libdata/firmware/radeon/tahiti_ce.bin
121		/libdata/firmware/radeon/tahiti_mc.bin
122		/libdata/firmware/radeon/tahiti_me.bin
123		/libdata/firmware/radeon/tahiti_pfp.bin
124		/libdata/firmware/radeon/tahiti_rlc.bin
125		/libdata/firmware/radeon/tahiti_smc.bin
126		/libdata/firmware/radeon/verde_ce.bin
127		/libdata/firmware/radeon/verde_mc.bin
128		/libdata/firmware/radeon/verde_me.bin
129		/libdata/firmware/radeon/verde_pfp.bin
130		/libdata/firmware/radeon/verde_rlc.bin
131		/libdata/firmware/radeon/verde_smc.bin
132
133	We will re-import these radeon firmware images another way
134	later.
135
13620190727:
137	The uefi bootloader has gained tftp support and needs a clean
138	build. If you do update builds, manually clean its object
139	directory by something like:
140	cd sys/arch/i386/stand/efiboot && make clean
141
14220190723:
143	The jemalloc allocator in libc is now build without extended
144	debugging (for performance reasons). In update builds make sure
145	to rebuild it completly, by removing all affected object files,
146	including compat builds, something like:
147	cd /usr/obj && find . -type d -name jemalloc|xargs rm -rf
148
14920190207:
150	GCC 7 switched for many ports.  Update builds are likely to fail.
151
15220180924:
153	A newer OpenSSL version has been imported. If you are doing
154	update builds, make sure to remove all old obj dirs, like:
155	cd /usr/obj && find . -type d -name openssl | xargs rm -rf
156
15720180717:
158	On aarch64 int64_t and related types have changed from long long
159	to long. This requires recompiling all C++ binaries.
160
16120180713:
162	On amd64 and i386 static binaries are now build position
163	independend. This requires recompilation of all object
164	files used to create the crunched /rescue binary.
165	Clean the rescue directory in your obj directory before
166	doing an update build, otherwise linking will fail.
167
16820180414:
169	Existing binutils was migrated to binutils.old.  Manual
170	removal of tools/binutils objects directory may be required
171	to fix tools build failure.
172
17320180311:
174	bdftopcf was updated and may need cleaning in the
175	src/external/mit/xorg/tools/bdftopcf subdirectory if there are
176	link errors.
177
17820180212:
179	between OpenSSL and GCC updates, many things may fail to build.
180	any failure that looks like GCC or openssl is best handled by
181	a clean destdir and objdir.  Full cleandir and destdir deletion
182	is recommended if build failures occur.
183
18420171225:
185	removal of the vadvise syscall requires manual removal of all
186	associated files from the libc build object directory (including
187	the .depend files) - a command like:
188		cd $OBJ && find . -type d -name libc | xargs rm -rf
189	For architectures that support multiple "compat" binary targets,
190	you'll need to cleanup both the regular libc directory and the
191	compat ones (the above command will do that).
192
19320171010:
194	a change to the build structure of external/bsd/acpica/bin/iasl
195	means that its objdir (or *.d and .depend at least) might need
196	to be manually removed - or a build done once without -u.
197
19820170822:
199	a new version of GMP has been imported and probably
200	will break parts of builds related to themselves or GCC, both
201	in the tools and the native section.  Remove all GCC, GMP, MPFR
202	and MPC objdirs or build once without -u.
203
20420170816:
205	a new version of MPFR and MPC have been imported and probably
206	will break parts of builds related to themselves or GCC, both
207	in the tools and the native section.  Remove all GCC, GMP, MPFR
208	and MPC objdirs or build once without -u.
209
21020170402:
211	a new version of dhcpcd has been imported, which does not support
212	update builds from the previous version. Remove your
213	external/bsd/dhcpcd object dir or build once without -u.
214
21520170211:
216	a new terminfo database has been imported.
217	The structure of it has changed slightly from prior versions and
218	an updated tic tool is required.
219	If you build.sh, don't use -u
220
22120170207:
222	various arch dependent libc/exect.S files were removed
223	Either remove the obj directories (lib/libc and compat/amd64/i386/lib
224	if it exists) or do a clean build.
225	(This is a bug in the make system, it should be corrected without
226	human intervention, but isn't.)
227
22820170104:
229	xinput build options have changed.
230	Remove the obj directory (external/mit/xorg/bin/xinput)
231	if you build.sh -u
232
23320170103:
234	a new version of flex has been imported.
235	Remove the file from obj (external/bsd/flex)
236	if you build.sh -u
237
23820161014:
239	a new version of OpenSSL has been imported.
240	Remove the files from obj (crypto/external/bsd/openssl) 
241	if you build.sh -u
242
24320161009:
244	a new version of dhcpcd has been imported with slightly changed
245	build infrastructure. When doing a build.sh -u this requires
246	pruning the external/bsd/dhcpcd objdir.
247
24820160914:
249	i386, amd64, shark, ofppc and macppc have joined shark and x68k
250	ports in using xorg-server 1.18. This requires a clean destdir
251	and a clean objdir.
252
25320160527:
254	i386 needs a full cleandir or objdir deletion because PIE has
255	been enabled. (see the amd64 entry two down for further info)
256
25720160418:
258	libedit needs manual removal of all autogenerated files since
259	some of them are not autogenerated anymore. Remember that there
260	might be two copies of libedit if your platform builds "compat".
261
26220160410:
263	amd64 needs full "make cleandir" or deletion of objdir now that
264	PIE has been enabled for amd64.  PIE, or position-independent
265	executables, means all code, including executables and not just
266	shared libraries, is position-independent and hence able to be
267	relocated by ASLR, address space layout randomization.
268
269	The change was made in Makefile variables for compiler and
270	linker flags, for which make(1) does not record dependencies,
271	hence it is unable to detect that all .o files need rebuilding.
272
273	Partial rebuilds with some modified source files will likely
274	fail when linking executables, since the linker refuses to mix
275	position-independent code with position-dependent code in
276	position-independent executables:
277
278		.../x86_64--netbsd/bin/ld: foo.o: relocation R_X86_64_32 against `...' cannot be used when making a shared object; recompile with -fPIC
279
28020160401:
281	Ports switching to GCC 5.3 will need a full "make cleandir".
282	Some people have found that cleandir is not sufficient, so if
283	in doubt delete the entire object directory tree for gcc.
284
28520160306:
286	NetBSD's regexp implementation is now part of libnbcompat.
287	Nblex, nbm4, nbpax, nbsed use it and they may crash on
288	non-NetBSD hosts if linked with stale object files produced
289	while they included a non-NetBSD regex.h.
290	In any case, you should "make cleandir" at least these tools
291	before updating your toolchain.
292
29320160125:
294	Dtrace has been enabled by default on some architectures.
295	When doing an update build, make sure to clean the etc/mtree
296	object directory before starting the build - otherwise the
297	needed directories in destdir will not be created.
298	An easy way to do this is:
299	   cd src/etc/mtree && $TOOLDIR/bin/nbmake-$arch cleandir
300
30120150818:
302	New acpica requires "make cleandir" in src/external/bsd/acpica
303	again.
304
30520150413:
306	New acpica requires "make cleandir" and reinstalling yacc
307	in /usr/src/external/bsd/byacc and /usr/src/tools/yacc and
308	also "make cleandir" in /usr/src/external/bsd/acpica.
309
31020150404:
311	Lint changes require a full rebuild of the tool, so make
312	sure to build without -u option to build.sh, or manually
313	do a make cleandir in src/tools/lint1 and
314	src/usr.bin/xlint.
315
31620150310:
317	Improvements to openssl for arm mean that update builds of
318	the openssl libraries will fail. A make cleandir in
319	external/bsd/openssl/lib is needed
320
32120141026:
322	A mishap during the import of pppd may cause your corruption
323	in your cvs directory if you happened to do a cvs update
324	during a short period of time. To fix, just remove the
325	directory src/external/bsd/ppp/dist/pppd completely
326	and let cvs restore it on next update.
327
32820140721:
329	The src/external/mit/lua/src directory was accidentally created
330	and then deleted in the CVS repository.  If you get errors like
331
332	cvs [update aborted]: cannot open directory
333	/cvsroot/src/external/mit/lua/src: No such file or directory
334
335	then delete your local copy of that directory tree and try again.
336
33720140530:
338	ARM eABI switched to DWARF based exception handling. This requires
339	rebuilding all C++ code. It is strongly advised to do a clean build.
340
34120140131:
342	The new compiler_rt/libc integration moved a few things. It is strongly
343	advised to do a clean build. At least lib/libc, the compat version(s)
344	of libc, libkern, rump and the kernels need to be cleaned.
345
34620131227:
347	1. The new ntpd runs in a restricted mode to prevent amplification
348	   attacks. If you need ntpdc to work you need to explicitly enable
349	   mode7 in your config file. Make sure you put the necessary restrict
350	   statements to avoid being exposed.
351	2. strncat has moved from lib/libc to common/lib/libc; you might need
352	   to make clean in libc
353
35420131129:
355	The GMP sources were updated, and builds will likely fail without
356	cleaning their build trees for both tools and in-tree, like below.
357
35820131128:
359	The MPC and MPFR sources were updated, and builds may require their
360	tools and in-tree directories cleaned for successful updates.
361
36220130605:
363	The kernel option FAST_IPSEC no longer exists, it's been renamed
364	to IPSEC (and the older IPSEC version removed).
365
36620130605:
367	Previous freetype installations eroneously installed private
368	header files. If you are building against a non-empty $DESTDIR,
369	please remove ${DESTDIR}//usr/X11R7/include/freetype2/freetype/.
370
37120130531:
372	The xdm update may cause build failure due to xdm.man being
373	in the obj tree.  Make sure to ensure any like this:
374		nbmake: nbmake: don't know how to make xdm.man. Stop
375	is fixed by deleting the xdm.man in the obj tree.
376
37720130530:
378	Updates of many xsrc packages will leave old .pc files around.
379	Best to clean out the xsrc objdir entirely before rebuilds.
380
38120130301:
382	The removal of netiso requires manual removal of /usr/include/netiso
383	prior to the build and make cleandir in /usr/src/usr.bin/{ktruss,kdump}
384
38520120726:
386	The update of OpenSSL requires cleaning both the OpenSSL build
387	directory and DESTDIR.  *Even non-update builds require cleaning
388	DESTDIR.* Builds done without taking these steps may fail, or in
389	some cases may succeed and install broken OpenSSL libraries that
390	cause third-party software to link incorrectly and/or crash.
391
39220120507:
393	The database schema for makemandb was changed.  You will
394	need to update the database using 'makemandb -f' or wait
395	for the next weekly run to fix it.
396
39720120319:
398	sys/conf/Makefile.kern.inc has been modified to adjust the
399	size of db_symtab automatically.  You need to update dbsym in
400	your $TOOLDIR to build kernels with options SYMTAB_SPACE.  If
401	you don't want this behavior, add AUTO_SYMTAB_SPACE=no to your
402	mk.conf.
403
40420120216:
405	Default for MKCATPAGES changed to NO.  Update builds will fail
406	unless DESTDIR is cleaned manually.  If you built between 20120207
407	and 20120216, daily and weekly could have created an unreadable
408	/var/db/man.db index for apropos.  Running makemandb -f or
409	the next run of weekly will fix it.
410
41120111227:
412	If you built between 20111225 and 20111227 you need to remove
413	/usr/lib/libpam.so.4* and /usr/lib/security/*.so.4, since the
414	bump has been reverted.
415
41620111125:
417	The "rnd" pseudodevice has been added to sys/conf/std, which
418	means it should no longer be explicitly listed in kernel
419	configuration files.  The line "pseudo-device rnd" should be
420	removed from any custom kernel config files users may have.
421
42220111119:
423	A problem with the datastructures used by the rndctl(8)
424	utility (pointers in datastructures in an array, making 32->64
425	bit compatibility very painful) has been fixed in a
426	non-backwards-compatible way.  If you replace your kernel,
427	replace your rndctl executable too.
428
42920111001:
430	the prop_*_send_syscall() functions from proplib(3) have been
431	changed and their new version is not backward compatible with the old
432	one.  So ensure that all consumers of these functions (currently:
433	quota2 code and its tests) are updated together with the new lib.
434
43520110817:
436	sparc has been changed to use GCC 4.5.3, so any objdir or
437	DESTDIR for them should be deleted before updating.
438
43920110806:
440	i386 and amd64 have been changed to use GCC 4.5.3, so any
441	objdir or DESTDIR for them should be deleted before updating.
442
44320110805:
444	The update to GCC 4.5.3 requires a non-trivial portion of
445	the tree to be cleaned.  Best to delete both objdir and
446	DESTDIR before running this update.  So far, only the
447	sparc64, mips and powerpc platforms have changed.
448
44920110803:
450	The layout of external/public-domain/xz has changed.  To do an
451	update build you will have to remove the contents of the OBJDIR
452	for external/public-domain/xz/bin by hand as the xz entry there
453	is now a directory.
454
45520110410:
456	The configuration of src/tools/gcc has changed.  To do an
457	update build you have to clean both tools/binutils and
458	tools/gcc by hand.
459
46020110328:
461	Building the Xorg binary was moved into a subdirectory to fix
462	ordering issues with "make all".  It may be necessary to remove
463	the OBJDIR for external/mit/xorg/server/xorg-server/hw/xfree86
464	if your update build fails, as the "Xorg" entry there is now a
465	directory.
466
46720110121:
468	Assembler files no longer use -traditional-cpp.  This can break
469	the build of individual parts of the tree.  This is handled
470	correctly by build.sh.  Manual builds have to update /usr/share/mk
471	and re-run config(1) for any kernel configurations as needed.
472
47320101217:
474	The tcpdump(8) program was changed to drop privileges and chroot(2)
475	by default.  It may be necessary to manually update passwd(5) and
476	group(5) in order to make the program work with existing setups.
477
47820101125:
479	The latest changes to setenv(3) dissallow setting environment
480	variables with names that contain '='.  Revision 1.18 of env.c
481	assumed that this was allowed.  Installing a new libc with an
482	old copy of /usr/bin/env causes env x=1 printenv | grep x= to
483	break which affects the autoconf tests for dependency finding,
484	so building gcc will end up printing:
485	    checking dependency style of gcc... none
486	    configure: error: no usable dependency style found
487	Fix it by rebuilding and re-installing env.
488
48920101119:
490	Recent Xorg updates in xsrc/external/mit/ may cause various build
491	or run-time problems.  Delete your entire DESTDIR and OBJDIR if you
492	have any build problems with xsrc, or problems with mismatched
493	versions between xorg-server and drivers.
494
49520100604:
496	The update of ATF to 0.9 causes old tests written in shell to fail
497	unless they are rebuilt.  If you are building with MKUPDATE=yes,
498	you need to clean the src/external/bsd/atf/tests/ and the src/tests/
499	trees by hand.
500
50120100522:
502	Recent Xorg updates in xsrc/external/mit/ will cause various build
503	problems.  Delete your entire DESTDIR and OBJDIR if you have any
504	build problems with xsrc.
505
50620100522:
507	private section of <ctype.h> was splitted, and now mklocale(1)
508	include ctype_local.h, so you have to make cleandir in tools/mklocale.
509
51020100520:
511	The location of the xkb compiled descriptions has changed.  Please
512	remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR.
513
51420100222:
515	The shared objects file extension has been changed from .so to
516	.pico, in order to avoid conflicts with shared libraries names
517	libXX.so.  All now stale regular .so files can be removed from
518	your object directories.
519
52020100204:
521	The termcap database has been removed from the sources,
522	but has not been marked obsolete so it is not removed
523	from the system when upgrading.
524	As such, you will need to remove them from your object
525	and destination directories.
526
52720091101:
528        After updating, it may be necessary to make the 'cleandir'
529        target in src/tools/yacc/ and in src/usr.bin/yacc/ before a
530        'build.sh -u tools' or 'build.sh -u distribution'.  Ditto
531        src/tools/lex/ and src/usr.bin/lex/.
532
53320091001:
534	On amd64 you must rebuild tools (to get the new binutils)
535	before building a kernel, or the build fails on cpufunc.S.
536
53720091001:
538	An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb
539	symlink, failing the build.  Delete the link, and the subdir
540	it is in, and retry your build.
541
54220090718:
543	libc build changed so that strchr() provides the extra entry
544	point for index().  Update build of libc.a (and libc_pic.a)
545	may fail because the archive contains the unwanted index.o.
546	(Similarly for strrchr() and rindex().)
547
54820090709:
549	Native Xorg was upgraded again.  Builds will probably fail again
550	without a clean objdir, at least for src/external/mit/xorg.
551
55220090616:
553	Native Xorg was upgraded.  Builds will need a clean objdir for
554	src/external/mit/xorg.  Upgrading a system from sets will not
555	work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc
556	subdirectory has been changed into a file, and this needs to
557	be manually "rm -r"'ed before installing xbase.tgz.
558
55920090501:
560	Several new functions were added to string.h/libc, and this
561	can cause autoconf problems during the tool build for people
562	who fail to clean out their tools objects properly.  If you
563	note messages about stpcpy, stpncpy or strnlen accompanying a
564	failure during the tool build, clean out all your tools
565	objects and start again.
566
56720090325:
568	The i386 port was switched to i486 default toolchain.  This requires
569	cleaning your src/tools directory and $TOOLDIR and rebuilding them.
570
57120090126:
572	The __posix_fadvise50 system call changed assembly stub type.  You
573	need to 'rm -f __posix_fadvise50.*' in the libc build directory
574	to avoid using the old assembly stub.
575
57620090202:
577	pkg_install now depends on the pkgdb cache for automatic conflict
578	detection.  It is recommented to rebuild the cache with
579	``pkg_admin rebuild''.
580
58120090110:
582	time_t and dev_t have been bumped to 64 bit quantities.  To upgrade:
583	1. Make sure your kernel has COMPAT_50 in it.  Build and install.
584	   This is needed even in the MODULAR kernel because there is
585	   conditionally compiled code in rtsock.c.
586	2. make sure build.sh completes and the binaries in a chroot work
587	   before installing.
588	3. If you don't use build.sh and you build directly to root, and
589	   your build breaks in the middle, don't despair.  Make sure headers
590	   are installed properly, and start building libraries first libc
591	   and libutil, install them and then continue building all the
592	   libraries in src/lib and src/gnu/lib and install them.  Once
593	   the new libraries are installed, you can restart the build.
594	4. If you compile packages and you notice link time warnings,
595	   rebuild the required packages to update their shared libraries.
596	   Any package you rebuild will require rebuilding all the packages
597	   that depend on it.
598	5. Next time you run pwd_mkdb with the new binary, the file
599	   will be upgraded and it will not be backwards compatible.
600	6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see
601	   lastlogx(5)) have been versioned, and there is a heuristic
602	   for utmp.  You are better off removing the old files after
603	   upgrading.  The automated clearing of /var/run during
604	   boot, and the automated rotating of files in /var/log by
605	   newsyslog(8), may mean that you do not have to remove the
606	   files manually.
607	7. The optional accounting file (/var/account/acct, see
608	   accton(8)) has not been versioned, and will need to be
609	   removed.  The automatic rotation of the accounting file by
610	   /etc/daily limits the bad consequences of failure to remove
611	   the file.
612	8. Application software that writes time_t to binary files on
613	   disk will break or need attention.  Most notably: if you are
614	   using PostgreSQL < 8.4, you need to dump your databases,
615	   rebuild PostgreSQL with the new time_t, then restore.
616
61720081219:
618	config(1) has been updated, and one of the files it creates -
619	swapnetbsd.o - has changed format.  You need to rebuild config
620	(done automatically by build.sh) and then you need to rerun
621	config on all kernel configuration files before rebuilding those
622	kernels.
623
62420081205:
625	If you build with MKX11=no, you should remove /etc/rc.d/xdm and
626	/etc/rc.d/xfs from DESTDIR because those files were moved to the xetc
627	set and will appear as extra files for MKX11=no update builds.
628
62920081122:
630	On i386, various kernel options(4) in GENERIC including
631	file systems have been disabled and moved into kernel modules.
632	Before trying a new GENERIC kernel, you have to prepare the
633	following files as well as a new GENERIC kernel:
634
635	- build and install kernel modules from src/sys/modules
636
637	- install the latest bootloader, which will load a module
638	  for the file system from which the kernel is loaded automatically
639
640	If you have to load your kernel from a file system which is not of
641	the same type as the root file system, you have to load the necessary
642	file system module manually on the boot prompt or in the boot.cfg file.
643
64420080827:
645	If you built and installed a libc from sources between
646	2008/08/20 and 2008/08/26 you got a broken strtouq(3)
647	which results in false errors reported by lint(1).
648	Since this breaks the libc build itself, manual help is
649	needed -- lint must be disabled temporarily, e.g.:
650	  $ (cd lib/libc && make MKLINT=no dependall install)
651
65220080813:
653	MKDEBUG build was broken because the .depend files did not know
654	about .go files.  You need to remove all .depend files and rebuild.
655
65620080802:
657	A regression in binary compatibility for pthread_mutex_t has
658	been fixed.  Unfortunately, the price is breaking compatibility
659	for -current.
660
661	Threaded programs (using libpthread) and C++ programs (using
662	libstdc++) compiled after 20070907 and before 20080802 need to
663	be recompiled.
664
665	One way to find affected pkgsrc packages:
666
667	  $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO
668	  $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO
669
67020080731:
671	WAPBL (metadata journaling support) has been added, but at this
672	time isn't backwards compatible with pre-WAPBL aware kernels
673	and userland (fsck_ffs in particular).  Please make sure you
674	don't use a journaled filesystem with an older kernel/userland,
675	especially an uncleanly mounted journaled filesystem.  WAPBL
676	also requires the super block to be in the UFS2 format.  You
677	can use fsck_ffs -c 4 to update the superblock format.
678
67920080721:
680	Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR
681	isn't defined.
682
68320080531:
684	The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed
685	from 125 (conflicted with DRVCTLCOMMAND) to 129.  The drvctl(8)
686	utility needs to be rebuilt and reinstalled as older binaries
687	won't work correctly.  The following sequence of commands:
688
689	  $ (cd sys/sys/ && nbmake-$arch includes)
690	  $ (cd sbin/drvctl/ && nbmake-$arch clean)
691	  $ (cd sbin/drvctl/ && nbmake-$arch all)
692
693	leaves new drvctl utility in sbin/drvctl build directory.
694
69520080503:
696	The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE.
697
69820080521:
699	For a while, unprivileged UPDATE builds would fail to
700	succeed at the checkflist stage, complaining that
701	${DESTDIR}/stand/<arch>/ did not exist.  A fix for this
702	problem was committed to share/mk/bsd.kmodule.mk, revision 1.9.
703	If you already hit this problem, update the .mk file,
704	remove ${DESTDIR}/stand/<arch>, and re-run the build.
705
70620080303:
707	Linker warnings are now fatal if $WARNS>0.
708
70920080126:
710	The posix_fadvise system call has been changed from an assembly
711	stub, to a c file that calls an assembly stub.  You need to
712	'rm -f posix_fadvise.* .depend' in the libc build directory to
713	avoid using the old assembly stub.
714
71520071209:
716	The acpiec(4) driver has been split into two attachments.  If you
717	get ACPI errors before the attachment, please update your kernel
718	configuration file appropriately or see GENERIC for more details.
719
72020071115:
721	The it(4) driver has been renamed to itesio(4) and the old port
722	argument specified in the kernel configuration file is not valid
723	anymore.  The itesio(4) driver now uses the Super I/O address port
724	rather than the EC address port.  Please update your kernel
725	configuration file appropriately or see GENERIC for more details.
726
72720071028:
728	The pccons(4) driver has been removed from the NetBSD/shark port.
729	You need to update any custom kernel configuration file you have
730	to remove any references to pccons (which includes removing the
731	now useless XSERVER option) and replace them with the correct
732	entries for the wscons driver.  See the GENERIC configuration file
733	for more details.
734
73520070913:
736	A latent bug in dhclient/dhcpd that caused it to be unable to
737	enumerate interfaces was fixed.  The bug began to cause
738	problems after 20070911 when the kernel's SIOCGIFCONF
739	implementation was repaired.  From 20070529 to 20070911 racoon
740	could not enumerate interfaces.  (These are noted because
741	normal kernel/userspace version matching hygiene is not
742	sufficient to avoid this problem.)  Ensure that both kernel
743	and userland are from after 20070913.
744
74520070703:
746	nbinstall has been renamed ${MACHINE_GNU_ARCH}-install.  It
747	calls the target-specific strip program, and the logic to pass
748	down STRIP from make has been removed.  This requires a
749	re-installation of tools.
750
75120070422:
752	The way OS emulations lookup filenames inside the emulation root
753	has been changed.  Rather than modify the pathname (and copy back
754	to userspace) namei() and lookup() directly check the emulation
755	root.  One side effect is that absolute symlinks inside the emulated
756	root file system will be relative to that file system - unless they
757	start /../ this is useful when the emulated root is a real install
758	that has such links.
759	This might affect symlinks that have been added to reference outside
760	the emulated root.
761
76220070412:
763	The pckbc driver on sgimips IP32 has been removed.  Use macekbc
764	instead.  See the GENERIC32_IP3x kernel configuration for an
765	example.
766
76720070319:
768        src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so
769        on many platforms due to incorrect flags settings.  If you
770        updated and built after about 20070315, do "nbmake-$arch
771	cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a
772	rebuild of object files that might have been built
773	incorrectly, and ensure that you have at least
774	src/lib/libc/Makefile 1.130.
775
77620070210:
777        src/sys/sys/{sa.h,savar.h} were removed.
778          find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \
779              | xargs egrep -l '/sa.h|/savar.h' | xargs rm
780        will allow dependencies on those files to get get rebuilt
781
78220070209:
783        The threading model was changed when the newlock2 branch
784        was merged to NetBSD-current.  If you boot with a new
785        kernel (version 4.99.10), then you also need a new pthread
786        library (/usr/lib/libpthread.so.0.7).  If you boot with
787        an old kernel, then you need the old pthread library
788        (/usr/lib/libpthread.so.0.6).  Provided you keep the kernel and
789        the pthread library in sync, old threaded applications should
790        continue to work with an old or new kernel.  Note that named(8)
791	is the only threaded application in the base system.
792
79320061214:
794	Following the move of string_to_flags() and flags_to_string()
795	from the bin/ls/ sources to libutil, users doing UPDATE builds
796	will need to do a "make cleandir" in
797		tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/,
798		bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/,
799		usr.bin/xinstall/, libexec/ftpd/, rescue/, as well
800		as the installation images in distrib/
801	in order to excise stale references to the old stat_flags.h header
802	file in the ls sources -- stat_flags.h has been removed.
803
80420061108:
805	The configure script used in the src/tools/gcc compiler has been
806	changed to indicate that our libc has ssp support built-in and
807	does not depend on -lssp and -lssp-nonshared.  You'll need to
808	make clean in src/tools/gcc first to rebuild the compiler.
809
81020061009:
811	The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer
812	available.  Use net.inet{,6}.tcp{,6}.congctl.selected instead.
813
81420060814:
815	The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been
816	withdrawn.  Use vidcvideo and pckbd instead.  See the GENERIC
817	kernel configuration for an example.  X servers from the last
818	few years should cope.
819
82020060703:
821	MPACPI is no more.  We always configure PCI interrupts using ACPI
822	if we have an ACPI kernel.  The option MPACPI_SCANPCI has been renamed
823	to ACPI_SCANPCI.  Thanks to work from fvdl.
824
82520060627:
826	socket(2) has changed, and its system call has been versioned.
827	For userlands with the old version of socket(2), make sure that
828	your kernel has 'options COMPAT_30' set, or else 'bad system call'
829	errors will result.
830
831Hints for a more successful build:
832^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
833    Use build.sh, but do not use its "expert mode":
834	This will automatically build the tools in the
835	   correct order, and it will keep the tools and the
836	   new build products from interfering with the running
837	   system.  This will allow you to ignore most of the
838	   other advice in this file.
839    Build a new kernel first:
840	This makes sure that any new system calls or features
841	   expected by the new userland will be present.  This
842	   helps to avoid critical errors when upgrading.
843    Use object directories:
844	This helps to keep stale object
845	   files from polluting the build if a Makefile "forgets"
846	   about one.  It also makes it easier to clean up after
847	   a build.  It's also necessary if you want to use the
848	   same source tree for multiple machines.
849	   To use object directories with build.sh:
850	    a) invoke build.sh with the "-M" or "-O" options.
851	   To use object directories without using build.sh:
852	    a) cd /usr/src ; make cleandir
853	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
854	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
855	    d) cd /usr/src ; make build
856	   Note that running "make obj" in a directory will create
857	   in obj.$MACHINE directory.
858    Build to a DESTDIR:
859	This helps to keep old installed files (especially libraries)
860	   from interfering with the new build.
861	   To build to a DESTDIR with build.sh, use the "-D" option.
862	   To build to a DESTDIR without using build.sh, set the DESTDIR
863	   environment variable before running make build.  It should be
864	   set to the pathname of an initially empty directory.
865	   Problems: if you do not use build.sh, you might need to
866		update critical utilities without using DESTDIR since
867		nothing is executed from what is installed in DESTDIR.
868		(See critical utils, below.)
869    Build often:
870	This keeps critical utilities current enough to not choke
871	on any other part of the source tree that depends on up to
872	date functionality.  If you use build.sh, you should not have
873	this problem.
874
875What to do if things don't work:
876^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
877When things don't work there are usually a few things that commonly
878should be done.
879    1)	make includes
880	This should be done automatically by make build.
881    2)  cd share/mk && make install
882	Again, automatically done by make build.
883
884Failsafe rebuild of a small part of the tree:
885^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
886To make sure you rebuild something correctly you want to do
887something like the following:
888    1)  Make sure the includes and .mk files are up to date.
889    2)  Make sure any program used to build the particular
890	utility is up to date.  (yacc, lex, etc...)
891    3)  cd ...path/to/util...
892	make cleandir
893	rm ...all obj directories...
894	make cleandir			# yes, again
895	make obj
896	make depend && make
897
898Failsafe rebuild of the entire tree:
899^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
900If you really want to make sure the source tree is clean and
901ready for a build try the following.  Note that sourcing /etc/mk.conf
902(a make(1) Makefile) in this manner is not right, and will not work
903for anyone who uses any make(1) features in /etc/mk.conf.
904
905---cut here---
906#!/bin/sh
907. /etc/mk.conf
908
909if [ -z $NETBSDSRCDIR ] ; then
910    NETBSDSRCDIR=/usr/src
911fi
912if [ \! -d $NETBSDSRCDIR ] ; then
913    echo Unable to find sources
914    exit 1
915fi
916find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
917
918if [ -z $BSDOBJDIR ] ; then
919    BSDOBJDIR=/usr/obj
920fi
921if [ -d $BSDOBJDIR ] ; then
922    rm -rf $BSDOBJDIR
923fi
924
925cd $NETBSDSRCDIR && make cleandir
926
927---cut here---
928
929Critical utilities:
930^^^^^^^^^^^^^^^^^^^
931	usr.bin/compile_et
932	usr.bin/make
933	usr.bin/yacc
934	usr.bin/lex
935	usr.bin/xlint
936	usr.bin/config
937
938Other problems and possible solutions:
939^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
940Symptom:Complaints involving a Makefile.
941Fix:	Rebuild usr.bin/make:
942	cd usr.bin/make && make && make install
943	Or, a failsafe method if that doesn't work:
944	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
945
946Fix:	Make sure .mk files are up to date.
947	cd share/mk && make install
948
949Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
950Fix:	Rebuild usr.bin/config
951
952Symptom:
953Fix:	Rebuild usr.bin/yacc
954
955Symptom:
956Fix:	Rebuild usr.bin/lex
957
958Symptom:
959Fix:	rm /usr/lib/libbfd.a
960
961Symptom:Obsolete intermediate files are used during compilation
962Fix:	Try the following sequence of commands in the directory in question.
963	make cleandir; rm `make print-objdir`; make cleandir; make obj
964	(If you built the tree without "make obj" in the past, obsolete files
965	may remain.  The command tries to clean everything up)
966
967Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
968	pointer type
969Fix:	Rebuild and install usr.bin/menuc
970
971Symptom:mklocale not found during build in share/locale/ctype
972Fix:	Build and install usr.bin/mklocale
973
974Symptom:undefined reference to `__assert13' or `__unsetenv13'
975Fix:    Rebuild and install lib/libc
976
977Symptom:usr.bin/config fails to build.
978Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
979
980Symptom:undefined reference to `getprogname' or `setprogname'
981Fix:    Rebuild and install lib/libc
982
983Symptom:lint does not understand the '-X' option
984Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
985
986Symptom:Update build fails in src/tools/gcc complaining that a variable
987	(e.g. CPPFLAGS) has changed since the previous run.
988Fix:    Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build.
989
990Symptom:cvs [update aborted]: cannot open directory /cvsroot/src/...:
991	No such file or directory.
992Cause:	If a directory is created by mistake, then it is sometimes
993	deleted from the CVS repository using administrative commands
994	that bypass the normal cvs access controls.  If your cvs working tree
995	contains references to a directory that has been deleted on the
996	server in this way, then "cvs update" reports this error.
997Fix:	Recursively delete the affected directory from your working tree
998	and try the update again.
999