UPDATING revision 1.307
1$NetBSD: UPDATING,v 1.307 2020/03/11 21:07:40 mrg Exp $
2
3This file (UPDATING) is intended to be a brief reference to recent
4changes that might cause problems in the build process, and a guide for
5what to do if something doesn't work.
6
7For a more detailed description of the recommended way to build NetBSD
8using build.sh, see the BUILDING file.
9
10Note that much of the advice in this UPDATING file was written before
11build.sh existed.  Nevertheless, the advice here may be useful for
12working around specific problems with build.sh.
13
14Sections are marked with "^^^^^".  After the section on "Recent changes"
15are several sections containing more general information.
16
17See also: BUILDING, build.sh, Makefile.
18
19Recent changes:
20^^^^^^^^^^^^^^^
21
2220200311:
23	GCC 8 ports will need cleaning in src/tools/gcc and
24	src/external/gpl3/gcc due to GCC 8.4 update.
25
2620191118:
27	More architectures were switched to gcc8:
28	    i386, ia64 powerpc64, sparc, sparc64, arm
29	The same comments as in 20191022 apply.
30
3120191112:
32	The LLVM update requires a clean rebuild for all architectures using
33	LLVM during the tools build phase (i386, amd64, aarch64).
34
3520191022:
36	Ports amd64 and aarch64 switched to GCC 8.3 by default.
37	In-place ("expert mode", build.sh -E) builds are not supported
38	when going from a GCC 7 userland to GCC 8. Do a regular
39	build to a different DESTDIR (or preferably: build.sh -U) at least
40	once and install sets, or download comp.{tar.xz,tgz} from the
41	daily builds and install that before doing the next in-place build.
42
4320191001:
44	GCC 8.3 was imported.  Builds of src/tools/gcc may fail if
45	old builds with GCC 7 output now uses GCC 8.  Clean this
46	directory, and also clean src/external/gpl3/gcc.
47
4820190903:
49	Files with names that coincide with existing files' names on
50	case-insensitive file systems were inadvertently committed, for
51	radeon GPU firmware.  We cannot mark these as obsolete for
52	postinstall to fix, so if you updated src since 2019-08-26, and
53	ran build.sh distribution or ran build.sh release, you must
54	manually delete the following files in your DESTDIR (which is
55	usually $OBJDIR/destir.$ARCH), or from / if you have installed
56	them:
57
58		/libdata/firmware/radeon/bonaire_ce.bin
59		/libdata/firmware/radeon/bonaire_mc.bin
60		/libdata/firmware/radeon/bonaire_me.bin
61		/libdata/firmware/radeon/bonaire_mec.bin
62		/libdata/firmware/radeon/bonaire_pfp.bin
63		/libdata/firmware/radeon/bonaire_rlc.bin
64		/libdata/firmware/radeon/bonaire_sdma.bin
65		/libdata/firmware/radeon/bonaire_smc.bin
66		/libdata/firmware/radeon/bonaire_uvd.bin
67		/libdata/firmware/radeon/hainan_ce.bin
68		/libdata/firmware/radeon/hainan_mc.bin
69		/libdata/firmware/radeon/hainan_me.bin
70		/libdata/firmware/radeon/hainan_pfp.bin
71		/libdata/firmware/radeon/hainan_rlc.bin
72		/libdata/firmware/radeon/hainan_smc.bin
73		/libdata/firmware/radeon/hawaii_ce.bin
74		/libdata/firmware/radeon/hawaii_mc.bin
75		/libdata/firmware/radeon/hawaii_me.bin
76		/libdata/firmware/radeon/hawaii_mec.bin
77		/libdata/firmware/radeon/hawaii_pfp.bin
78		/libdata/firmware/radeon/hawaii_rlc.bin
79		/libdata/firmware/radeon/hawaii_sdma.bin
80		/libdata/firmware/radeon/hawaii_smc.bin
81		/libdata/firmware/radeon/kabini_ce.bin
82		/libdata/firmware/radeon/kabini_me.bin
83		/libdata/firmware/radeon/kabini_mec.bin
84		/libdata/firmware/radeon/kabini_pfp.bin
85		/libdata/firmware/radeon/kabini_rlc.bin
86		/libdata/firmware/radeon/kabini_sdma.bin
87		/libdata/firmware/radeon/kaveri_ce.bin
88		/libdata/firmware/radeon/kaveri_me.bin
89		/libdata/firmware/radeon/kaveri_mec.bin
90		/libdata/firmware/radeon/kaveri_mec2.bin
91		/libdata/firmware/radeon/kaveri_pfp.bin
92		/libdata/firmware/radeon/kaveri_rlc.bin
93		/libdata/firmware/radeon/kaveri_sdma.bin
94		/libdata/firmware/radeon/mullins_ce.bin
95		/libdata/firmware/radeon/mullins_me.bin
96		/libdata/firmware/radeon/mullins_mec.bin
97		/libdata/firmware/radeon/mullins_pfp.bin
98		/libdata/firmware/radeon/mullins_rlc.bin
99		/libdata/firmware/radeon/mullins_sdma.bin
100		/libdata/firmware/radeon/oland_ce.bin
101		/libdata/firmware/radeon/oland_mc.bin
102		/libdata/firmware/radeon/oland_me.bin
103		/libdata/firmware/radeon/oland_pfp.bin
104		/libdata/firmware/radeon/oland_rlc.bin
105		/libdata/firmware/radeon/oland_smc.bin
106		/libdata/firmware/radeon/pitcairn_ce.bin
107		/libdata/firmware/radeon/pitcairn_mc.bin
108		/libdata/firmware/radeon/pitcairn_me.bin
109		/libdata/firmware/radeon/pitcairn_pfp.bin
110		/libdata/firmware/radeon/pitcairn_rlc.bin
111		/libdata/firmware/radeon/pitcairn_smc.bin
112		/libdata/firmware/radeon/tahiti_ce.bin
113		/libdata/firmware/radeon/tahiti_mc.bin
114		/libdata/firmware/radeon/tahiti_me.bin
115		/libdata/firmware/radeon/tahiti_pfp.bin
116		/libdata/firmware/radeon/tahiti_rlc.bin
117		/libdata/firmware/radeon/tahiti_smc.bin
118		/libdata/firmware/radeon/verde_ce.bin
119		/libdata/firmware/radeon/verde_mc.bin
120		/libdata/firmware/radeon/verde_me.bin
121		/libdata/firmware/radeon/verde_pfp.bin
122		/libdata/firmware/radeon/verde_rlc.bin
123		/libdata/firmware/radeon/verde_smc.bin
124
125	We will re-import these radeon firmware images another way
126	later.
127
12820190727:
129	The uefi bootloader has gained tftp support and needs a clean
130	build. If you do update builds, manually clean its object
131	directory by something like:
132	cd sys/arch/i386/stand/efiboot && make clean
133
13420190723:
135	The jemalloc allocator in libc is now build without extended
136	debugging (for performance reasons). In update builds make sure
137	to rebuild it completly, by removing all affected object files,
138	including compat builds, something like:
139	cd /usr/obj && find . -type d -name jemalloc|xargs rm -rf
140
14120190207:
142	GCC 7 switched for many ports.  Update builds are likely to fail.
143
14420180924:
145	A newer OpenSSL version has been imported. If you are doing
146	update builds, make sure to remove all old obj dirs, like:
147	cd /usr/obj && find . -type d -name openssl | xargs rm -rf
148
14920180717:
150	On aarch64 int64_t and related types have changed from long long
151	to long. This requires recompiling all C++ binaries.
152
15320180713:
154	On amd64 and i386 static binaries are now build position
155	independend. This requires recompilation of all object
156	files used to create the crunched /rescue binary.
157	Clean the rescue directory in your obj directory before
158	doing an update build, otherwise linking will fail.
159
16020180414:
161	Existing binutils was migrated to binutils.old.  Manual
162	removal of tools/binutils objects directory may be required
163	to fix tools build failure.
164
16520180311:
166	bdftopcf was updated and may need cleaning in the
167	src/external/mit/xorg/tools/bdftopcf subdirectory if there are
168	link errors.
169
17020180212:
171	between OpenSSL and GCC updates, many things may fail to build.
172	any failure that looks like GCC or openssl is best handled by
173	a clean destdir and objdir.  Full cleandir and destdir deletion
174	is recommended if build failures occur.
175
17620171225:
177	removal of the vadvise syscall requires manual removal of all
178	associated files from the libc build object directory (including
179	the .depend files) - a command like:
180		cd $OBJ && find . -type d -name libc | xargs rm -rf
181	For architectures that support multiple "compat" binary targets,
182	you'll need to cleanup both the regular libc directory and the
183	compat ones (the above command will do that).
184
18520171010:
186	a change to the build structure of external/bsd/acpica/bin/iasl
187	means that its objdir (or *.d and .depend at least) might need
188	to be manually removed - or a build done once without -u.
189
19020170822:
191	a new version of GMP has been imported and probably
192	will break parts of builds related to themselves or GCC, both
193	in the tools and the native section.  Remove all GCC, GMP, MPFR
194	and MPC objdirs or build once without -u.
195
19620170816:
197	a new version of MPFR and MPC have been imported and probably
198	will break parts of builds related to themselves or GCC, both
199	in the tools and the native section.  Remove all GCC, GMP, MPFR
200	and MPC objdirs or build once without -u.
201
20220170402:
203	a new version of dhcpcd has been imported, which does not support
204	update builds from the previous version. Remove your
205	external/bsd/dhcpcd object dir or build once without -u.
206
20720170211:
208	a new terminfo database has been imported.
209	The structure of it has changed slightly from prior versions and
210	an updated tic tool is required.
211	If you build.sh, don't use -u
212
21320170207:
214	various arch dependent libc/exect.S files were removed
215	Either remove the obj directories (lib/libc and compat/amd64/i386/lib
216	if it exists) or do a clean build.
217	(This is a bug in the make system, it should be corrected without
218	human intervention, but isn't.)
219
22020170104:
221	xinput build options have changed.
222	Remove the obj directory (external/mit/xorg/bin/xinput)
223	if you build.sh -u
224
22520170103:
226	a new version of flex has been imported.
227	Remove the file from obj (external/bsd/flex)
228	if you build.sh -u
229
23020161014:
231	a new version of OpenSSL has been imported.
232	Remove the files from obj (crypto/external/bsd/openssl) 
233	if you build.sh -u
234
23520161009:
236	a new version of dhcpcd has been imported with slightly changed
237	build infrastructure. When doing a build.sh -u this requires
238	pruning the external/bsd/dhcpcd objdir.
239
24020160914:
241	i386, amd64, shark, ofppc and macppc have joined shark and x68k
242	ports in using xorg-server 1.18. This requires a clean destdir
243	and a clean objdir.
244
24520160527:
246	i386 needs a full cleandir or objdir deletion because PIE has
247	been enabled. (see the amd64 entry two down for further info)
248
24920160418:
250	libedit needs manual removal of all autogenerated files since
251	some of them are not autogenerated anymore. Remember that there
252	might be two copies of libedit if your platform builds "compat".
253
25420160410:
255	amd64 needs full "make cleandir" or deletion of objdir now that
256	PIE has been enabled for amd64.  PIE, or position-independent
257	executables, means all code, including executables and not just
258	shared libraries, is position-independent and hence able to be
259	relocated by ASLR, address space layout randomization.
260
261	The change was made in Makefile variables for compiler and
262	linker flags, for which make(1) does not record dependencies,
263	hence it is unable to detect that all .o files need rebuilding.
264
265	Partial rebuilds with some modified source files will likely
266	fail when linking executables, since the linker refuses to mix
267	position-independent code with position-dependent code in
268	position-independent executables:
269
270		.../x86_64--netbsd/bin/ld: foo.o: relocation R_X86_64_32 against `...' cannot be used when making a shared object; recompile with -fPIC
271
27220160401:
273	Ports switching to GCC 5.3 will need a full "make cleandir".
274	Some people have found that cleandir is not sufficient, so if
275	in doubt delete the entire object directory tree for gcc.
276
27720160306:
278	NetBSD's regexp implementation is now part of libnbcompat.
279	Nblex, nbm4, nbpax, nbsed use it and they may crash on
280	non-NetBSD hosts if linked with stale object files produced
281	while they included a non-NetBSD regex.h.
282	In any case, you should "make cleandir" at least these tools
283	before updating your toolchain.
284
28520160125:
286	Dtrace has been enabled by default on some architectures.
287	When doing an update build, make sure to clean the etc/mtree
288	object directory before starting the build - otherwise the
289	needed directories in destdir will not be created.
290	An easy way to do this is:
291	   cd src/etc/mtree && $TOOLDIR/bin/nbmake-$arch cleandir
292
29320150818:
294	New acpica requires "make cleandir" in src/external/bsd/acpica
295	again.
296
29720150413:
298	New acpica requires "make cleandir" and reinstalling yacc
299	in /usr/src/external/bsd/byacc and /usr/src/tools/yacc and
300	also "make cleandir" in /usr/src/external/bsd/acpica.
301
30220150404:
303	Lint changes require a full rebuild of the tool, so make
304	sure to build without -u option to build.sh, or manually
305	do a make cleandir in src/tools/lint1 and
306	src/usr.bin/xlint.
307
30820150310:
309	Improvements to openssl for arm mean that update builds of
310	the openssl libraries will fail. A make cleandir in
311	external/bsd/openssl/lib is needed
312
31320141026:
314	A mishap during the import of pppd may cause your corruption
315	in your cvs directory if you happened to do a cvs update
316	during a short period of time. To fix, just remove the
317	directory src/external/bsd/ppp/dist/pppd completely
318	and let cvs restore it on next update.
319
32020140721:
321	The src/external/mit/lua/src directory was accidentally created
322	and then deleted in the CVS repository.  If you get errors like
323
324	cvs [update aborted]: cannot open directory
325	/cvsroot/src/external/mit/lua/src: No such file or directory
326
327	then delete your local copy of that directory tree and try again.
328
32920140530:
330	ARM eABI switched to DWARF based exception handling. This requires
331	rebuilding all C++ code. It is strongly advised to do a clean build.
332
33320140131:
334	The new compiler_rt/libc integration moved a few things. It is strongly
335	advised to do a clean build. At least lib/libc, the compat version(s)
336	of libc, libkern, rump and the kernels need to be cleaned.
337
33820131227:
339	1. The new ntpd runs in a restricted mode to prevent amplification
340	   attacks. If you need ntpdc to work you need to explicitly enable
341	   mode7 in your config file. Make sure you put the necessary restrict
342	   statements to avoid being exposed.
343	2. strncat has moved from lib/libc to common/lib/libc; you might need
344	   to make clean in libc
345
34620131129:
347	The GMP sources were updated, and builds will likely fail without
348	cleaning their build trees for both tools and in-tree, like below.
349
35020131128:
351	The MPC and MPFR sources were updated, and builds may require their
352	tools and in-tree directories cleaned for successful updates.
353
35420130605:
355	The kernel option FAST_IPSEC no longer exists, it's been renamed
356	to IPSEC (and the older IPSEC version removed).
357
35820130605:
359	Previous freetype installations eroneously installed private
360	header files. If you are building against a non-empty $DESTDIR,
361	please remove ${DESTDIR}//usr/X11R7/include/freetype2/freetype/.
362
36320130531:
364	The xdm update may cause build failure due to xdm.man being
365	in the obj tree.  Make sure to ensure any like this:
366		nbmake: nbmake: don't know how to make xdm.man. Stop
367	is fixed by deleting the xdm.man in the obj tree.
368
36920130530:
370	Updates of many xsrc packages will leave old .pc files around.
371	Best to clean out the xsrc objdir entirely before rebuilds.
372
37320130301:
374	The removal of netiso requires manual removal of /usr/include/netiso
375	prior to the build and make cleandir in /usr/src/usr.bin/{ktruss,kdump}
376
37720120726:
378	The update of OpenSSL requires cleaning both the OpenSSL build
379	directory and DESTDIR.  *Even non-update builds require cleaning
380	DESTDIR.* Builds done without taking these steps may fail, or in
381	some cases may succeed and install broken OpenSSL libraries that
382	cause third-party software to link incorrectly and/or crash.
383
38420120507:
385	The database schema for makemandb was changed.  You will
386	need to update the database using 'makemandb -f' or wait
387	for the next weekly run to fix it.
388
38920120319:
390	sys/conf/Makefile.kern.inc has been modified to adjust the
391	size of db_symtab automatically.  You need to update dbsym in
392	your $TOOLDIR to build kernels with options SYMTAB_SPACE.  If
393	you don't want this behavior, add AUTO_SYMTAB_SPACE=no to your
394	mk.conf.
395
39620120216:
397	Default for MKCATPAGES changed to NO.  Update builds will fail
398	unless DESTDIR is cleaned manually.  If you built between 20120207
399	and 20120216, daily and weekly could have created an unreadable
400	/var/db/man.db index for apropos.  Running makemandb -f or
401	the next run of weekly will fix it.
402
40320111227:
404	If you built between 20111225 and 20111227 you need to remove
405	/usr/lib/libpam.so.4* and /usr/lib/security/*.so.4, since the
406	bump has been reverted.
407
40820111125:
409	The "rnd" pseudodevice has been added to sys/conf/std, which
410	means it should no longer be explicitly listed in kernel
411	configuration files.  The line "pseudo-device rnd" should be
412	removed from any custom kernel config files users may have.
413
41420111119:
415	A problem with the datastructures used by the rndctl(8)
416	utility (pointers in datastructures in an array, making 32->64
417	bit compatibility very painful) has been fixed in a
418	non-backwards-compatible way.  If you replace your kernel,
419	replace your rndctl executable too.
420
42120111001:
422	the prop_*_send_syscall() functions from proplib(3) have been
423	changed and their new version is not backward compatible with the old
424	one.  So ensure that all consumers of these functions (currently:
425	quota2 code and its tests) are updated together with the new lib.
426
42720110817:
428	sparc has been changed to use GCC 4.5.3, so any objdir or
429	DESTDIR for them should be deleted before updating.
430
43120110806:
432	i386 and amd64 have been changed to use GCC 4.5.3, so any
433	objdir or DESTDIR for them should be deleted before updating.
434
43520110805:
436	The update to GCC 4.5.3 requires a non-trivial portion of
437	the tree to be cleaned.  Best to delete both objdir and
438	DESTDIR before running this update.  So far, only the
439	sparc64, mips and powerpc platforms have changed.
440
44120110803:
442	The layout of external/public-domain/xz has changed.  To do an
443	update build you will have to remove the contents of the OBJDIR
444	for external/public-domain/xz/bin by hand as the xz entry there
445	is now a directory.
446
44720110410:
448	The configuration of src/tools/gcc has changed.  To do an
449	update build you have to clean both tools/binutils and
450	tools/gcc by hand.
451
45220110328:
453	Building the Xorg binary was moved into a subdirectory to fix
454	ordering issues with "make all".  It may be necessary to remove
455	the OBJDIR for external/mit/xorg/server/xorg-server/hw/xfree86
456	if your update build fails, as the "Xorg" entry there is now a
457	directory.
458
45920110121:
460	Assembler files no longer use -traditional-cpp.  This can break
461	the build of individual parts of the tree.  This is handled
462	correctly by build.sh.  Manual builds have to update /usr/share/mk
463	and re-run config(1) for any kernel configurations as needed.
464
46520101217:
466	The tcpdump(8) program was changed to drop privileges and chroot(2)
467	by default.  It may be necessary to manually update passwd(5) and
468	group(5) in order to make the program work with existing setups.
469
47020101125:
471	The latest changes to setenv(3) dissallow setting environment
472	variables with names that contain '='.  Revision 1.18 of env.c
473	assumed that this was allowed.  Installing a new libc with an
474	old copy of /usr/bin/env causes env x=1 printenv | grep x= to
475	break which affects the autoconf tests for dependency finding,
476	so building gcc will end up printing:
477	    checking dependency style of gcc... none
478	    configure: error: no usable dependency style found
479	Fix it by rebuilding and re-installing env.
480
48120101119:
482	Recent Xorg updates in xsrc/external/mit/ may cause various build
483	or run-time problems.  Delete your entire DESTDIR and OBJDIR if you
484	have any build problems with xsrc, or problems with mismatched
485	versions between xorg-server and drivers.
486
48720100604:
488	The update of ATF to 0.9 causes old tests written in shell to fail
489	unless they are rebuilt.  If you are building with MKUPDATE=yes,
490	you need to clean the src/external/bsd/atf/tests/ and the src/tests/
491	trees by hand.
492
49320100522:
494	Recent Xorg updates in xsrc/external/mit/ will cause various build
495	problems.  Delete your entire DESTDIR and OBJDIR if you have any
496	build problems with xsrc.
497
49820100522:
499	private section of <ctype.h> was splitted, and now mklocale(1)
500	include ctype_local.h, so you have to make cleandir in tools/mklocale.
501
50220100520:
503	The location of the xkb compiled descriptions has changed.  Please
504	remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR.
505
50620100222:
507	The shared objects file extension has been changed from .so to
508	.pico, in order to avoid conflicts with shared libraries names
509	libXX.so.  All now stale regular .so files can be removed from
510	your object directories.
511
51220100204:
513	The termcap database has been removed from the sources,
514	but has not been marked obsolete so it is not removed
515	from the system when upgrading.
516	As such, you will need to remove them from your object
517	and destination directories.
518
51920091101:
520        After updating, it may be necessary to make the 'cleandir'
521        target in src/tools/yacc/ and in src/usr.bin/yacc/ before a
522        'build.sh -u tools' or 'build.sh -u distribution'.  Ditto
523        src/tools/lex/ and src/usr.bin/lex/.
524
52520091001:
526	On amd64 you must rebuild tools (to get the new binutils)
527	before building a kernel, or the build fails on cpufunc.S.
528
52920091001:
530	An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb
531	symlink, failing the build.  Delete the link, and the subdir
532	it is in, and retry your build.
533
53420090718:
535	libc build changed so that strchr() provides the extra entry
536	point for index().  Update build of libc.a (and libc_pic.a)
537	may fail because the archive contains the unwanted index.o.
538	(Similarly for strrchr() and rindex().)
539
54020090709:
541	Native Xorg was upgraded again.  Builds will probably fail again
542	without a clean objdir, at least for src/external/mit/xorg.
543
54420090616:
545	Native Xorg was upgraded.  Builds will need a clean objdir for
546	src/external/mit/xorg.  Upgrading a system from sets will not
547	work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc
548	subdirectory has been changed into a file, and this needs to
549	be manually "rm -r"'ed before installing xbase.tgz.
550
55120090501:
552	Several new functions were added to string.h/libc, and this
553	can cause autoconf problems during the tool build for people
554	who fail to clean out their tools objects properly.  If you
555	note messages about stpcpy, stpncpy or strnlen accompanying a
556	failure during the tool build, clean out all your tools
557	objects and start again.
558
55920090325:
560	The i386 port was switched to i486 default toolchain.  This requires
561	cleaning your src/tools directory and $TOOLDIR and rebuilding them.
562
56320090126:
564	The __posix_fadvise50 system call changed assembly stub type.  You
565	need to 'rm -f __posix_fadvise50.*' in the libc build directory
566	to avoid using the old assembly stub.
567
56820090202:
569	pkg_install now depends on the pkgdb cache for automatic conflict
570	detection.  It is recommented to rebuild the cache with
571	``pkg_admin rebuild''.
572
57320090110:
574	time_t and dev_t have been bumped to 64 bit quantities.  To upgrade:
575	1. Make sure your kernel has COMPAT_50 in it.  Build and install.
576	   This is needed even in the MODULAR kernel because there is
577	   conditionally compiled code in rtsock.c.
578	2. make sure build.sh completes and the binaries in a chroot work
579	   before installing.
580	3. If you don't use build.sh and you build directly to root, and
581	   your build breaks in the middle, don't despair.  Make sure headers
582	   are installed properly, and start building libraries first libc
583	   and libutil, install them and then continue building all the
584	   libraries in src/lib and src/gnu/lib and install them.  Once
585	   the new libraries are installed, you can restart the build.
586	4. If you compile packages and you notice link time warnings,
587	   rebuild the required packages to update their shared libraries.
588	   Any package you rebuild will require rebuilding all the packages
589	   that depend on it.
590	5. Next time you run pwd_mkdb with the new binary, the file
591	   will be upgraded and it will not be backwards compatible.
592	6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see
593	   lastlogx(5)) have been versioned, and there is a heuristic
594	   for utmp.  You are better off removing the old files after
595	   upgrading.  The automated clearing of /var/run during
596	   boot, and the automated rotating of files in /var/log by
597	   newsyslog(8), may mean that you do not have to remove the
598	   files manually.
599	7. The optional accounting file (/var/account/acct, see
600	   accton(8)) has not been versioned, and will need to be
601	   removed.  The automatic rotation of the accounting file by
602	   /etc/daily limits the bad consequences of failure to remove
603	   the file.
604	8. Application software that writes time_t to binary files on
605	   disk will break or need attention.  Most notably: if you are
606	   using PostgreSQL < 8.4, you need to dump your databases,
607	   rebuild PostgreSQL with the new time_t, then restore.
608
60920081219:
610	config(1) has been updated, and one of the files it creates -
611	swapnetbsd.o - has changed format.  You need to rebuild config
612	(done automatically by build.sh) and then you need to rerun
613	config on all kernel configuration files before rebuilding those
614	kernels.
615
61620081205:
617	If you build with MKX11=no, you should remove /etc/rc.d/xdm and
618	/etc/rc.d/xfs from DESTDIR because those files were moved to the xetc
619	set and will appear as extra files for MKX11=no update builds.
620
62120081122:
622	On i386, various kernel options(4) in GENERIC including
623	file systems have been disabled and moved into kernel modules.
624	Before trying a new GENERIC kernel, you have to prepare the
625	following files as well as a new GENERIC kernel:
626
627	- build and install kernel modules from src/sys/modules
628
629	- install the latest bootloader, which will load a module
630	  for the file system from which the kernel is loaded automatically
631
632	If you have to load your kernel from a file system which is not of
633	the same type as the root file system, you have to load the necessary
634	file system module manually on the boot prompt or in the boot.cfg file.
635
63620080827:
637	If you built and installed a libc from sources between
638	2008/08/20 and 2008/08/26 you got a broken strtouq(3)
639	which results in false errors reported by lint(1).
640	Since this breaks the libc build itself, manual help is
641	needed -- lint must be disabled temporarily, e.g.:
642	  $ (cd lib/libc && make MKLINT=no dependall install)
643
64420080813:
645	MKDEBUG build was broken because the .depend files did not know
646	about .go files.  You need to remove all .depend files and rebuild.
647
64820080802:
649	A regression in binary compatibility for pthread_mutex_t has
650	been fixed.  Unfortunately, the price is breaking compatibility
651	for -current.
652
653	Threaded programs (using libpthread) and C++ programs (using
654	libstdc++) compiled after 20070907 and before 20080802 need to
655	be recompiled.
656
657	One way to find affected pkgsrc packages:
658
659	  $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO
660	  $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO
661
66220080731:
663	WAPBL (metadata journaling support) has been added, but at this
664	time isn't backwards compatible with pre-WAPBL aware kernels
665	and userland (fsck_ffs in particular).  Please make sure you
666	don't use a journaled filesystem with an older kernel/userland,
667	especially an uncleanly mounted journaled filesystem.  WAPBL
668	also requires the super block to be in the UFS2 format.  You
669	can use fsck_ffs -c 4 to update the superblock format.
670
67120080721:
672	Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR
673	isn't defined.
674
67520080531:
676	The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed
677	from 125 (conflicted with DRVCTLCOMMAND) to 129.  The drvctl(8)
678	utility needs to be rebuilt and reinstalled as older binaries
679	won't work correctly.  The following sequence of commands:
680
681	  $ (cd sys/sys/ && nbmake-$arch includes)
682	  $ (cd sbin/drvctl/ && nbmake-$arch clean)
683	  $ (cd sbin/drvctl/ && nbmake-$arch all)
684
685	leaves new drvctl utility in sbin/drvctl build directory.
686
68720080503:
688	The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE.
689
69020080521:
691	For a while, unprivileged UPDATE builds would fail to
692	succeed at the checkflist stage, complaining that
693	${DESTDIR}/stand/<arch>/ did not exist.  A fix for this
694	problem was committed to share/mk/bsd.kmodule.mk, revision 1.9.
695	If you already hit this problem, update the .mk file,
696	remove ${DESTDIR}/stand/<arch>, and re-run the build.
697
69820080303:
699	Linker warnings are now fatal if $WARNS>0.
700
70120080126:
702	The posix_fadvise system call has been changed from an assembly
703	stub, to a c file that calls an assembly stub.  You need to
704	'rm -f posix_fadvise.* .depend' in the libc build directory to
705	avoid using the old assembly stub.
706
70720071209:
708	The acpiec(4) driver has been split into two attachments.  If you
709	get ACPI errors before the attachment, please update your kernel
710	configuration file appropriately or see GENERIC for more details.
711
71220071115:
713	The it(4) driver has been renamed to itesio(4) and the old port
714	argument specified in the kernel configuration file is not valid
715	anymore.  The itesio(4) driver now uses the Super I/O address port
716	rather than the EC address port.  Please update your kernel
717	configuration file appropriately or see GENERIC for more details.
718
71920071028:
720	The pccons(4) driver has been removed from the NetBSD/shark port.
721	You need to update any custom kernel configuration file you have
722	to remove any references to pccons (which includes removing the
723	now useless XSERVER option) and replace them with the correct
724	entries for the wscons driver.  See the GENERIC configuration file
725	for more details.
726
72720070913:
728	A latent bug in dhclient/dhcpd that caused it to be unable to
729	enumerate interfaces was fixed.  The bug began to cause
730	problems after 20070911 when the kernel's SIOCGIFCONF
731	implementation was repaired.  From 20070529 to 20070911 racoon
732	could not enumerate interfaces.  (These are noted because
733	normal kernel/userspace version matching hygiene is not
734	sufficient to avoid this problem.)  Ensure that both kernel
735	and userland are from after 20070913.
736
73720070703:
738	nbinstall has been renamed ${MACHINE_GNU_ARCH}-install.  It
739	calls the target-specific strip program, and the logic to pass
740	down STRIP from make has been removed.  This requires a
741	re-installation of tools.
742
74320070422:
744	The way OS emulations lookup filenames inside the emulation root
745	has been changed.  Rather than modify the pathname (and copy back
746	to userspace) namei() and lookup() directly check the emulation
747	root.  One side effect is that absolute symlinks inside the emulated
748	root file system will be relative to that file system - unless they
749	start /../ this is useful when the emulated root is a real install
750	that has such links.
751	This might affect symlinks that have been added to reference outside
752	the emulated root.
753
75420070412:
755	The pckbc driver on sgimips IP32 has been removed.  Use macekbc
756	instead.  See the GENERIC32_IP3x kernel configuration for an
757	example.
758
75920070319:
760        src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so
761        on many platforms due to incorrect flags settings.  If you
762        updated and built after about 20070315, do "nbmake-$arch
763	cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a
764	rebuild of object files that might have been built
765	incorrectly, and ensure that you have at least
766	src/lib/libc/Makefile 1.130.
767
76820070210:
769        src/sys/sys/{sa.h,savar.h} were removed.
770          find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \
771              | xargs egrep -l '/sa.h|/savar.h' | xargs rm
772        will allow dependencies on those files to get get rebuilt
773
77420070209:
775        The threading model was changed when the newlock2 branch
776        was merged to NetBSD-current.  If you boot with a new
777        kernel (version 4.99.10), then you also need a new pthread
778        library (/usr/lib/libpthread.so.0.7).  If you boot with
779        an old kernel, then you need the old pthread library
780        (/usr/lib/libpthread.so.0.6).  Provided you keep the kernel and
781        the pthread library in sync, old threaded applications should
782        continue to work with an old or new kernel.  Note that named(8)
783	is the only threaded application in the base system.
784
78520061214:
786	Following the move of string_to_flags() and flags_to_string()
787	from the bin/ls/ sources to libutil, users doing UPDATE builds
788	will need to do a "make cleandir" in
789		tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/,
790		bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/,
791		usr.bin/xinstall/, libexec/ftpd/, rescue/, as well
792		as the installation images in distrib/
793	in order to excise stale references to the old stat_flags.h header
794	file in the ls sources -- stat_flags.h has been removed.
795
79620061108:
797	The configure script used in the src/tools/gcc compiler has been
798	changed to indicate that our libc has ssp support built-in and
799	does not depend on -lssp and -lssp-nonshared.  You'll need to
800	make clean in src/tools/gcc first to rebuild the compiler.
801
80220061009:
803	The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer
804	available.  Use net.inet{,6}.tcp{,6}.congctl.selected instead.
805
80620060814:
807	The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been
808	withdrawn.  Use vidcvideo and pckbd instead.  See the GENERIC
809	kernel configuration for an example.  X servers from the last
810	few years should cope.
811
81220060703:
813	MPACPI is no more.  We always configure PCI interrupts using ACPI
814	if we have an ACPI kernel.  The option MPACPI_SCANPCI has been renamed
815	to ACPI_SCANPCI.  Thanks to work from fvdl.
816
81720060627:
818	socket(2) has changed, and its system call has been versioned.
819	For userlands with the old version of socket(2), make sure that
820	your kernel has 'options COMPAT_30' set, or else 'bad system call'
821	errors will result.
822
823Hints for a more successful build:
824^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
825    Use build.sh, but do not use its "expert mode":
826	This will automatically build the tools in the
827	   correct order, and it will keep the tools and the
828	   new build products from interfering with the running
829	   system.  This will allow you to ignore most of the
830	   other advice in this file.
831    Build a new kernel first:
832	This makes sure that any new system calls or features
833	   expected by the new userland will be present.  This
834	   helps to avoid critical errors when upgrading.
835    Use object directories:
836	This helps to keep stale object
837	   files from polluting the build if a Makefile "forgets"
838	   about one.  It also makes it easier to clean up after
839	   a build.  It's also necessary if you want to use the
840	   same source tree for multiple machines.
841	   To use object directories with build.sh:
842	    a) invoke build.sh with the "-M" or "-O" options.
843	   To use object directories without using build.sh:
844	    a) cd /usr/src ; make cleandir
845	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
846	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
847	    d) cd /usr/src ; make build
848	   Note that running "make obj" in a directory will create
849	   in obj.$MACHINE directory.
850    Build to a DESTDIR:
851	This helps to keep old installed files (especially libraries)
852	   from interfering with the new build.
853	   To build to a DESTDIR with build.sh, use the "-D" option.
854	   To build to a DESTDIR without using build.sh, set the DESTDIR
855	   environment variable before running make build.  It should be
856	   set to the pathname of an initially empty directory.
857	   Problems: if you do not use build.sh, you might need to
858		update critical utilities without using DESTDIR since
859		nothing is executed from what is installed in DESTDIR.
860		(See critical utils, below.)
861    Build often:
862	This keeps critical utilities current enough to not choke
863	on any other part of the source tree that depends on up to
864	date functionality.  If you use build.sh, you should not have
865	this problem.
866
867What to do if things don't work:
868^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
869When things don't work there are usually a few things that commonly
870should be done.
871    1)	make includes
872	This should be done automatically by make build.
873    2)  cd share/mk && make install
874	Again, automatically done by make build.
875
876Failsafe rebuild of a small part of the tree:
877^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
878To make sure you rebuild something correctly you want to do
879something like the following:
880    1)  Make sure the includes and .mk files are up to date.
881    2)  Make sure any program used to build the particular
882	utility is up to date.  (yacc, lex, etc...)
883    3)  cd ...path/to/util...
884	make cleandir
885	rm ...all obj directories...
886	make cleandir			# yes, again
887	make obj
888	make depend && make
889
890Failsafe rebuild of the entire tree:
891^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
892If you really want to make sure the source tree is clean and
893ready for a build try the following.  Note that sourcing /etc/mk.conf
894(a make(1) Makefile) in this manner is not right, and will not work
895for anyone who uses any make(1) features in /etc/mk.conf.
896
897---cut here---
898#!/bin/sh
899. /etc/mk.conf
900
901if [ -z $NETBSDSRCDIR ] ; then
902    NETBSDSRCDIR=/usr/src
903fi
904if [ \! -d $NETBSDSRCDIR ] ; then
905    echo Unable to find sources
906    exit 1
907fi
908find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
909
910if [ -z $BSDOBJDIR ] ; then
911    BSDOBJDIR=/usr/obj
912fi
913if [ -d $BSDOBJDIR ] ; then
914    rm -rf $BSDOBJDIR
915fi
916
917cd $NETBSDSRCDIR && make cleandir
918
919---cut here---
920
921Critical utilities:
922^^^^^^^^^^^^^^^^^^^
923	usr.bin/compile_et
924	usr.bin/make
925	usr.bin/yacc
926	usr.bin/lex
927	usr.bin/xlint
928	usr.bin/config
929
930Other problems and possible solutions:
931^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
932Symptom:Complaints involving a Makefile.
933Fix:	Rebuild usr.bin/make:
934	cd usr.bin/make && make && make install
935	Or, a failsafe method if that doesn't work:
936	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
937
938Fix:	Make sure .mk files are up to date.
939	cd share/mk && make install
940
941Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
942Fix:	Rebuild usr.bin/config
943
944Symptom:
945Fix:	Rebuild usr.bin/yacc
946
947Symptom:
948Fix:	Rebuild usr.bin/lex
949
950Symptom:
951Fix:	rm /usr/lib/libbfd.a
952
953Symptom:Obsolete intermediate files are used during compilation
954Fix:	Try the following sequence of commands in the directory in question.
955	make cleandir; rm `make print-objdir`; make cleandir; make obj
956	(If you built the tree without "make obj" in the past, obsolete files
957	may remain.  The command tries to clean everything up)
958
959Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
960	pointer type
961Fix:	Rebuild and install usr.bin/menuc
962
963Symptom:mklocale not found during build in share/locale/ctype
964Fix:	Build and install usr.bin/mklocale
965
966Symptom:undefined reference to `__assert13' or `__unsetenv13'
967Fix:    Rebuild and install lib/libc
968
969Symptom:usr.bin/config fails to build.
970Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
971
972Symptom:undefined reference to `getprogname' or `setprogname'
973Fix:    Rebuild and install lib/libc
974
975Symptom:lint does not understand the '-X' option
976Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
977
978Symptom:Update build fails in src/tools/gcc complaining that a variable
979	(e.g. CPPFLAGS) has changed since the previous run.
980Fix:    Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build.
981
982Symptom:cvs [update aborted]: cannot open directory /cvsroot/src/...:
983	No such file or directory.
984Cause:	If a directory is created by mistake, then it is sometimes
985	deleted from the CVS repository using administrative commands
986	that bypass the normal cvs access controls.  If your cvs working tree
987	contains references to a directory that has been deleted on the
988	server in this way, then "cvs update" reports this error.
989Fix:	Recursively delete the affected directory from your working tree
990	and try the update again.
991