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