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