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