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