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