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