UPDATING revision 1.301
1$NetBSD: UPDATING,v 1.301 2019/07/27 07:55:18 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
2220190727:
23	The uefi bootloader has gained tftp support and needs a clean
24	build. If you do update builds, manually clean its object
25	directory by something like:
26	cd sys/arch/i386/stand/efiboot && make clean
27
2820190723:
29	The jemalloc allocator in libc is now build without extended
30	debugging (for performance reasons). In update builds make sure
31	to rebuild it completly, by removing all affected object files,
32	including compat builds, something like:
33	cd /usr/obj && find . -type d -name jemalloc|xargs rm -rf
34
3520190207:
36	GCC 7 switched for many ports.  Update builds are likely to fail.
37
3820180924:
39	A newer OpenSSL version has been imported. If you are doing
40	update builds, make sure to remove all old obj dirs, like:
41	cd /usr/obj && find . -type d -name openssl | xargs rm -rf
42
4320180717:
44	On aarch64 int64_t and related types have changed from long long
45	to long. This requires recompiling all C++ binaries.
46
4720180713:
48	On amd64 and i386 static binaries are now build position
49	independend. This requires recompilation of all object
50	files used to create the crunched /rescue binary.
51	Clean the rescue directory in your obj directory before
52	doing an update build, otherwise linking will fail.
53
5420180414:
55	Existing binutils was migrated to binutils.old.  Manual
56	removal of tools/binutils objects directory may be required
57	to fix tools build failure.
58
5920180311:
60	bdftopcf was updated and may need cleaning in the
61	src/external/mit/xorg/tools/bdftopcf subdirectory if there are
62	link errors.
63
6420180212:
65	between OpenSSL and GCC updates, many things may fail to build.
66	any failure that looks like GCC or openssl is best handled by
67	a clean destdir and objdir.  Full cleandir and destdir deletion
68	is recommended if build failures occur.
69
7020171225:
71	removal of the vadvise syscall requires manual removal of all
72	associated files from the libc build object directory (including
73	the .depend files) - a command like:
74		cd $OBJ && find . -type d -name libc | xargs rm -rf
75	For architectures that support multiple "compat" binary targets,
76	you'll need to cleanup both the regular libc directory and the
77	compat ones (the above command will do that).
78
7920171010:
80	a change to the build structure of external/bsd/acpica/bin/iasl
81	means that its objdir (or *.d and .depend at least) might need
82	to be manually removed - or a build done once without -u.
83
8420170822:
85	a new version of GMP has been imported and probably
86	will break parts of builds related to themselves or GCC, both
87	in the tools and the native section.  Remove all GCC, GMP, MPFR
88	and MPC objdirs or build once without -u.
89
9020170816:
91	a new version of MPFR and MPC have been imported and probably
92	will break parts of builds related to themselves or GCC, both
93	in the tools and the native section.  Remove all GCC, GMP, MPFR
94	and MPC objdirs or build once without -u.
95
9620170402:
97	a new version of dhcpcd has been imported, which does not support
98	update builds from the previous version. Remove your
99	external/bsd/dhcpcd object dir or build once without -u.
100
10120170211:
102	a new terminfo database has been imported.
103	The structure of it has changed slightly from prior versions and
104	an updated tic tool is required.
105	If you build.sh, don't use -u
106
10720170207:
108	various arch dependent libc/exect.S files were removed
109	Either remove the obj directories (lib/libc and compat/amd64/i386/lib
110	if it exists) or do a clean build.
111	(This is a bug in the make system, it should be corrected without
112	human intervention, but isn't.)
113
11420170104:
115	xinput build options have changed.
116	Remove the obj directory (external/mit/xorg/bin/xinput)
117	if you build.sh -u
118
11920170103:
120	a new version of flex has been imported.
121	Remove the file from obj (external/bsd/flex)
122	if you build.sh -u
123
12420161014:
125	a new version of OpenSSL has been imported.
126	Remove the files from obj (crypto/external/bsd/openssl) 
127	if you build.sh -u
128
12920161009:
130	a new version of dhcpcd has been imported with slightly changed
131	build infrastructure. When doing a build.sh -u this requires
132	pruning the external/bsd/dhcpcd objdir.
133
13420160914:
135	i386, amd64, shark, ofppc and macppc have joined shark and x68k
136	ports in using xorg-server 1.18. This requires a clean destdir
137	and a clean objdir.
138
13920160527:
140	i386 needs a full cleandir or objdir deletion because PIE has
141	been enabled. (see the amd64 entry two down for further info)
142
14320160418:
144	libedit needs manual removal of all autogenerated files since
145	some of them are not autogenerated anymore. Remember that there
146	might be two copies of libedit if your platform builds "compat".
147
14820160410:
149	amd64 needs full "make cleandir" or deletion of objdir now that
150	PIE has been enabled for amd64.  PIE, or position-independent
151	executables, means all code, including executables and not just
152	shared libraries, is position-independent and hence able to be
153	relocated by ASLR, address space layout randomization.
154
155	The change was made in Makefile variables for compiler and
156	linker flags, for which make(1) does not record dependencies,
157	hence it is unable to detect that all .o files need rebuilding.
158
159	Partial rebuilds with some modified source files will likely
160	fail when linking executables, since the linker refuses to mix
161	position-independent code with position-dependent code in
162	position-independent executables:
163
164		.../x86_64--netbsd/bin/ld: foo.o: relocation R_X86_64_32 against `...' cannot be used when making a shared object; recompile with -fPIC
165
16620160401:
167	Ports switching to GCC 5.3 will need a full "make cleandir".
168	Some people have found that cleandir is not sufficient, so if
169	in doubt delete the entire object directory tree for gcc.
170
17120160306:
172	NetBSD's regexp implementation is now part of libnbcompat.
173	Nblex, nbm4, nbpax, nbsed use it and they may crash on
174	non-NetBSD hosts if linked with stale object files produced
175	while they included a non-NetBSD regex.h.
176	In any case, you should "make cleandir" at least these tools
177	before updating your toolchain.
178
17920160125:
180	Dtrace has been enabled by default on some architectures.
181	When doing an update build, make sure to clean the etc/mtree
182	object directory before starting the build - otherwise the
183	needed directories in destdir will not be created.
184	An easy way to do this is:
185	   cd src/etc/mtree && $TOOLDIR/bin/nbmake-$arch cleandir
186
18720150818:
188	New acpica requires "make cleandir" in src/external/bsd/acpica
189	again.
190
19120150413:
192	New acpica requires "make cleandir" and reinstalling yacc
193	in /usr/src/external/bsd/byacc and /usr/src/tools/yacc and
194	also "make cleandir" in /usr/src/external/bsd/acpica.
195
19620150404:
197	Lint changes require a full rebuild of the tool, so make
198	sure to build without -u option to build.sh, or manually
199	do a make cleandir in src/tools/lint1 and
200	src/usr.bin/xlint.
201
20220150310:
203	Improvements to openssl for arm mean that update builds of
204	the openssl libraries will fail. A make cleandir in
205	external/bsd/openssl/lib is needed
206
20720141026:
208	A mishap during the import of pppd may cause your corruption
209	in your cvs directory if you happened to do a cvs update
210	during a short period of time. To fix, just remove the
211	directory src/external/bsd/ppp/dist/pppd completely
212	and let cvs restore it on next update.
213
21420140721:
215	The src/external/mit/lua/src directory was accidentally created
216	and then deleted in the CVS repository.  If you get errors like
217
218	cvs [update aborted]: cannot open directory
219	/cvsroot/src/external/mit/lua/src: No such file or directory
220
221	then delete your local copy of that directory tree and try again.
222
22320140530:
224	ARM eABI switched to DWARF based exception handling. This requires
225	rebuilding all C++ code. It is strongly advised to do a clean build.
226
22720140131:
228	The new compiler_rt/libc integration moved a few things. It is strongly
229	advised to do a clean build. At least lib/libc, the compat version(s)
230	of libc, libkern, rump and the kernels need to be cleaned.
231
23220131227:
233	1. The new ntpd runs in a restricted mode to prevent amplification
234	   attacks. If you need ntpdc to work you need to explicitly enable
235	   mode7 in your config file. Make sure you put the necessary restrict
236	   statements to avoid being exposed.
237	2. strncat has moved from lib/libc to common/lib/libc; you might need
238	   to make clean in libc
239
24020131129:
241	The GMP sources were updated, and builds will likely fail without
242	cleaning their build trees for both tools and in-tree, like below.
243
24420131128:
245	The MPC and MPFR sources were updated, and builds may require their
246	tools and in-tree directories cleaned for successful updates.
247
24820130605:
249	The kernel option FAST_IPSEC no longer exists, it's been renamed
250	to IPSEC (and the older IPSEC version removed).
251
25220130605:
253	Previous freetype installations eroneously installed private
254	header files. If you are building against a non-empty $DESTDIR,
255	please remove ${DESTDIR}//usr/X11R7/include/freetype2/freetype/.
256
25720130531:
258	The xdm update may cause build failure due to xdm.man being
259	in the obj tree.  Make sure to ensure any like this:
260		nbmake: nbmake: don't know how to make xdm.man. Stop
261	is fixed by deleting the xdm.man in the obj tree.
262
26320130530:
264	Updates of many xsrc packages will leave old .pc files around.
265	Best to clean out the xsrc objdir entirely before rebuilds.
266
26720130301:
268	The removal of netiso requires manual removal of /usr/include/netiso
269	prior to the build and make cleandir in /usr/src/usr.bin/{ktruss,kdump}
270
27120120726:
272	The update of OpenSSL requires cleaning both the OpenSSL build
273	directory and DESTDIR.  *Even non-update builds require cleaning
274	DESTDIR.* Builds done without taking these steps may fail, or in
275	some cases may succeed and install broken OpenSSL libraries that
276	cause third-party software to link incorrectly and/or crash.
277
27820120507:
279	The database schema for makemandb was changed.  You will
280	need to update the database using 'makemandb -f' or wait
281	for the next weekly run to fix it.
282
28320120319:
284	sys/conf/Makefile.kern.inc has been modified to adjust the
285	size of db_symtab automatically.  You need to update dbsym in
286	your $TOOLDIR to build kernels with options SYMTAB_SPACE.  If
287	you don't want this behavior, add AUTO_SYMTAB_SPACE=no to your
288	mk.conf.
289
29020120216:
291	Default for MKCATPAGES changed to NO.  Update builds will fail
292	unless DESTDIR is cleaned manually.  If you built between 20120207
293	and 20120216, daily and weekly could have created an unreadable
294	/var/db/man.db index for apropos.  Running makemandb -f or
295	the next run of weekly will fix it.
296
29720111227:
298	If you built between 20111225 and 20111227 you need to remove
299	/usr/lib/libpam.so.4* and /usr/lib/security/*.so.4, since the
300	bump has been reverted.
301
30220111125:
303	The "rnd" pseudodevice has been added to sys/conf/std, which
304	means it should no longer be explicitly listed in kernel
305	configuration files.  The line "pseudo-device rnd" should be
306	removed from any custom kernel config files users may have.
307
30820111119:
309	A problem with the datastructures used by the rndctl(8)
310	utility (pointers in datastructures in an array, making 32->64
311	bit compatibility very painful) has been fixed in a
312	non-backwards-compatible way.  If you replace your kernel,
313	replace your rndctl executable too.
314
31520111001:
316	the prop_*_send_syscall() functions from proplib(3) have been
317	changed and their new version is not backward compatible with the old
318	one.  So ensure that all consumers of these functions (currently:
319	quota2 code and its tests) are updated together with the new lib.
320
32120110817:
322	sparc has been changed to use GCC 4.5.3, so any objdir or
323	DESTDIR for them should be deleted before updating.
324
32520110806:
326	i386 and amd64 have been changed to use GCC 4.5.3, so any
327	objdir or DESTDIR for them should be deleted before updating.
328
32920110805:
330	The update to GCC 4.5.3 requires a non-trivial portion of
331	the tree to be cleaned.  Best to delete both objdir and
332	DESTDIR before running this update.  So far, only the
333	sparc64, mips and powerpc platforms have changed.
334
33520110803:
336	The layout of external/public-domain/xz has changed.  To do an
337	update build you will have to remove the contents of the OBJDIR
338	for external/public-domain/xz/bin by hand as the xz entry there
339	is now a directory.
340
34120110410:
342	The configuration of src/tools/gcc has changed.  To do an
343	update build you have to clean both tools/binutils and
344	tools/gcc by hand.
345
34620110328:
347	Building the Xorg binary was moved into a subdirectory to fix
348	ordering issues with "make all".  It may be necessary to remove
349	the OBJDIR for external/mit/xorg/server/xorg-server/hw/xfree86
350	if your update build fails, as the "Xorg" entry there is now a
351	directory.
352
35320110121:
354	Assembler files no longer use -traditional-cpp.  This can break
355	the build of individual parts of the tree.  This is handled
356	correctly by build.sh.  Manual builds have to update /usr/share/mk
357	and re-run config(1) for any kernel configurations as needed.
358
35920101217:
360	The tcpdump(8) program was changed to drop privileges and chroot(2)
361	by default.  It may be necessary to manually update passwd(5) and
362	group(5) in order to make the program work with existing setups.
363
36420101125:
365	The latest changes to setenv(3) dissallow setting environment
366	variables with names that contain '='.  Revision 1.18 of env.c
367	assumed that this was allowed.  Installing a new libc with an
368	old copy of /usr/bin/env causes env x=1 printenv | grep x= to
369	break which affects the autoconf tests for dependency finding,
370	so building gcc will end up printing:
371	    checking dependency style of gcc... none
372	    configure: error: no usable dependency style found
373	Fix it by rebuilding and re-installing env.
374
37520101119:
376	Recent Xorg updates in xsrc/external/mit/ may cause various build
377	or run-time problems.  Delete your entire DESTDIR and OBJDIR if you
378	have any build problems with xsrc, or problems with mismatched
379	versions between xorg-server and drivers.
380
38120100604:
382	The update of ATF to 0.9 causes old tests written in shell to fail
383	unless they are rebuilt.  If you are building with MKUPDATE=yes,
384	you need to clean the src/external/bsd/atf/tests/ and the src/tests/
385	trees by hand.
386
38720100522:
388	Recent Xorg updates in xsrc/external/mit/ will cause various build
389	problems.  Delete your entire DESTDIR and OBJDIR if you have any
390	build problems with xsrc.
391
39220100522:
393	private section of <ctype.h> was splitted, and now mklocale(1)
394	include ctype_local.h, so you have to make cleandir in tools/mklocale.
395
39620100520:
397	The location of the xkb compiled descriptions has changed.  Please
398	remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR.
399
40020100222:
401	The shared objects file extension has been changed from .so to
402	.pico, in order to avoid conflicts with shared libraries names
403	libXX.so.  All now stale regular .so files can be removed from
404	your object directories.
405
40620100204:
407	The termcap database has been removed from the sources,
408	but has not been marked obsolete so it is not removed
409	from the system when upgrading.
410	As such, you will need to remove them from your object
411	and destination directories.
412
41320091101:
414        After updating, it may be necessary to make the 'cleandir'
415        target in src/tools/yacc/ and in src/usr.bin/yacc/ before a
416        'build.sh -u tools' or 'build.sh -u distribution'.  Ditto
417        src/tools/lex/ and src/usr.bin/lex/.
418
41920091001:
420	On amd64 you must rebuild tools (to get the new binutils)
421	before building a kernel, or the build fails on cpufunc.S.
422
42320091001:
424	An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb
425	symlink, failing the build.  Delete the link, and the subdir
426	it is in, and retry your build.
427
42820090718:
429	libc build changed so that strchr() provides the extra entry
430	point for index().  Update build of libc.a (and libc_pic.a)
431	may fail because the archive contains the unwanted index.o.
432	(Similarly for strrchr() and rindex().)
433
43420090709:
435	Native Xorg was upgraded again.  Builds will probably fail again
436	without a clean objdir, at least for src/external/mit/xorg.
437
43820090616:
439	Native Xorg was upgraded.  Builds will need a clean objdir for
440	src/external/mit/xorg.  Upgrading a system from sets will not
441	work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc
442	subdirectory has been changed into a file, and this needs to
443	be manually "rm -r"'ed before installing xbase.tgz.
444
44520090501:
446	Several new functions were added to string.h/libc, and this
447	can cause autoconf problems during the tool build for people
448	who fail to clean out their tools objects properly.  If you
449	note messages about stpcpy, stpncpy or strnlen accompanying a
450	failure during the tool build, clean out all your tools
451	objects and start again.
452
45320090325:
454	The i386 port was switched to i486 default toolchain.  This requires
455	cleaning your src/tools directory and $TOOLDIR and rebuilding them.
456
45720090126:
458	The __posix_fadvise50 system call changed assembly stub type.  You
459	need to 'rm -f __posix_fadvise50.*' in the libc build directory
460	to avoid using the old assembly stub.
461
46220090202:
463	pkg_install now depends on the pkgdb cache for automatic conflict
464	detection.  It is recommented to rebuild the cache with
465	``pkg_admin rebuild''.
466
46720090110:
468	time_t and dev_t have been bumped to 64 bit quantities.  To upgrade:
469	1. Make sure your kernel has COMPAT_50 in it.  Build and install.
470	   This is needed even in the MODULAR kernel because there is
471	   conditionally compiled code in rtsock.c.
472	2. make sure build.sh completes and the binaries in a chroot work
473	   before installing.
474	3. If you don't use build.sh and you build directly to root, and
475	   your build breaks in the middle, don't despair.  Make sure headers
476	   are installed properly, and start building libraries first libc
477	   and libutil, install them and then continue building all the
478	   libraries in src/lib and src/gnu/lib and install them.  Once
479	   the new libraries are installed, you can restart the build.
480	4. If you compile packages and you notice link time warnings,
481	   rebuild the required packages to update their shared libraries.
482	   Any package you rebuild will require rebuilding all the packages
483	   that depend on it.
484	5. Next time you run pwd_mkdb with the new binary, the file
485	   will be upgraded and it will not be backwards compatible.
486	6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see
487	   lastlogx(5)) have been versioned, and there is a heuristic
488	   for utmp.  You are better off removing the old files after
489	   upgrading.  The automated clearing of /var/run during
490	   boot, and the automated rotating of files in /var/log by
491	   newsyslog(8), may mean that you do not have to remove the
492	   files manually.
493	7. The optional accounting file (/var/account/acct, see
494	   accton(8)) has not been versioned, and will need to be
495	   removed.  The automatic rotation of the accounting file by
496	   /etc/daily limits the bad consequences of failure to remove
497	   the file.
498	8. Application software that writes time_t to binary files on
499	   disk will break or need attention.  Most notably: if you are
500	   using PostgreSQL < 8.4, you need to dump your databases,
501	   rebuild PostgreSQL with the new time_t, then restore.
502
50320081219:
504	config(1) has been updated, and one of the files it creates -
505	swapnetbsd.o - has changed format.  You need to rebuild config
506	(done automatically by build.sh) and then you need to rerun
507	config on all kernel configuration files before rebuilding those
508	kernels.
509
51020081205:
511	If you build with MKX11=no, you should remove /etc/rc.d/xdm and
512	/etc/rc.d/xfs from DESTDIR because those files were moved to the xetc
513	set and will appear as extra files for MKX11=no update builds.
514
51520081122:
516	On i386, various kernel options(4) in GENERIC including
517	file systems have been disabled and moved into kernel modules.
518	Before trying a new GENERIC kernel, you have to prepare the
519	following files as well as a new GENERIC kernel:
520
521	- build and install kernel modules from src/sys/modules
522
523	- install the latest bootloader, which will load a module
524	  for the file system from which the kernel is loaded automatically
525
526	If you have to load your kernel from a file system which is not of
527	the same type as the root file system, you have to load the necessary
528	file system module manually on the boot prompt or in the boot.cfg file.
529
53020080827:
531	If you built and installed a libc from sources between
532	2008/08/20 and 2008/08/26 you got a broken strtouq(3)
533	which results in false errors reported by lint(1).
534	Since this breaks the libc build itself, manual help is
535	needed -- lint must be disabled temporarily, e.g.:
536	  $ (cd lib/libc && make MKLINT=no dependall install)
537
53820080813:
539	MKDEBUG build was broken because the .depend files did not know
540	about .go files.  You need to remove all .depend files and rebuild.
541
54220080802:
543	A regression in binary compatibility for pthread_mutex_t has
544	been fixed.  Unfortunately, the price is breaking compatibility
545	for -current.
546
547	Threaded programs (using libpthread) and C++ programs (using
548	libstdc++) compiled after 20070907 and before 20080802 need to
549	be recompiled.
550
551	One way to find affected pkgsrc packages:
552
553	  $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO
554	  $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO
555
55620080731:
557	WAPBL (metadata journaling support) has been added, but at this
558	time isn't backwards compatible with pre-WAPBL aware kernels
559	and userland (fsck_ffs in particular).  Please make sure you
560	don't use a journaled filesystem with an older kernel/userland,
561	especially an uncleanly mounted journaled filesystem.  WAPBL
562	also requires the super block to be in the UFS2 format.  You
563	can use fsck_ffs -c 4 to update the superblock format.
564
56520080721:
566	Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR
567	isn't defined.
568
56920080531:
570	The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed
571	from 125 (conflicted with DRVCTLCOMMAND) to 129.  The drvctl(8)
572	utility needs to be rebuilt and reinstalled as older binaries
573	won't work correctly.  The following sequence of commands:
574
575	  $ (cd sys/sys/ && nbmake-$arch includes)
576	  $ (cd sbin/drvctl/ && nbmake-$arch clean)
577	  $ (cd sbin/drvctl/ && nbmake-$arch all)
578
579	leaves new drvctl utility in sbin/drvctl build directory.
580
58120080503:
582	The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE.
583
58420080521:
585	For a while, unprivileged UPDATE builds would fail to
586	succeed at the checkflist stage, complaining that
587	${DESTDIR}/stand/<arch>/ did not exist.  A fix for this
588	problem was committed to share/mk/bsd.kmodule.mk, revision 1.9.
589	If you already hit this problem, update the .mk file,
590	remove ${DESTDIR}/stand/<arch>, and re-run the build.
591
59220080303:
593	Linker warnings are now fatal if $WARNS>0.
594
59520080126:
596	The posix_fadvise system call has been changed from an assembly
597	stub, to a c file that calls an assembly stub.  You need to
598	'rm -f posix_fadvise.* .depend' in the libc build directory to
599	avoid using the old assembly stub.
600
60120071209:
602	The acpiec(4) driver has been split into two attachments.  If you
603	get ACPI errors before the attachment, please update your kernel
604	configuration file appropriately or see GENERIC for more details.
605
60620071115:
607	The it(4) driver has been renamed to itesio(4) and the old port
608	argument specified in the kernel configuration file is not valid
609	anymore.  The itesio(4) driver now uses the Super I/O address port
610	rather than the EC address port.  Please update your kernel
611	configuration file appropriately or see GENERIC for more details.
612
61320071028:
614	The pccons(4) driver has been removed from the NetBSD/shark port.
615	You need to update any custom kernel configuration file you have
616	to remove any references to pccons (which includes removing the
617	now useless XSERVER option) and replace them with the correct
618	entries for the wscons driver.  See the GENERIC configuration file
619	for more details.
620
62120070913:
622	A latent bug in dhclient/dhcpd that caused it to be unable to
623	enumerate interfaces was fixed.  The bug began to cause
624	problems after 20070911 when the kernel's SIOCGIFCONF
625	implementation was repaired.  From 20070529 to 20070911 racoon
626	could not enumerate interfaces.  (These are noted because
627	normal kernel/userspace version matching hygiene is not
628	sufficient to avoid this problem.)  Ensure that both kernel
629	and userland are from after 20070913.
630
63120070703:
632	nbinstall has been renamed ${MACHINE_GNU_ARCH}-install.  It
633	calls the target-specific strip program, and the logic to pass
634	down STRIP from make has been removed.  This requires a
635	re-installation of tools.
636
63720070422:
638	The way OS emulations lookup filenames inside the emulation root
639	has been changed.  Rather than modify the pathname (and copy back
640	to userspace) namei() and lookup() directly check the emulation
641	root.  One side effect is that absolute symlinks inside the emulated
642	root file system will be relative to that file system - unless they
643	start /../ this is useful when the emulated root is a real install
644	that has such links.
645	This might affect symlinks that have been added to reference outside
646	the emulated root.
647
64820070412:
649	The pckbc driver on sgimips IP32 has been removed.  Use macekbc
650	instead.  See the GENERIC32_IP3x kernel configuration for an
651	example.
652
65320070319:
654        src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so
655        on many platforms due to incorrect flags settings.  If you
656        updated and built after about 20070315, do "nbmake-$arch
657	cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a
658	rebuild of object files that might have been built
659	incorrectly, and ensure that you have at least
660	src/lib/libc/Makefile 1.130.
661
66220070210:
663        src/sys/sys/{sa.h,savar.h} were removed.
664          find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \
665              | xargs egrep -l '/sa.h|/savar.h' | xargs rm
666        will allow dependencies on those files to get get rebuilt
667
66820070209:
669        The threading model was changed when the newlock2 branch
670        was merged to NetBSD-current.  If you boot with a new
671        kernel (version 4.99.10), then you also need a new pthread
672        library (/usr/lib/libpthread.so.0.7).  If you boot with
673        an old kernel, then you need the old pthread library
674        (/usr/lib/libpthread.so.0.6).  Provided you keep the kernel and
675        the pthread library in sync, old threaded applications should
676        continue to work with an old or new kernel.  Note that named(8)
677	is the only threaded application in the base system.
678
67920061214:
680	Following the move of string_to_flags() and flags_to_string()
681	from the bin/ls/ sources to libutil, users doing UPDATE builds
682	will need to do a "make cleandir" in
683		tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/,
684		bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/,
685		usr.bin/xinstall/, libexec/ftpd/, rescue/, as well
686		as the installation images in distrib/
687	in order to excise stale references to the old stat_flags.h header
688	file in the ls sources -- stat_flags.h has been removed.
689
69020061108:
691	The configure script used in the src/tools/gcc compiler has been
692	changed to indicate that our libc has ssp support built-in and
693	does not depend on -lssp and -lssp-nonshared.  You'll need to
694	make clean in src/tools/gcc first to rebuild the compiler.
695
69620061009:
697	The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer
698	available.  Use net.inet{,6}.tcp{,6}.congctl.selected instead.
699
70020060814:
701	The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been
702	withdrawn.  Use vidcvideo and pckbd instead.  See the GENERIC
703	kernel configuration for an example.  X servers from the last
704	few years should cope.
705
70620060703:
707	MPACPI is no more.  We always configure PCI interrupts using ACPI
708	if we have an ACPI kernel.  The option MPACPI_SCANPCI has been renamed
709	to ACPI_SCANPCI.  Thanks to work from fvdl.
710
71120060627:
712	socket(2) has changed, and its system call has been versioned.
713	For userlands with the old version of socket(2), make sure that
714	your kernel has 'options COMPAT_30' set, or else 'bad system call'
715	errors will result.
716
717Hints for a more successful build:
718^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
719    Use build.sh, but do not use its "expert mode":
720	This will automatically build the tools in the
721	   correct order, and it will keep the tools and the
722	   new build products from interfering with the running
723	   system.  This will allow you to ignore most of the
724	   other advice in this file.
725    Build a new kernel first:
726	This makes sure that any new system calls or features
727	   expected by the new userland will be present.  This
728	   helps to avoid critical errors when upgrading.
729    Use object directories:
730	This helps to keep stale object
731	   files from polluting the build if a Makefile "forgets"
732	   about one.  It also makes it easier to clean up after
733	   a build.  It's also necessary if you want to use the
734	   same source tree for multiple machines.
735	   To use object directories with build.sh:
736	    a) invoke build.sh with the "-M" or "-O" options.
737	   To use object directories without using build.sh:
738	    a) cd /usr/src ; make cleandir
739	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
740	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
741	    d) cd /usr/src ; make build
742	   Note that running "make obj" in a directory will create
743	   in obj.$MACHINE directory.
744    Build to a DESTDIR:
745	This helps to keep old installed files (especially libraries)
746	   from interfering with the new build.
747	   To build to a DESTDIR with build.sh, use the "-D" option.
748	   To build to a DESTDIR without using build.sh, set the DESTDIR
749	   environment variable before running make build.  It should be
750	   set to the pathname of an initially empty directory.
751	   Problems: if you do not use build.sh, you might need to
752		update critical utilities without using DESTDIR since
753		nothing is executed from what is installed in DESTDIR.
754		(See critical utils, below.)
755    Build often:
756	This keeps critical utilities current enough to not choke
757	on any other part of the source tree that depends on up to
758	date functionality.  If you use build.sh, you should not have
759	this problem.
760
761What to do if things don't work:
762^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
763When things don't work there are usually a few things that commonly
764should be done.
765    1)	make includes
766	This should be done automatically by make build.
767    2)  cd share/mk && make install
768	Again, automatically done by make build.
769
770Failsafe rebuild of a small part of the tree:
771^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
772To make sure you rebuild something correctly you want to do
773something like the following:
774    1)  Make sure the includes and .mk files are up to date.
775    2)  Make sure any program used to build the particular
776	utility is up to date.  (yacc, lex, etc...)
777    3)  cd ...path/to/util...
778	make cleandir
779	rm ...all obj directories...
780	make cleandir			# yes, again
781	make obj
782	make depend && make
783
784Failsafe rebuild of the entire tree:
785^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
786If you really want to make sure the source tree is clean and
787ready for a build try the following.  Note that sourcing /etc/mk.conf
788(a make(1) Makefile) in this manner is not right, and will not work
789for anyone who uses any make(1) features in /etc/mk.conf.
790
791---cut here---
792#!/bin/sh
793. /etc/mk.conf
794
795if [ -z $NETBSDSRCDIR ] ; then
796    NETBSDSRCDIR=/usr/src
797fi
798if [ \! -d $NETBSDSRCDIR ] ; then
799    echo Unable to find sources
800    exit 1
801fi
802find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
803
804if [ -z $BSDOBJDIR ] ; then
805    BSDOBJDIR=/usr/obj
806fi
807if [ -d $BSDOBJDIR ] ; then
808    rm -rf $BSDOBJDIR
809fi
810
811cd $NETBSDSRCDIR && make cleandir
812
813---cut here---
814
815Critical utilities:
816^^^^^^^^^^^^^^^^^^^
817	usr.bin/compile_et
818	usr.bin/make
819	usr.bin/yacc
820	usr.bin/lex
821	usr.bin/xlint
822	usr.bin/config
823
824Other problems and possible solutions:
825^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
826Symptom:Complaints involving a Makefile.
827Fix:	Rebuild usr.bin/make:
828	cd usr.bin/make && make && make install
829	Or, a failsafe method if that doesn't work:
830	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
831
832Fix:	Make sure .mk files are up to date.
833	cd share/mk && make install
834
835Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
836Fix:	Rebuild usr.bin/config
837
838Symptom:
839Fix:	Rebuild usr.bin/yacc
840
841Symptom:
842Fix:	Rebuild usr.bin/lex
843
844Symptom:
845Fix:	rm /usr/lib/libbfd.a
846
847Symptom:Obsolete intermediate files are used during compilation
848Fix:	Try the following sequence of commands in the directory in question.
849	make cleandir; rm `make print-objdir`; make cleandir; make obj
850	(If you built the tree without "make obj" in the past, obsolete files
851	may remain.  The command tries to clean everything up)
852
853Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
854	pointer type
855Fix:	Rebuild and install usr.bin/menuc
856
857Symptom:mklocale not found during build in share/locale/ctype
858Fix:	Build and install usr.bin/mklocale
859
860Symptom:undefined reference to `__assert13' or `__unsetenv13'
861Fix:    Rebuild and install lib/libc
862
863Symptom:usr.bin/config fails to build.
864Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
865
866Symptom:undefined reference to `getprogname' or `setprogname'
867Fix:    Rebuild and install lib/libc
868
869Symptom:lint does not understand the '-X' option
870Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
871
872Symptom:Update build fails in src/tools/gcc complaining that a variable
873	(e.g. CPPFLAGS) has changed since the previous run.
874Fix:    Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build.
875
876Symptom:cvs [update aborted]: cannot open directory /cvsroot/src/...:
877	No such file or directory.
878Cause:	If a directory is created by mistake, then it is sometimes
879	deleted from the CVS repository using administrative commands
880	that bypass the normal cvs access controls.  If your cvs working tree
881	contains references to a directory that has been deleted on the
882	server in this way, then "cvs update" reports this error.
883Fix:	Recursively delete the affected directory from your working tree
884	and try the update again.
885