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