UPDATING revision 1.337
1$NetBSD: UPDATING,v 1.337 2023/03/23 07:15: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
2220230322:
23	Fixes for moved /lib/libisns* mean that builds will complain about
24	./usr/lib/libisns* being missing until src/lib/libisns is forced
25	to (re)install the files, including the symlinks.  The simplest
26	way is to clean this subdir before building.
27
2820230112:
29	New binutils require an updated ld.elf_so. If you are doing
30	(unsupported) in-place self builds (with the -E flag to build.sh),
31	make sure to have installed latest ld.elf_so before you rebuild
32	userland.
33
3420221116:
35
36	The addition to NetBSD's version of UFS2 of support for extended
37	attributes broke backward compatibility with previous releases
38	of NetBSD, so UFS2 has been restored to being compatible with
39	previous NetBSD releases by disabling extended attributes.
40	(Note that ACLs are implemented as extended attributes, so
41	this changes disables ACLs as well.)
42
43	Support for UFS2 with extended attributes is now available in a new
44	UFS variant called UFS2ea.  If you have created extended attributes
45	in an original UFS2 file system then "fsck -p" will now fail due to
46	the unexpected presence of extended attributes and "fsck -y" will
47	remove all extended attributes.  If you wish to preserve extended
48	attributes rather than delete them, there is a utility to convert
49	a UFS2 file system to UFS2ea and leave extended attributes in place,
50	but this should be used with caution since it will preserve any
51	extended attributes that have been corrupted by the backward
52	incompatibility too.
53
54	If you wish to use a UFS2ea file system as your root file system,
55	then you will need to update your boot loader to a version that
56	supports UFS2ea.
57
58	For more information, see:
59	https://wiki.netbsd.org/features/UFS2ea
60
6120221111:
62	The new libdrm import worsened the conflict issues for the
63	kdump/ktruss ioctl, and i915 now conflicts with base, and has
64	been turned off.  This will cause update build issues like:
65
66		kdump-ioctl.c:12175:143: error: 'DRM_IOCTL_I915_DESTROY_HEAP'
67		   undeclared here (not in a function);
68		   did you mean 'DRM_IOCTL_MODE_DESTROY_DUMB'?
69
70	You'll need to clean usr.bin/ktruss, usr.bin/kdump, and rescue.
71
7220220921:
73	Since the kernel version was bumped to 9.99.100, the bootloader
74	must be updated on x86 or EFI boot platforms in order to load
75	modules from boot.cfg(5) or interactively at the bootloader
76	prompt.
77
78	The kernel can still load modules at runtime, with modload(8)
79	or modules.conf(5), with no bootloader update.  This will not
80	affect release branches because it only applies to patch
81	numbers >=100.
82
83	On x86 (i386 or amd64) with BIOS boot, this requires copying a
84	new /usr/mdec/boot to /boot.  You can build this in the destdir
85	by running `$TOOLDIR/bin/nbmake-$ARCH dependall install' in
86	sys/arch/i386/stand.
87
88	On platforms with EFI boot (including x86 with EFI boot), this
89	requires copying a new /usr/mdec/boot*.efi to the EFI/BOOT/
90	directory on the EFI system partition.  The boot*.efi file is:
91
92	aarch64	bootaa64.efi
93	amd64	bootx64.efi
94	arm	bootarm.efi	(32-bit arm)
95	i386	bootx32.efi
96
97	You can build this in the destdir by running
98	`$TOOLDIR/bin/nbmake-$ARCH dependall install' in
99	sys/stand/efiboot/boot*.
100
10120220821:
102	Support for building extsrc/ has been deprecated.
103	EXTSRCSRCDIR and MKEXTSRC have been deprecated.
104
10520220714:
106	Updates to xorg-server and associated drivers may cause builds to
107	fail.  Cleaning both DESTDIR and the xorg build tree may be needed.
108
10920220628:
110	Changes in the build of src/games/robots require a clean build
111	of that program.
112
11320211116:
114	Changes in the xorg build require clean obj dirs for external/mit/xorg
115	(or a full clean/non-update build).
116
11720211112:
118	Device tree sources were updated for evbarm.  Some device nodes
119	(in particular, ld(4) devices on the ROCKPro64) will be renumbered.
120
12120211014:
122	MKPIE default for aarch64 has changed, a clean build is required.
123
12420210917:
125	Changed MNT_ACLS to default to POSIX1e ACLs instead of NFSv4
126	ACLs, to be compatible with FreeBSD. If you are using NFSv4 ACLs
127	and have "acls" in /etc/fstab you'll need to change it to "nfs4acls".
128
12920210711:
130	Updated GMP sources may require cleaning in tools/gmp and/or in
131	external/lgpl3/gmp/lib, particularly if GCC itself does not build.
132
13320210417:
134	GCC 10 was enabled for several platforms.  If builds fail in either
135	tools/gcc or external/gpl/gcc, first try cleaning those objects and
136	removing the $DESTDIR/usr/include/g++ subdirectory.
137
13820201230:
139	lint1/ops.c is no longer autogenerated.  If this makes the build
140	fail, clean $OBJDIR/tools/*lint* and $OBJDIR/usr.bin/*xlint*.
141
14220201016:
143	MIPS kernel modules have been disabled until they work.  This will
144	turn up in extra files in the DESTDIR, which should be cleaned.
145
14620200925:
147	GNU MPC and MPFR have been updated.  At least MPFR needs cleaning
148	in both the tools and external dirs.
149
15020200912:
151	GCC 9 has arrived for Arm and x86 platforms, and will be coming
152	for several more, as will binutils 2.34.  Clean as required.
153
15420200907:
155	GCC 9 is coming, and binutils has been updated for MIPS.  This
156	probably requires cleaning the tools/binutils.
157
15820200811:
159	GCC updates may require cleaning the objdir.  This may occur
160	due to GCC 7.5 update, GCC 8.4 move to gcc.old, or the upcoming
161	GCC 9 upgrade.
162
16320200614:
164	blacklist* has been renamed to blocklist*. postinstall(8)
165	should handle the migration.
166
16720200601:
168	Due to a mistake in LIBISPRIVATE handling, .so libraries were
169	created in the build directories and need cleaning.
170
17120200311:
172	GCC 8 ports will need cleaning in src/tools/gcc and
173	src/external/gpl3/gcc due to GCC 8.4 update.
174
17520191118:
176	More architectures were switched to gcc8:
177	    i386, ia64 powerpc64, sparc, sparc64, arm
178	The same comments as in 20191022 apply.
179
18020191112:
181	The LLVM update requires a clean rebuild for all architectures using
182	LLVM during the tools build phase (i386, amd64, aarch64).
183
18420191022:
185	Ports amd64 and aarch64 switched to GCC 8.3 by default.
186	In-place ("expert mode", build.sh -E) builds are not supported
187	when going from a GCC 7 userland to GCC 8. Do a regular
188	build to a different DESTDIR (or preferably: build.sh -U) at least
189	once and install sets, or download comp.{tar.xz,tgz} from the
190	daily builds and install that before doing the next in-place build.
191
19220191001:
193	GCC 8.3 was imported.  Builds of src/tools/gcc may fail if
194	old builds with GCC 7 output now uses GCC 8.  Clean this
195	directory, and also clean src/external/gpl3/gcc.
196
19720190903:
198	Files with names that coincide with existing files' names on
199	case-insensitive file systems were inadvertently committed, for
200	radeon GPU firmware.  We cannot mark these as obsolete for
201	postinstall to fix, so if you updated src since 2019-08-26, and
202	ran build.sh distribution or ran build.sh release, you must
203	manually delete the following files in your DESTDIR (which is
204	usually $OBJDIR/destir.$ARCH), or from / if you have installed
205	them:
206
207		/libdata/firmware/radeon/bonaire_ce.bin
208		/libdata/firmware/radeon/bonaire_mc.bin
209		/libdata/firmware/radeon/bonaire_me.bin
210		/libdata/firmware/radeon/bonaire_mec.bin
211		/libdata/firmware/radeon/bonaire_pfp.bin
212		/libdata/firmware/radeon/bonaire_rlc.bin
213		/libdata/firmware/radeon/bonaire_sdma.bin
214		/libdata/firmware/radeon/bonaire_smc.bin
215		/libdata/firmware/radeon/bonaire_uvd.bin
216		/libdata/firmware/radeon/hainan_ce.bin
217		/libdata/firmware/radeon/hainan_mc.bin
218		/libdata/firmware/radeon/hainan_me.bin
219		/libdata/firmware/radeon/hainan_pfp.bin
220		/libdata/firmware/radeon/hainan_rlc.bin
221		/libdata/firmware/radeon/hainan_smc.bin
222		/libdata/firmware/radeon/hawaii_ce.bin
223		/libdata/firmware/radeon/hawaii_mc.bin
224		/libdata/firmware/radeon/hawaii_me.bin
225		/libdata/firmware/radeon/hawaii_mec.bin
226		/libdata/firmware/radeon/hawaii_pfp.bin
227		/libdata/firmware/radeon/hawaii_rlc.bin
228		/libdata/firmware/radeon/hawaii_sdma.bin
229		/libdata/firmware/radeon/hawaii_smc.bin
230		/libdata/firmware/radeon/kabini_ce.bin
231		/libdata/firmware/radeon/kabini_me.bin
232		/libdata/firmware/radeon/kabini_mec.bin
233		/libdata/firmware/radeon/kabini_pfp.bin
234		/libdata/firmware/radeon/kabini_rlc.bin
235		/libdata/firmware/radeon/kabini_sdma.bin
236		/libdata/firmware/radeon/kaveri_ce.bin
237		/libdata/firmware/radeon/kaveri_me.bin
238		/libdata/firmware/radeon/kaveri_mec.bin
239		/libdata/firmware/radeon/kaveri_mec2.bin
240		/libdata/firmware/radeon/kaveri_pfp.bin
241		/libdata/firmware/radeon/kaveri_rlc.bin
242		/libdata/firmware/radeon/kaveri_sdma.bin
243		/libdata/firmware/radeon/mullins_ce.bin
244		/libdata/firmware/radeon/mullins_me.bin
245		/libdata/firmware/radeon/mullins_mec.bin
246		/libdata/firmware/radeon/mullins_pfp.bin
247		/libdata/firmware/radeon/mullins_rlc.bin
248		/libdata/firmware/radeon/mullins_sdma.bin
249		/libdata/firmware/radeon/oland_ce.bin
250		/libdata/firmware/radeon/oland_mc.bin
251		/libdata/firmware/radeon/oland_me.bin
252		/libdata/firmware/radeon/oland_pfp.bin
253		/libdata/firmware/radeon/oland_rlc.bin
254		/libdata/firmware/radeon/oland_smc.bin
255		/libdata/firmware/radeon/pitcairn_ce.bin
256		/libdata/firmware/radeon/pitcairn_mc.bin
257		/libdata/firmware/radeon/pitcairn_me.bin
258		/libdata/firmware/radeon/pitcairn_pfp.bin
259		/libdata/firmware/radeon/pitcairn_rlc.bin
260		/libdata/firmware/radeon/pitcairn_smc.bin
261		/libdata/firmware/radeon/tahiti_ce.bin
262		/libdata/firmware/radeon/tahiti_mc.bin
263		/libdata/firmware/radeon/tahiti_me.bin
264		/libdata/firmware/radeon/tahiti_pfp.bin
265		/libdata/firmware/radeon/tahiti_rlc.bin
266		/libdata/firmware/radeon/tahiti_smc.bin
267		/libdata/firmware/radeon/verde_ce.bin
268		/libdata/firmware/radeon/verde_mc.bin
269		/libdata/firmware/radeon/verde_me.bin
270		/libdata/firmware/radeon/verde_pfp.bin
271		/libdata/firmware/radeon/verde_rlc.bin
272		/libdata/firmware/radeon/verde_smc.bin
273
274	We will re-import these radeon firmware images another way
275	later.
276
27720190727:
278	The uefi bootloader has gained tftp support and needs a clean
279	build. If you do update builds, manually clean its object
280	directory by something like:
281	cd sys/arch/i386/stand/efiboot && make clean
282
28320190723:
284	The jemalloc allocator in libc is now build without extended
285	debugging (for performance reasons). In update builds make sure
286	to rebuild it completely, by removing all affected object files,
287	including compat builds, something like:
288	cd /usr/obj && find . -type d -name jemalloc|xargs rm -rf
289
29020190207:
291	GCC 7 switched for many ports.  Update builds are likely to fail.
292
29320180924:
294	A newer OpenSSL version has been imported. If you are doing
295	update builds, make sure to remove all old obj dirs, like:
296	cd /usr/obj && find . -type d -name openssl | xargs rm -rf
297
29820180717:
299	On aarch64 int64_t and related types have changed from long long
300	to long. This requires recompiling all C++ binaries.
301
30220180713:
303	On amd64 and i386 static binaries are now build position
304	independend. This requires recompilation of all object
305	files used to create the crunched /rescue binary.
306	Clean the rescue directory in your obj directory before
307	doing an update build, otherwise linking will fail.
308
30920180414:
310	Existing binutils was migrated to binutils.old.  Manual
311	removal of tools/binutils objects directory may be required
312	to fix tools build failure.
313
31420180311:
315	bdftopcf was updated and may need cleaning in the
316	src/external/mit/xorg/tools/bdftopcf subdirectory if there are
317	link errors.
318
31920180212:
320	between OpenSSL and GCC updates, many things may fail to build.
321	any failure that looks like GCC or openssl is best handled by
322	a clean destdir and objdir.  Full cleandir and destdir deletion
323	is recommended if build failures occur.
324
32520171225:
326	removal of the vadvise syscall requires manual removal of all
327	associated files from the libc build object directory (including
328	the .depend files) - a command like:
329		cd $OBJ && find . -type d -name libc | xargs rm -rf
330	For architectures that support multiple "compat" binary targets,
331	you'll need to cleanup both the regular libc directory and the
332	compat ones (the above command will do that).
333
33420171010:
335	a change to the build structure of external/bsd/acpica/bin/iasl
336	means that its objdir (or *.d and .depend at least) might need
337	to be manually removed - or a build done once without -u.
338
33920170822:
340	a new version of GMP has been imported and probably
341	will break parts of builds related to themselves or GCC, both
342	in the tools and the native section.  Remove all GCC, GMP, MPFR
343	and MPC objdirs or build once without -u.
344
34520170816:
346	a new version of MPFR and MPC have been imported and probably
347	will break parts of builds related to themselves or GCC, both
348	in the tools and the native section.  Remove all GCC, GMP, MPFR
349	and MPC objdirs or build once without -u.
350
35120170402:
352	a new version of dhcpcd has been imported, which does not support
353	update builds from the previous version. Remove your
354	external/bsd/dhcpcd object dir or build once without -u.
355
35620170211:
357	a new terminfo database has been imported.
358	The structure of it has changed slightly from prior versions and
359	an updated tic tool is required.
360	If you build.sh, don't use -u
361
36220170207:
363	various arch dependent libc/exect.S files were removed
364	Either remove the obj directories (lib/libc and compat/amd64/i386/lib
365	if it exists) or do a clean build.
366	(This is a bug in the make system, it should be corrected without
367	human intervention, but isn't.)
368
36920170104:
370	xinput build options have changed.
371	Remove the obj directory (external/mit/xorg/bin/xinput)
372	if you build.sh -u
373
37420170103:
375	a new version of flex has been imported.
376	Remove the file from obj (external/bsd/flex)
377	if you build.sh -u
378
37920161014:
380	a new version of OpenSSL has been imported.
381	Remove the files from obj (crypto/external/bsd/openssl) 
382	if you build.sh -u
383
38420161009:
385	a new version of dhcpcd has been imported with slightly changed
386	build infrastructure. When doing a build.sh -u this requires
387	pruning the external/bsd/dhcpcd objdir.
388
38920160914:
390	i386, amd64, shark, ofppc and macppc have joined shark and x68k
391	ports in using xorg-server 1.18. This requires a clean destdir
392	and a clean objdir.
393
39420160527:
395	i386 needs a full cleandir or objdir deletion because PIE has
396	been enabled. (see the amd64 entry two down for further info)
397
39820160418:
399	libedit needs manual removal of all autogenerated files since
400	some of them are not autogenerated anymore. Remember that there
401	might be two copies of libedit if your platform builds "compat".
402
40320160410:
404	amd64 needs full "make cleandir" or deletion of objdir now that
405	PIE has been enabled for amd64.  PIE, or position-independent
406	executables, means all code, including executables and not just
407	shared libraries, is position-independent and hence able to be
408	relocated by ASLR, address space layout randomization.
409
410	The change was made in Makefile variables for compiler and
411	linker flags, for which make(1) does not record dependencies,
412	hence it is unable to detect that all .o files need rebuilding.
413
414	Partial rebuilds with some modified source files will likely
415	fail when linking executables, since the linker refuses to mix
416	position-independent code with position-dependent code in
417	position-independent executables:
418
419		.../x86_64--netbsd/bin/ld: foo.o: relocation R_X86_64_32 against `...' cannot be used when making a shared object; recompile with -fPIC
420
42120160401:
422	Ports switching to GCC 5.3 will need a full "make cleandir".
423	Some people have found that cleandir is not sufficient, so if
424	in doubt delete the entire object directory tree for gcc.
425
42620160306:
427	NetBSD's regexp implementation is now part of libnbcompat.
428	Nblex, nbm4, nbpax, nbsed use it and they may crash on
429	non-NetBSD hosts if linked with stale object files produced
430	while they included a non-NetBSD regex.h.
431	In any case, you should "make cleandir" at least these tools
432	before updating your toolchain.
433
43420160125:
435	Dtrace has been enabled by default on some architectures.
436	When doing an update build, make sure to clean the etc/mtree
437	object directory before starting the build - otherwise the
438	needed directories in destdir will not be created.
439	An easy way to do this is:
440	   cd src/etc/mtree && $TOOLDIR/bin/nbmake-$arch cleandir
441
44220150818:
443	New acpica requires "make cleandir" in src/external/bsd/acpica
444	again.
445
44620150413:
447	New acpica requires "make cleandir" and reinstalling yacc
448	in /usr/src/external/bsd/byacc and /usr/src/tools/yacc and
449	also "make cleandir" in /usr/src/external/bsd/acpica.
450
45120150404:
452	Lint changes require a full rebuild of the tool, so make
453	sure to build without -u option to build.sh, or manually
454	do a make cleandir in src/tools/lint1 and
455	src/usr.bin/xlint.
456
45720150310:
458	Improvements to openssl for arm mean that update builds of
459	the openssl libraries will fail. A make cleandir in
460	external/bsd/openssl/lib is needed
461
46220141026:
463	A mishap during the import of pppd may cause your corruption
464	in your cvs directory if you happened to do a cvs update
465	during a short period of time. To fix, just remove the
466	directory src/external/bsd/ppp/dist/pppd completely
467	and let cvs restore it on next update.
468
46920140721:
470	The src/external/mit/lua/src directory was accidentally created
471	and then deleted in the CVS repository.  If you get errors like
472
473	cvs [update aborted]: cannot open directory
474	/cvsroot/src/external/mit/lua/src: No such file or directory
475
476	then delete your local copy of that directory tree and try again.
477
47820140530:
479	ARM eABI switched to DWARF based exception handling. This requires
480	rebuilding all C++ code. It is strongly advised to do a clean build.
481
48220140131:
483	The new compiler_rt/libc integration moved a few things. It is strongly
484	advised to do a clean build. At least lib/libc, the compat version(s)
485	of libc, libkern, rump and the kernels need to be cleaned.
486
48720131227:
488	1. The new ntpd runs in a restricted mode to prevent amplification
489	   attacks. If you need ntpdc to work you need to explicitly enable
490	   mode7 in your config file. Make sure you put the necessary restrict
491	   statements to avoid being exposed.
492	2. strncat has moved from lib/libc to common/lib/libc; you might need
493	   to make clean in libc
494
49520131129:
496	The GMP sources were updated, and builds will likely fail without
497	cleaning their build trees for both tools and in-tree, like below.
498
49920131128:
500	The MPC and MPFR sources were updated, and builds may require their
501	tools and in-tree directories cleaned for successful updates.
502
50320130605:
504	The kernel option FAST_IPSEC no longer exists, it's been renamed
505	to IPSEC (and the older IPSEC version removed).
506
50720130605:
508	Previous freetype installations erroneously installed private
509	header files. If you are building against a non-empty $DESTDIR,
510	please remove ${DESTDIR}//usr/X11R7/include/freetype2/freetype/.
511
51220130531:
513	The xdm update may cause build failure due to xdm.man being
514	in the obj tree.  Make sure to ensure any like this:
515		nbmake: nbmake: don't know how to make xdm.man. Stop
516	is fixed by deleting the xdm.man in the obj tree.
517
51820130530:
519	Updates of many xsrc packages will leave old .pc files around.
520	Best to clean out the xsrc objdir entirely before rebuilds.
521
52220130301:
523	The removal of netiso requires manual removal of /usr/include/netiso
524	prior to the build and make cleandir in /usr/src/usr.bin/{ktruss,kdump}
525
52620120726:
527	The update of OpenSSL requires cleaning both the OpenSSL build
528	directory and DESTDIR.  *Even non-update builds require cleaning
529	DESTDIR.* Builds done without taking these steps may fail, or in
530	some cases may succeed and install broken OpenSSL libraries that
531	cause third-party software to link incorrectly and/or crash.
532
53320120507:
534	The database schema for makemandb was changed.  You will
535	need to update the database using 'makemandb -f' or wait
536	for the next weekly run to fix it.
537
53820120319:
539	sys/conf/Makefile.kern.inc has been modified to adjust the
540	size of db_symtab automatically.  You need to update dbsym in
541	your $TOOLDIR to build kernels with options SYMTAB_SPACE.  If
542	you don't want this behavior, add AUTO_SYMTAB_SPACE=no to your
543	mk.conf.
544
54520120216:
546	Default for MKCATPAGES changed to NO.  Update builds will fail
547	unless DESTDIR is cleaned manually.  If you built between 20120207
548	and 20120216, daily and weekly could have created an unreadable
549	/var/db/man.db index for apropos.  Running makemandb -f or
550	the next run of weekly will fix it.
551
55220111227:
553	If you built between 20111225 and 20111227 you need to remove
554	/usr/lib/libpam.so.4* and /usr/lib/security/*.so.4, since the
555	bump has been reverted.
556
55720111125:
558	The "rnd" pseudodevice has been added to sys/conf/std, which
559	means it should no longer be explicitly listed in kernel
560	configuration files.  The line "pseudo-device rnd" should be
561	removed from any custom kernel config files users may have.
562
56320111119:
564	A problem with the datastructures used by the rndctl(8)
565	utility (pointers in datastructures in an array, making 32->64
566	bit compatibility very painful) has been fixed in a
567	non-backwards-compatible way.  If you replace your kernel,
568	replace your rndctl executable too.
569
57020111001:
571	the prop_*_send_syscall() functions from proplib(3) have been
572	changed and their new version is not backward compatible with the old
573	one.  So ensure that all consumers of these functions (currently:
574	quota2 code and its tests) are updated together with the new lib.
575
57620110817:
577	sparc has been changed to use GCC 4.5.3, so any objdir or
578	DESTDIR for them should be deleted before updating.
579
58020110806:
581	i386 and amd64 have been changed to use GCC 4.5.3, so any
582	objdir or DESTDIR for them should be deleted before updating.
583
58420110805:
585	The update to GCC 4.5.3 requires a non-trivial portion of
586	the tree to be cleaned.  Best to delete both objdir and
587	DESTDIR before running this update.  So far, only the
588	sparc64, mips and powerpc platforms have changed.
589
59020110803:
591	The layout of external/public-domain/xz has changed.  To do an
592	update build you will have to remove the contents of the OBJDIR
593	for external/public-domain/xz/bin by hand as the xz entry there
594	is now a directory.
595
59620110410:
597	The configuration of src/tools/gcc has changed.  To do an
598	update build you have to clean both tools/binutils and
599	tools/gcc by hand.
600
60120110328:
602	Building the Xorg binary was moved into a subdirectory to fix
603	ordering issues with "make all".  It may be necessary to remove
604	the OBJDIR for external/mit/xorg/server/xorg-server/hw/xfree86
605	if your update build fails, as the "Xorg" entry there is now a
606	directory.
607
60820110121:
609	Assembler files no longer use -traditional-cpp.  This can break
610	the build of individual parts of the tree.  This is handled
611	correctly by build.sh.  Manual builds have to update /usr/share/mk
612	and re-run config(1) for any kernel configurations as needed.
613
61420101217:
615	The tcpdump(8) program was changed to drop privileges and chroot(2)
616	by default.  It may be necessary to manually update passwd(5) and
617	group(5) in order to make the program work with existing setups.
618
61920101125:
620	The latest changes to setenv(3) disallow setting environment
621	variables with names that contain '='.  Revision 1.18 of env.c
622	assumed that this was allowed.  Installing a new libc with an
623	old copy of /usr/bin/env causes env x=1 printenv | grep x= to
624	break which affects the autoconf tests for dependency finding,
625	so building gcc will end up printing:
626	    checking dependency style of gcc... none
627	    configure: error: no usable dependency style found
628	Fix it by rebuilding and re-installing env.
629
63020101119:
631	Recent Xorg updates in xsrc/external/mit/ may cause various build
632	or run-time problems.  Delete your entire DESTDIR and OBJDIR if you
633	have any build problems with xsrc, or problems with mismatched
634	versions between xorg-server and drivers.
635
63620100604:
637	The update of ATF to 0.9 causes old tests written in shell to fail
638	unless they are rebuilt.  If you are building with MKUPDATE=yes,
639	you need to clean the src/external/bsd/atf/tests/ and the src/tests/
640	trees by hand.
641
64220100522:
643	Recent Xorg updates in xsrc/external/mit/ will cause various build
644	problems.  Delete your entire DESTDIR and OBJDIR if you have any
645	build problems with xsrc.
646
64720100522:
648	private section of <ctype.h> was split, and now mklocale(1)
649	include ctype_local.h, so you have to make cleandir in tools/mklocale.
650
65120100520:
652	The location of the xkb compiled descriptions has changed.  Please
653	remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR.
654
65520100222:
656	The shared objects file extension has been changed from .so to
657	.pico, in order to avoid conflicts with shared libraries names
658	libXX.so.  All now stale regular .so files can be removed from
659	your object directories.
660
66120100204:
662	The termcap database has been removed from the sources,
663	but has not been marked obsolete so it is not removed
664	from the system when upgrading.
665	As such, you will need to remove them from your object
666	and destination directories.
667
66820091101:
669        After updating, it may be necessary to make the 'cleandir'
670        target in src/tools/yacc/ and in src/usr.bin/yacc/ before a
671        'build.sh -u tools' or 'build.sh -u distribution'.  Ditto
672        src/tools/lex/ and src/usr.bin/lex/.
673
67420091001:
675	On amd64 you must rebuild tools (to get the new binutils)
676	before building a kernel, or the build fails on cpufunc.S.
677
67820091001:
679	An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb
680	symlink, failing the build.  Delete the link, and the subdir
681	it is in, and retry your build.
682
68320090718:
684	libc build changed so that strchr() provides the extra entry
685	point for index().  Update build of libc.a (and libc_pic.a)
686	may fail because the archive contains the unwanted index.o.
687	(Similarly for strrchr() and rindex().)
688
68920090709:
690	Native Xorg was upgraded again.  Builds will probably fail again
691	without a clean objdir, at least for src/external/mit/xorg.
692
69320090616:
694	Native Xorg was upgraded.  Builds will need a clean objdir for
695	src/external/mit/xorg.  Upgrading a system from sets will not
696	work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc
697	subdirectory has been changed into a file, and this needs to
698	be manually "rm -r"'ed before installing xbase.tgz.
699
70020090501:
701	Several new functions were added to string.h/libc, and this
702	can cause autoconf problems during the tool build for people
703	who fail to clean out their tools objects properly.  If you
704	note messages about stpcpy, stpncpy or strnlen accompanying a
705	failure during the tool build, clean out all your tools
706	objects and start again.
707
70820090325:
709	The i386 port was switched to i486 default toolchain.  This requires
710	cleaning your src/tools directory and $TOOLDIR and rebuilding them.
711
71220090126:
713	The __posix_fadvise50 system call changed assembly stub type.  You
714	need to 'rm -f __posix_fadvise50.*' in the libc build directory
715	to avoid using the old assembly stub.
716
71720090202:
718	pkg_install now depends on the pkgdb cache for automatic conflict
719	detection.  It is recommended to rebuild the cache with
720	``pkg_admin rebuild''.
721
72220090110:
723	time_t and dev_t have been bumped to 64 bit quantities.  To upgrade:
724	1. Make sure your kernel has COMPAT_50 in it.  Build and install.
725	   This is needed even in the MODULAR kernel because there is
726	   conditionally compiled code in rtsock.c.
727	2. make sure build.sh completes and the binaries in a chroot work
728	   before installing.
729	3. If you don't use build.sh and you build directly to root, and
730	   your build breaks in the middle, don't despair.  Make sure headers
731	   are installed properly, and start building libraries first libc
732	   and libutil, install them and then continue building all the
733	   libraries in src/lib and src/gnu/lib and install them.  Once
734	   the new libraries are installed, you can restart the build.
735	4. If you compile packages and you notice link time warnings,
736	   rebuild the required packages to update their shared libraries.
737	   Any package you rebuild will require rebuilding all the packages
738	   that depend on it.
739	5. Next time you run pwd_mkdb with the new binary, the file
740	   will be upgraded and it will not be backwards compatible.
741	6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see
742	   lastlogx(5)) have been versioned, and there is a heuristic
743	   for utmp.  You are better off removing the old files after
744	   upgrading.  The automated clearing of /var/run during
745	   boot, and the automated rotating of files in /var/log by
746	   newsyslog(8), may mean that you do not have to remove the
747	   files manually.
748	7. The optional accounting file (/var/account/acct, see
749	   accton(8)) has not been versioned, and will need to be
750	   removed.  The automatic rotation of the accounting file by
751	   /etc/daily limits the bad consequences of failure to remove
752	   the file.
753	8. Application software that writes time_t to binary files on
754	   disk will break or need attention.  Most notably: if you are
755	   using PostgreSQL < 8.4, you need to dump your databases,
756	   rebuild PostgreSQL with the new time_t, then restore.
757
75820081219:
759	config(1) has been updated, and one of the files it creates -
760	swapnetbsd.o - has changed format.  You need to rebuild config
761	(done automatically by build.sh) and then you need to rerun
762	config on all kernel configuration files before rebuilding those
763	kernels.
764
76520081205:
766	If you build with MKX11=no, you should remove /etc/rc.d/xdm and
767	/etc/rc.d/xfs from DESTDIR because those files were moved to the xetc
768	set and will appear as extra files for MKX11=no update builds.
769
77020081122:
771	On i386, various kernel options(4) in GENERIC including
772	file systems have been disabled and moved into kernel modules.
773	Before trying a new GENERIC kernel, you have to prepare the
774	following files as well as a new GENERIC kernel:
775
776	- build and install kernel modules from src/sys/modules
777
778	- install the latest bootloader, which will load a module
779	  for the file system from which the kernel is loaded automatically
780
781	If you have to load your kernel from a file system which is not of
782	the same type as the root file system, you have to load the necessary
783	file system module manually on the boot prompt or in the boot.cfg file.
784
78520080827:
786	If you built and installed a libc from sources between
787	2008/08/20 and 2008/08/26 you got a broken strtouq(3)
788	which results in false errors reported by lint(1).
789	Since this breaks the libc build itself, manual help is
790	needed -- lint must be disabled temporarily, e.g.:
791	  $ (cd lib/libc && make MKLINT=no dependall install)
792
79320080813:
794	MKDEBUG build was broken because the .depend files did not know
795	about .go files.  You need to remove all .depend files and rebuild.
796
79720080802:
798	A regression in binary compatibility for pthread_mutex_t has
799	been fixed.  Unfortunately, the price is breaking compatibility
800	for -current.
801
802	Threaded programs (using libpthread) and C++ programs (using
803	libstdc++) compiled after 20070907 and before 20080802 need to
804	be recompiled.
805
806	One way to find affected pkgsrc packages:
807
808	  $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO
809	  $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO
810
81120080731:
812	WAPBL (metadata journaling support) has been added, but at this
813	time isn't backwards compatible with pre-WAPBL aware kernels
814	and userland (fsck_ffs in particular).  Please make sure you
815	don't use a journaled filesystem with an older kernel/userland,
816	especially an uncleanly mounted journaled filesystem.  WAPBL
817	also requires the super block to be in the UFS2 format.  You
818	can use fsck_ffs -c 4 to update the superblock format.
819
82020080721:
821	Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR
822	isn't defined.
823
82420080531:
825	The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed
826	from 125 (conflicted with DRVCTLCOMMAND) to 129.  The drvctl(8)
827	utility needs to be rebuilt and reinstalled as older binaries
828	won't work correctly.  The following sequence of commands:
829
830	  $ (cd sys/sys/ && nbmake-$arch includes)
831	  $ (cd sbin/drvctl/ && nbmake-$arch clean)
832	  $ (cd sbin/drvctl/ && nbmake-$arch all)
833
834	leaves new drvctl utility in sbin/drvctl build directory.
835
83620080503:
837	The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE.
838
83920080521:
840	For a while, unprivileged UPDATE builds would fail to
841	succeed at the checkflist stage, complaining that
842	${DESTDIR}/stand/<arch>/ did not exist.  A fix for this
843	problem was committed to share/mk/bsd.kmodule.mk, revision 1.9.
844	If you already hit this problem, update the .mk file,
845	remove ${DESTDIR}/stand/<arch>, and re-run the build.
846
84720080303:
848	Linker warnings are now fatal if $WARNS>0.
849
85020080126:
851	The posix_fadvise system call has been changed from an assembly
852	stub, to a c file that calls an assembly stub.  You need to
853	'rm -f posix_fadvise.* .depend' in the libc build directory to
854	avoid using the old assembly stub.
855
85620071209:
857	The acpiec(4) driver has been split into two attachments.  If you
858	get ACPI errors before the attachment, please update your kernel
859	configuration file appropriately or see GENERIC for more details.
860
86120071115:
862	The it(4) driver has been renamed to itesio(4) and the old port
863	argument specified in the kernel configuration file is not valid
864	anymore.  The itesio(4) driver now uses the Super I/O address port
865	rather than the EC address port.  Please update your kernel
866	configuration file appropriately or see GENERIC for more details.
867
86820071028:
869	The pccons(4) driver has been removed from the NetBSD/shark port.
870	You need to update any custom kernel configuration file you have
871	to remove any references to pccons (which includes removing the
872	now useless XSERVER option) and replace them with the correct
873	entries for the wscons driver.  See the GENERIC configuration file
874	for more details.
875
87620070913:
877	A latent bug in dhclient/dhcpd that caused it to be unable to
878	enumerate interfaces was fixed.  The bug began to cause
879	problems after 20070911 when the kernel's SIOCGIFCONF
880	implementation was repaired.  From 20070529 to 20070911 racoon
881	could not enumerate interfaces.  (These are noted because
882	normal kernel/userspace version matching hygiene is not
883	sufficient to avoid this problem.)  Ensure that both kernel
884	and userland are from after 20070913.
885
88620070703:
887	nbinstall has been renamed ${MACHINE_GNU_ARCH}-install.  It
888	calls the target-specific strip program, and the logic to pass
889	down STRIP from make has been removed.  This requires a
890	re-installation of tools.
891
89220070422:
893	The way OS emulations lookup filenames inside the emulation root
894	has been changed.  Rather than modify the pathname (and copy back
895	to userspace) namei() and lookup() directly check the emulation
896	root.  One side effect is that absolute symlinks inside the emulated
897	root file system will be relative to that file system - unless they
898	start /../ this is useful when the emulated root is a real install
899	that has such links.
900	This might affect symlinks that have been added to reference outside
901	the emulated root.
902
90320070412:
904	The pckbc driver on sgimips IP32 has been removed.  Use macekbc
905	instead.  See the GENERIC32_IP3x kernel configuration for an
906	example.
907
90820070319:
909        src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so
910        on many platforms due to incorrect flags settings.  If you
911        updated and built after about 20070315, do "nbmake-$arch
912	cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a
913	rebuild of object files that might have been built
914	incorrectly, and ensure that you have at least
915	src/lib/libc/Makefile 1.130.
916
91720070210:
918        src/sys/sys/{sa.h,savar.h} were removed.
919          find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \
920              | xargs egrep -l '/sa.h|/savar.h' | xargs rm
921        will allow dependencies on those files to get get rebuilt
922
92320070209:
924        The threading model was changed when the newlock2 branch
925        was merged to NetBSD-current.  If you boot with a new
926        kernel (version 4.99.10), then you also need a new pthread
927        library (/usr/lib/libpthread.so.0.7).  If you boot with
928        an old kernel, then you need the old pthread library
929        (/usr/lib/libpthread.so.0.6).  Provided you keep the kernel and
930        the pthread library in sync, old threaded applications should
931        continue to work with an old or new kernel.  Note that named(8)
932	is the only threaded application in the base system.
933
93420061214:
935	Following the move of string_to_flags() and flags_to_string()
936	from the bin/ls/ sources to libutil, users doing UPDATE builds
937	will need to do a "make cleandir" in
938		tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/,
939		bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/,
940		usr.bin/xinstall/, libexec/ftpd/, rescue/, as well
941		as the installation images in distrib/
942	in order to excise stale references to the old stat_flags.h header
943	file in the ls sources -- stat_flags.h has been removed.
944
94520061108:
946	The configure script used in the src/tools/gcc compiler has been
947	changed to indicate that our libc has ssp support built-in and
948	does not depend on -lssp and -lssp-nonshared.  You'll need to
949	make clean in src/tools/gcc first to rebuild the compiler.
950
95120061009:
952	The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer
953	available.  Use net.inet{,6}.tcp{,6}.congctl.selected instead.
954
95520060814:
956	The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been
957	withdrawn.  Use vidcvideo and pckbd instead.  See the GENERIC
958	kernel configuration for an example.  X servers from the last
959	few years should cope.
960
96120060703:
962	MPACPI is no more.  We always configure PCI interrupts using ACPI
963	if we have an ACPI kernel.  The option MPACPI_SCANPCI has been renamed
964	to ACPI_SCANPCI.  Thanks to work from fvdl.
965
96620060627:
967	socket(2) has changed, and its system call has been versioned.
968	For userlands with the old version of socket(2), make sure that
969	your kernel has 'options COMPAT_30' set, or else 'bad system call'
970	errors will result.
971
972Hints for a more successful build:
973^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
974    Use build.sh, but do not use its "expert mode":
975	This will automatically build the tools in the
976	   correct order, and it will keep the tools and the
977	   new build products from interfering with the running
978	   system.  This will allow you to ignore most of the
979	   other advice in this file.
980    Build a new kernel first:
981	This makes sure that any new system calls or features
982	   expected by the new userland will be present.  This
983	   helps to avoid critical errors when upgrading.
984    Use object directories:
985	This helps to keep stale object
986	   files from polluting the build if a Makefile "forgets"
987	   about one.  It also makes it easier to clean up after
988	   a build.  It's also necessary if you want to use the
989	   same source tree for multiple machines.
990	   To use object directories with build.sh:
991	    a) invoke build.sh with the "-M" or "-O" options.
992	   To use object directories without using build.sh:
993	    a) cd /usr/src ; make cleandir
994	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
995	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
996	    d) cd /usr/src ; make build
997	   Note that running "make obj" in a directory will create
998	   in obj.$MACHINE directory.
999    Build to a DESTDIR:
1000	This helps to keep old installed files (especially libraries)
1001	   from interfering with the new build.
1002	   To build to a DESTDIR with build.sh, use the "-D" option.
1003	   To build to a DESTDIR without using build.sh, set the DESTDIR
1004	   environment variable before running make build.  It should be
1005	   set to the pathname of an initially empty directory.
1006	   Problems: if you do not use build.sh, you might need to
1007		update critical utilities without using DESTDIR since
1008		nothing is executed from what is installed in DESTDIR.
1009		(See critical utils, below.)
1010    Build often:
1011	This keeps critical utilities current enough to not choke
1012	on any other part of the source tree that depends on up to
1013	date functionality.  If you use build.sh, you should not have
1014	this problem.
1015
1016What to do if things don't work:
1017^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1018When things don't work there are usually a few things that commonly
1019should be done.
1020    1)	make includes
1021	This should be done automatically by make build.
1022    2)  cd share/mk && make install
1023	Again, automatically done by make build.
1024
1025Failsafe rebuild of a small part of the tree:
1026^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1027To make sure you rebuild something correctly you want to do
1028something like the following:
1029    1)  Make sure the includes and .mk files are up to date.
1030    2)  Make sure any program used to build the particular
1031	utility is up to date.  (yacc, lex, etc...)
1032    3)  cd ...path/to/util...
1033	make cleandir
1034	rm ...all obj directories...
1035	make cleandir			# yes, again
1036	make obj
1037	make depend && make
1038
1039Failsafe rebuild of the entire tree:
1040^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1041If you really want to make sure the source tree is clean and
1042ready for a build try the following.  Note that sourcing /etc/mk.conf
1043(a make(1) Makefile) in this manner is not right, and will not work
1044for anyone who uses any make(1) features in /etc/mk.conf.
1045
1046---cut here---
1047#!/bin/sh
1048. /etc/mk.conf
1049
1050if [ -z $NETBSDSRCDIR ] ; then
1051    NETBSDSRCDIR=/usr/src
1052fi
1053if [ \! -d $NETBSDSRCDIR ] ; then
1054    echo Unable to find sources
1055    exit 1
1056fi
1057find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
1058
1059if [ -z $BSDOBJDIR ] ; then
1060    BSDOBJDIR=/usr/obj
1061fi
1062if [ -d $BSDOBJDIR ] ; then
1063    rm -rf $BSDOBJDIR
1064fi
1065
1066cd $NETBSDSRCDIR && make cleandir
1067
1068---cut here---
1069
1070Critical utilities:
1071^^^^^^^^^^^^^^^^^^^
1072	usr.bin/compile_et
1073	usr.bin/make
1074	usr.bin/yacc
1075	usr.bin/lex
1076	usr.bin/xlint
1077	usr.bin/config
1078
1079Other problems and possible solutions:
1080^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
1081Symptom:Complaints involving a Makefile.
1082Fix:	Rebuild usr.bin/make:
1083	cd usr.bin/make && make && make install
1084	Or, a failsafe method if that doesn't work:
1085	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
1086
1087Fix:	Make sure .mk files are up to date.
1088	cd share/mk && make install
1089
1090Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
1091Fix:	Rebuild usr.bin/config
1092
1093Symptom:
1094Fix:	Rebuild usr.bin/yacc
1095
1096Symptom:
1097Fix:	Rebuild usr.bin/lex
1098
1099Symptom:
1100Fix:	rm /usr/lib/libbfd.a
1101
1102Symptom:Obsolete intermediate files are used during compilation
1103Fix:	Try the following sequence of commands in the directory in question.
1104	make cleandir; rm `make print-objdir`; make cleandir; make obj
1105	(If you built the tree without "make obj" in the past, obsolete files
1106	may remain.  The command tries to clean everything up)
1107
1108Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
1109	pointer type
1110Fix:	Rebuild and install usr.bin/menuc
1111
1112Symptom:mklocale not found during build in share/locale/ctype
1113Fix:	Build and install usr.bin/mklocale
1114
1115Symptom:undefined reference to `__assert13' or `__unsetenv13'
1116Fix:    Rebuild and install lib/libc
1117
1118Symptom:usr.bin/config fails to build.
1119Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
1120
1121Symptom:undefined reference to `getprogname' or `setprogname'
1122Fix:    Rebuild and install lib/libc
1123
1124Symptom:lint does not understand the '-X' option
1125Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
1126
1127Symptom:Update build fails in src/tools/gcc complaining that a variable
1128	(e.g. CPPFLAGS) has changed since the previous run.
1129Fix:    Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build.
1130
1131Symptom:cvs [update aborted]: cannot open directory /cvsroot/src/...:
1132	No such file or directory.
1133Cause:	If a directory is created by mistake, then it is sometimes
1134	deleted from the CVS repository using administrative commands
1135	that bypass the normal cvs access controls.  If your cvs working tree
1136	contains references to a directory that has been deleted on the
1137	server in this way, then "cvs update" reports this error.
1138Fix:	Recursively delete the affected directory from your working tree
1139	and try the update again.
1140