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