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