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