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