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