UPDATING revision 1.265
1$NetBSD: UPDATING,v 1.265 2016/02/29 22:49:11 aymeric 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
2220160229:
23	NetBSD's regexp implementation is now part of libnbcompat.
24	Nblex, nbm4, nbpax, nbsed use it and they may crash on
25	non-NetBSD hosts if linked with stale object files produced
26	while they included a non-NetBSD regex.h.
27	In any case, you should "make cleandir" at least these tools
28	before updating your toolchain.
29
3020160125:
31	Dtrace has been enabled by default on some architectures.
32	When doing an update build, make sure to clean the etc/mtree
33	object directory before starting the build - otherwise the
34	needed directories in destdir will not be created.
35	An easy way to do this is:
36	   cd src/etc/mtree && $TOOLDIR/bin/nbmake-$arch cleandir
37
3820150818:
39	New acpica requires "make cleandir" in src/external/bsd/acpica
40	again.
41
4220150413:
43	New acpica requires "make cleandir" and reinstalling yacc
44	in /usr/src/external/bsd/byacc and /usr/src/tools/yacc and
45	also "make cleandir" in /usr/src/external/bsd/acpica.
46
4720150404:
48	Lint changes require a full rebuild of the tool, so make
49	sure to build without -u option to build.sh, or manually
50	do a make cleandir in src/tools/lint1 and
51	src/usr.bin/xlint.
52
5320150310:
54	Improvements to openssl for arm mean that update builds of
55	the openssl libraries will fail. A make cleandir in
56	external/bsd/openssl/lib is needed
57
5820141026:
59	A mishap during the import of pppd may cause your corruption
60	in your cvs directory if you happened to do a cvs update
61	during a short period of time. To fix, just remove the
62	directory src/external/bsd/ppp/dist/pppd completely
63	and let cvs restore it on next update.
64
6520140721:
66	The src/external/mit/lua/src directory was accidentally created
67	and then deleted in the CVS repository.  If you get errors like
68
69	cvs [update aborted]: cannot open directory
70	/cvsroot/src/external/mit/lua/src: No such file or directory
71
72	then delete your local copy of that directory tree and try again.
73
7420140530:
75	ARM eABI switched to DWARF based exception handling. This requires
76	rebuilding all C++ code. It is strongly advised to do a clean build.
77
7820140131:
79	The new compiler_rt/libc integration moved a few things. It is strongly
80	advised to do a clean build. At least lib/libc, the compat version(s)
81	of libc, libkern, rump and the kernels need to be cleaned.
82
8320131227:
84	1. The new ntpd runs in a restricted mode to prevent amplification
85	   attacks. If you need ntpdc to work you need to explicitly enable
86	   mode7 in your config file. Make sure you put the necessary restrict
87	   statements to avoid being exposed.
88	2. strncat has moved from lib/libc to common/lib/libc; you might need
89	   to make clean in libc
90
9120131129:
92	The GMP sources were updated, and builds will likely fail without
93	cleaning their build trees for both tools and in-tree, like below.
94
9520131128:
96	The MPC and MPFR sources were updated, and builds may require their
97	tools and in-tree directories cleaned for successful updates.
98
9920130605:
100	The kernel option FAST_IPSEC no longer exists, it's been renamed
101	to IPSEC (and the older IPSEC version removed).
102
10320130605:
104	Previous freetype installations eroneously installed private
105	header files. If you are building against a non-empty $DESTDIR,
106	please remove ${DESTDIR}//usr/X11R7/include/freetype2/freetype/.
107
10820130531:
109	The xdm update may cause build failure due to xdm.man being
110	in the obj tree.  Make sure to ensure any like this:
111		nbmake: nbmake: don't know how to make xdm.man. Stop
112	is fixed by deleting the xdm.man in the obj tree.
113
11420130530:
115	Updates of many xsrc packages will leave old .pc files around.
116	Best to clean out the xsrc objdir entirely before rebuilds.
117
11820130301:
119	The removal of netiso requires manual removal of /usr/include/netiso
120	prior to the build and make cleandir in /usr/src/usr.bin/{ktruss,kdump}
121
12220120726:
123	The update of OpenSSL requires cleaning both the OpenSSL build
124	directory and DESTDIR.  *Even non-update builds require cleaning
125	DESTDIR.* Builds done without taking these steps may fail, or in
126	some cases may succeed and install broken OpenSSL libraries that
127	cause third-party software to link incorrectly and/or crash.
128
12920120507:
130	The database schema for makemandb was changed.  You will
131	need to update the database using 'makemandb -f' or wait
132	for the next weekly run to fix it.
133
13420120319:
135	sys/conf/Makefile.kern.inc has been modified to adjust the
136	size of db_symtab automatically.  You need to update dbsym in
137	your $TOOLDIR to build kernels with options SYMTAB_SPACE.  If
138	you don't want this behavior, add AUTO_SYMTAB_SPACE=no to your
139	mk.conf.
140
14120120216:
142	Default for MKCATPAGES changed to NO.  Update builds will fail
143	unless DESTDIR is cleaned manually.  If you built between 20120207
144	and 20120216, daily and weekly could have created an unreadable
145	/var/db/man.db index for apropos.  Running makemandb -f or
146	the next run of weekly will fix it.
147
14820111227:
149	If you built between 20111225 and 20111227 you need to remove
150	/usr/lib/libpam.so.4* and /usr/lib/security/*.so.4, since the
151	bump has been reverted.
152
15320111125:
154	The "rnd" pseudodevice has been added to sys/conf/std, which
155	means it should no longer be explicitly listed in kernel
156	configuration files.  The line "pseudo-device rnd" should be
157	removed from any custom kernel config files users may have.
158
15920111119:
160	A problem with the datastructures used by the rndctl(8)
161	utility (pointers in datastructures in an array, making 32->64
162	bit compatibility very painful) has been fixed in a
163	non-backwards-compatible way.  If you replace your kernel,
164	replace your rndctl executable too.
165
16620111001:
167	the prop_*_send_syscall() functions from proplib(3) have been
168	changed and their new version is not backward compatible with the old
169	one.  So ensure that all consumers of these functions (currently:
170	quota2 code and its tests) are updated together with the new lib.
171
17220110817:
173	sparc has been changed to use GCC 4.5.3, so any objdir or
174	DESTDIR for them should be deleted before updating.
175
17620110806:
177	i386 and amd64 have been changed to use GCC 4.5.3, so any
178	objdir or DESTDIR for them should be deleted before updating.
179
18020110805:
181	The update to GCC 4.5.3 requires a non-trivial portion of
182	the tree to be cleaned.  Best to delete both objdir and
183	DESTDIR before running this update.  So far, only the
184	sparc64, mips and powerpc platforms have changed.
185
18620110803:
187	The layout of external/public-domain/xz has changed.  To do an
188	update build you will have to remove the contents of the OBJDIR
189	for external/public-domain/xz/bin by hand as the xz entry there
190	is now a directory.
191
19220110410:
193	The configuration of src/tools/gcc has changed.  To do an
194	update build you have to clean both tools/binutils and
195	tools/gcc by hand.
196
19720110328:
198	Building the Xorg binary was moved into a subdirectory to fix
199	ordering issues with "make all".  It may be necessary to remove
200	the OBJDIR for external/mit/xorg/server/xorg-server/hw/xfree86
201	if your update build fails, as the "Xorg" entry there is now a
202	directory.
203
20420110121:
205	Assembler files no longer use -traditional-cpp.  This can break
206	the build of individual parts of the tree.  This is handled
207	correctly by build.sh.  Manual builds have to update /usr/share/mk
208	and re-run config(1) for any kernel configurations as needed.
209
21020101217:
211	The tcpdump(8) program was changed to drop privileges and chroot(2)
212	by default.  It may be necessary to manually update passwd(5) and
213	group(5) in order to make the program work with existing setups.
214
21520101125:
216	The latest changes to setenv(3) dissallow setting environment
217	variables with names that contain '='.  Revision 1.18 of env.c
218	assumed that this was allowed.  Installing a new libc with an
219	old copy of /usr/bin/env causes env x=1 printenv | grep x= to
220	break which affects the autoconf tests for dependency finding,
221	so building gcc will end up printing:
222	    checking dependency style of gcc... none
223	    configure: error: no usable dependency style found
224	Fix it by rebuilding and re-installing env.
225
22620101119:
227	Recent Xorg updates in xsrc/external/mit/ may cause various build
228	or run-time problems.  Delete your entire DESTDIR and OBJDIR if you
229	have any build problems with xsrc, or problems with mismatched
230	versions between xorg-server and drivers.
231
23220100604:
233	The update of ATF to 0.9 causes old tests written in shell to fail
234	unless they are rebuilt.  If you are building with MKUPDATE=yes,
235	you need to clean the src/external/bsd/atf/tests/ and the src/tests/
236	trees by hand.
237
23820100522:
239	Recent Xorg updates in xsrc/external/mit/ will cause various build
240	problems.  Delete your entire DESTDIR and OBJDIR if you have any
241	build problems with xsrc.
242
24320100522:
244	private section of <ctype.h> was splitted, and now mklocale(1)
245	include ctype_local.h, so you have to make cleandir in tools/mklocale.
246
24720100520:
248	The location of the xkb compiled descriptions has changed.  Please
249	remove usr/X11R7/lib/X11/xkb/compiled from your $DESTDIR.
250
25120100222:
252	The shared objects file extension has been changed from .so to
253	.pico, in order to avoid conflicts with shared libraries names
254	libXX.so.  All now stale regular .so files can be removed from
255	your object directories.
256
25720100204:
258	The termcap database has been removed from the sources,
259	but has not been marked obsolete so it is not removed
260	from the system when upgrading.
261	As such, you will need to remove them from your object
262	and destination directories.
263
26420091101:
265        After updating, it may be necessary to make the 'cleandir'
266        target in src/tools/yacc/ and in src/usr.bin/yacc/ before a
267        'build.sh -u tools' or 'build.sh -u distribution'.  Ditto
268        src/tools/lex/ and src/usr.bin/lex/.
269
27020091001:
271	On amd64 you must rebuild tools (to get the new binutils)
272	before building a kernel, or the build fails on cpufunc.S.
273
27420091001:
275	An error will create a ./usr/X11R7/lib/X11/xkb/compiled/xkb
276	symlink, failing the build.  Delete the link, and the subdir
277	it is in, and retry your build.
278
27920090718:
280	libc build changed so that strchr() provides the extra entry
281	point for index().  Update build of libc.a (and libc_pic.a)
282	may fail because the archive contains the unwanted index.o.
283	(Similarly for strrchr() and rindex().)
284
28520090709:
286	Native Xorg was upgraded again.  Builds will probably fail again
287	without a clean objdir, at least for src/external/mit/xorg.
288
28920090616:
290	Native Xorg was upgraded.  Builds will need a clean objdir for
291	src/external/mit/xorg.  Upgrading a system from sets will not
292	work properly yet as the /usr/X11R7/lib/X11/xkb/symbols/pc
293	subdirectory has been changed into a file, and this needs to
294	be manually "rm -r"'ed before installing xbase.tgz.
295
29620090501:
297	Several new functions were added to string.h/libc, and this
298	can cause autoconf problems during the tool build for people
299	who fail to clean out their tools objects properly.  If you
300	note messages about stpcpy, stpncpy or strnlen accompanying a
301	failure during the tool build, clean out all your tools
302	objects and start again.
303
30420090325:
305	The i386 port was switched to i486 default toolchain.  This requires
306	cleaning your src/tools directory and $TOOLDIR and rebuilding them.
307
30820090126:
309	The __posix_fadvise50 system call changed assembly stub type.  You
310	need to 'rm -f __posix_fadvise50.*' in the libc build directory
311	to avoid using the old assembly stub.
312
31320090202:
314	pkg_install now depends on the pkgdb cache for automatic conflict
315	detection.  It is recommented to rebuild the cache with
316	``pkg_admin rebuild''.
317
31820090110:
319	time_t and dev_t have been bumped to 64 bit quantities.  To upgrade:
320	1. Make sure your kernel has COMPAT_50 in it.  Build and install.
321	   This is needed even in the MODULAR kernel because there is
322	   conditionally compiled code in rtsock.c.
323	2. make sure build.sh completes and the binaries in a chroot work
324	   before installing.
325	3. If you don't use build.sh and you build directly to root, and
326	   your build breaks in the middle, don't despair.  Make sure headers
327	   are installed properly, and start building libraries first libc
328	   and libutil, install them and then continue building all the
329	   libraries in src/lib and src/gnu/lib and install them.  Once
330	   the new libraries are installed, you can restart the build.
331	4. If you compile packages and you notice link time warnings,
332	   rebuild the required packages to update their shared libraries.
333	   Any package you rebuild will require rebuilding all the packages
334	   that depend on it.
335	5. Next time you run pwd_mkdb with the new binary, the file
336	   will be upgraded and it will not be backwards compatible.
337	6. The utmpx/wtmpx files (/var/run/utmpx and /var/log/wtmpx, see
338	   lastlogx(5)) have been versioned, and there is a heuristic
339	   for utmp.  You are better off removing the old files after
340	   upgrading.  The automated clearing of /var/run during
341	   boot, and the automated rotating of files in /var/log by
342	   newsyslog(8), may mean that you do not have to remove the
343	   files manually.
344	7. The optional accounting file (/var/account/acct, see
345	   accton(8)) has not been versioned, and will need to be
346	   removed.  The automatic rotation of the accounting file by
347	   /etc/daily limits the bad consequences of failure to remove
348	   the file.
349	8. Application software that writes time_t to binary files on
350	   disk will break or need attention.  Most notably: if you are
351	   using PostgreSQL < 8.4, you need to dump your databases,
352	   rebuild PostgreSQL with the new time_t, then restore.
353
35420081219:
355	config(1) has been updated, and one of the files it creates -
356	swapnetbsd.o - has changed format.  You need to rebuild config
357	(done automatically by build.sh) and then you need to rerun
358	config on all kernel configuration files before rebuilding those
359	kernels.
360
36120081205:
362	If you build with MKX11=no, you should remove /etc/rc.d/xdm and
363	/etc/rc.d/xfs from DESTDIR because those files were moved to the xetc
364	set and will appear as extra files for MKX11=no update builds.
365
36620081122:
367	On i386, various kernel options(4) in GENERIC including
368	file systems have been disabled and moved into kernel modules.
369	Before trying a new GENERIC kernel, you have to prepare the
370	following files as well as a new GENERIC kernel:
371
372	- build and install kernel modules from src/sys/modules
373
374	- install the latest bootloader, which will load a module
375	  for the file system from which the kernel is loaded automatically
376
377	If you have to load your kernel from a file system which is not of
378	the same type as the root file system, you have to load the necessary
379	file system module manually on the boot prompt or in the boot.cfg file.
380
38120080827:
382	If you built and installed a libc from sources between
383	2008/08/20 and 2008/08/26 you got a broken strtouq(3)
384	which results in false errors reported by lint(1).
385	Since this breaks the libc build itself, manual help is
386	needed -- lint must be disabled temporarily, e.g.:
387	  $ (cd lib/libc && make MKLINT=no dependall install)
388
38920080813:
390	MKDEBUG build was broken because the .depend files did not know
391	about .go files.  You need to remove all .depend files and rebuild.
392
39320080802:
394	A regression in binary compatibility for pthread_mutex_t has
395	been fixed.  Unfortunately, the price is breaking compatibility
396	for -current.
397
398	Threaded programs (using libpthread) and C++ programs (using
399	libstdc++) compiled after 20070907 and before 20080802 need to
400	be recompiled.
401
402	One way to find affected pkgsrc packages:
403
404	  $ grep REQUIRES=/usr/lib/libpthread /var/db/pkg/*/+BUILD_INFO
405	  $ grep REQUIRES=/usr/lib/libstdc++ /var/db/pkg/*/+BUILD_INFO
406
40720080731:
408	WAPBL (metadata journaling support) has been added, but at this
409	time isn't backwards compatible with pre-WAPBL aware kernels
410	and userland (fsck_ffs in particular).  Please make sure you
411	don't use a journaled filesystem with an older kernel/userland,
412	especially an uncleanly mounted journaled filesystem.  WAPBL
413	also requires the super block to be in the UFS2 format.  You
414	can use fsck_ffs -c 4 to update the superblock format.
415
41620080721:
417	Assembler warnings are now fatal if $WARNS>0 and $NOGCCERROR
418	isn't defined.
419
42020080531:
421	The ioctl number of DRVSUSPENDDEV command on /dev/drvctl changed
422	from 125 (conflicted with DRVCTLCOMMAND) to 129.  The drvctl(8)
423	utility needs to be rebuilt and reinstalled as older binaries
424	won't work correctly.  The following sequence of commands:
425
426	  $ (cd sys/sys/ && nbmake-$arch includes)
427	  $ (cd sbin/drvctl/ && nbmake-$arch clean)
428	  $ (cd sbin/drvctl/ && nbmake-$arch all)
429
430	leaves new drvctl utility in sbin/drvctl build directory.
431
43220080503:
433	The <bsd.lib.mk> variable MKPRIVATELIB was renamed to LIBISPRIVATE.
434
43520080521:
436	For a while, unprivileged UPDATE builds would fail to
437	succeed at the checkflist stage, complaining that
438	${DESTDIR}/stand/<arch>/ did not exist.  A fix for this
439	problem was committed to share/mk/bsd.kmodule.mk, revision 1.9.
440	If you already hit this problem, update the .mk file,
441	remove ${DESTDIR}/stand/<arch>, and re-run the build.
442
44320080303:
444	Linker warnings are now fatal if $WARNS>0.
445
44620080126:
447	The posix_fadvise system call has been changed from an assembly
448	stub, to a c file that calls an assembly stub.  You need to
449	'rm -f posix_fadvise.* .depend' in the libc build directory to
450	avoid using the old assembly stub.
451
45220071209:
453	The acpiec(4) driver has been split into two attachments.  If you
454	get ACPI errors before the attachment, please update your kernel
455	configuration file appropriately or see GENERIC for more details.
456
45720071115:
458	The it(4) driver has been renamed to itesio(4) and the old port
459	argument specified in the kernel configuration file is not valid
460	anymore.  The itesio(4) driver now uses the Super I/O address port
461	rather than the EC address port.  Please update your kernel
462	configuration file appropriately or see GENERIC for more details.
463
46420071028:
465	The pccons(4) driver has been removed from the NetBSD/shark port.
466	You need to update any custom kernel configuration file you have
467	to remove any references to pccons (which includes removing the
468	now useless XSERVER option) and replace them with the correct
469	entries for the wscons driver.  See the GENERIC configuration file
470	for more details.
471
47220070913:
473	A latent bug in dhclient/dhcpd that caused it to be unable to
474	enumerate interfaces was fixed.  The bug began to cause
475	problems after 20070911 when the kernel's SIOCGIFCONF
476	implementation was repaired.  From 20070529 to 20070911 racoon
477	could not enumerate interfaces.  (These are noted because
478	normal kernel/userspace version matching hygiene is not
479	sufficient to avoid this problem.)  Ensure that both kernel
480	and userland are from after 20070913.
481
48220070703:
483	nbinstall has been renamed ${MACHINE_GNU_ARCH}-install.  It
484	calls the target-specific strip program, and the logic to pass
485	down STRIP from make has been removed.  This requires a
486	re-installation of tools.
487
48820070422:
489	The way OS emulations lookup filenames inside the emulation root
490	has been changed.  Rather than modify the pathname (and copy back
491	to userspace) namei() and lookup() directly check the emulation
492	root.  One side effect is that absolute symlinks inside the emulated
493	root file system will be relative to that file system - unless they
494	start /../ this is useful when the emulated root is a real install
495	that has such links.
496	This might affect symlinks that have been added to reference outside
497	the emulated root.
498
49920070412:
500	The pckbc driver on sgimips IP32 has been removed.  Use macekbc
501	instead.  See the GENERIC32_IP3x kernel configuration for an
502	example.
503
50420070319:
505        src/lib/libc/Makefile revision 1.129 broke libc and ld.elf_so
506        on many platforms due to incorrect flags settings.  If you
507        updated and built after about 20070315, do "nbmake-$arch
508	cleandir" in src/lib/libc and src/libexec/ld.elf_so to force a
509	rebuild of object files that might have been built
510	incorrectly, and ensure that you have at least
511	src/lib/libc/Makefile 1.130.
512
51320070210:
514        src/sys/sys/{sa.h,savar.h} were removed.
515          find ${OBJDIR} \( -name .depend -o -name '*.d' \) -print \
516              | xargs egrep -l '/sa.h|/savar.h' | xargs rm
517        will allow dependencies on those files to get get rebuilt
518
51920070209:
520        The threading model was changed when the newlock2 branch
521        was merged to NetBSD-current.  If you boot with a new
522        kernel (version 4.99.10), then you also need a new pthread
523        library (/usr/lib/libpthread.so.0.7).  If you boot with
524        an old kernel, then you need the old pthread library
525        (/usr/lib/libpthread.so.0.6).  Provided you keep the kernel and
526        the pthread library in sync, old threaded applications should
527        continue to work with an old or new kernel.  Note that named(8)
528	is the only threaded application in the base system.
529
53020061214:
531	Following the move of string_to_flags() and flags_to_string()
532	from the bin/ls/ sources to libutil, users doing UPDATE builds
533	will need to do a "make cleandir" in
534		tools/mtree/, tools/makefs/, tools/binstall/, tools/pax/,
535		bin/pax/, bin/ls/, usr.sbin/mtree/, usr.sbin/makefs/,
536		usr.bin/xinstall/, libexec/ftpd/, rescue/, as well
537		as the installation images in distrib/
538	in order to excise stale references to the old stat_flags.h header
539	file in the ls sources -- stat_flags.h has been removed.
540
54120061108:
542	The configure script used in the src/tools/gcc compiler has been
543	changed to indicate that our libc has ssp support built-in and
544	does not depend on -lssp and -lssp-nonshared.  You'll need to
545	make clean in src/tools/gcc first to rebuild the compiler.
546
54720061009:
548	The sysctl variables net.inet{,6}.tcp{,6}.newreno are no longer
549	available.  Use net.inet{,6}.tcp{,6}.congctl.selected instead.
550
55120060814:
552	The vt, vidcconsole, kbd, and rpckbd drivers on acorn32 have been
553	withdrawn.  Use vidcvideo and pckbd instead.  See the GENERIC
554	kernel configuration for an example.  X servers from the last
555	few years should cope.
556
55720060703:
558	MPACPI is no more.  We always configure PCI interrupts using ACPI
559	if we have an ACPI kernel.  The option MPACPI_SCANPCI has been renamed
560	to ACPI_SCANPCI.  Thanks to work from fvdl.
561
56220060627:
563	socket(2) has changed, and its system call has been versioned.
564	For userlands with the old version of socket(2), make sure that
565	your kernel has 'options COMPAT_30' set, or else 'bad system call'
566	errors will result.
567
568Hints for a more successful build:
569^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
570    Use build.sh, but do not use its "expert mode":
571	This will automatically build the tools in the
572	   correct order, and it will keep the tools and the
573	   new build products from interfering with the running
574	   system.  This will allow you to ignore most of the
575	   other advice in this file.
576    Build a new kernel first:
577	This makes sure that any new system calls or features
578	   expected by the new userland will be present.  This
579	   helps to avoid critical errors when upgrading.
580    Use object directories:
581	This helps to keep stale object
582	   files from polluting the build if a Makefile "forgets"
583	   about one.  It also makes it easier to clean up after
584	   a build.  It's also necessary if you want to use the
585	   same source tree for multiple machines.
586	   To use object directories with build.sh:
587	    a) invoke build.sh with the "-M" or "-O" options.
588	   To use object directories without using build.sh:
589	    a) cd /usr/src ; make cleandir
590	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
591	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
592	    d) cd /usr/src ; make build
593	   Note that running "make obj" in a directory will create
594	   in obj.$MACHINE directory.
595    Build to a DESTDIR:
596	This helps to keep old installed files (especially libraries)
597	   from interfering with the new build.
598	   To build to a DESTDIR with build.sh, use the "-D" option.
599	   To build to a DESTDIR without using build.sh, set the DESTDIR
600	   environment variable before running make build.  It should be
601	   set to the pathname of an initially empty directory.
602	   Problems: if you do not use build.sh, you might need to
603		update critical utilities without using DESTDIR since
604		nothing is executed from what is installed in DESTDIR.
605		(See critical utils, below.)
606    Build often:
607	This keeps critical utilities current enough to not choke
608	on any other part of the source tree that depends on up to
609	date functionality.  If you use build.sh, you should not have
610	this problem.
611
612What to do if things don't work:
613^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
614When things don't work there are usually a few things that commonly
615should be done.
616    1)	make includes
617	This should be done automatically by make build.
618    2)  cd share/mk && make install
619	Again, automatically done by make build.
620
621Failsafe rebuild of a small part of the tree:
622^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
623To make sure you rebuild something correctly you want to do
624something like the following:
625    1)  Make sure the includes and .mk files are up to date.
626    2)  Make sure any program used to build the particular
627	utility is up to date.  (yacc, lex, etc...)
628    3)  cd ...path/to/util...
629	make cleandir
630	rm ...all obj directories...
631	make cleandir			# yes, again
632	make obj
633	make depend && make
634
635Failsafe rebuild of the entire tree:
636^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
637If you really want to make sure the source tree is clean and
638ready for a build try the following.  Note that sourcing /etc/mk.conf
639(a make(1) Makefile) in this manner is not right, and will not work
640for anyone who uses any make(1) features in /etc/mk.conf.
641
642---cut here---
643#!/bin/sh
644. /etc/mk.conf
645
646if [ -z $NETBSDSRCDIR ] ; then
647    NETBSDSRCDIR=/usr/src
648fi
649if [ \! -d $NETBSDSRCDIR ] ; then
650    echo Unable to find sources
651    exit 1
652fi
653find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
654
655if [ -z $BSDOBJDIR ] ; then
656    BSDOBJDIR=/usr/obj
657fi
658if [ -d $BSDOBJDIR ] ; then
659    rm -rf $BSDOBJDIR
660fi
661
662cd $NETBSDSRCDIR && make cleandir
663
664---cut here---
665
666Critical utilities:
667^^^^^^^^^^^^^^^^^^^
668	usr.bin/compile_et
669	usr.bin/make
670	usr.bin/yacc
671	usr.bin/lex
672	usr.bin/xlint
673	usr.bin/config
674
675Other problems and possible solutions:
676^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
677Symptom:Complaints involving a Makefile.
678Fix:	Rebuild usr.bin/make:
679	cd usr.bin/make && make && make install
680	Or, a failsafe method if that doesn't work:
681	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
682
683Fix:	Make sure .mk files are up to date.
684	cd share/mk && make install
685
686Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
687Fix:	Rebuild usr.bin/config
688
689Symptom:
690Fix:	Rebuild usr.bin/yacc
691
692Symptom:
693Fix:	Rebuild usr.bin/lex
694
695Symptom:
696Fix:	rm /usr/lib/libbfd.a
697
698Symptom:Obsolete intermediate files are used during compilation
699Fix:	Try the following sequence of commands in the directory in question.
700	make cleandir; rm `make print-objdir`; make cleandir; make obj
701	(If you built the tree without "make obj" in the past, obsolete files
702	may remain.  The command tries to clean everything up)
703
704Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible
705	pointer type
706Fix:	Rebuild and install usr.bin/menuc
707
708Symptom:mklocale not found during build in share/locale/ctype
709Fix:	Build and install usr.bin/mklocale
710
711Symptom:undefined reference to `__assert13' or `__unsetenv13'
712Fix:    Rebuild and install lib/libc
713
714Symptom:usr.bin/config fails to build.
715Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
716
717Symptom:undefined reference to `getprogname' or `setprogname'
718Fix:    Rebuild and install lib/libc
719
720Symptom:lint does not understand the '-X' option
721Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
722
723Symptom:Update build fails in src/tools/gcc complaining that a variable
724	(e.g. CPPFLAGS) has changed since the previous run.
725Fix:    Run "nbmake-${ARCH} clean" in src/tools/gcc or do a clean build.
726
727Symptom:cvs [update aborted]: cannot open directory /cvsroot/src/...:
728	No such file or directory.
729Cause:	If a directory is created by mistake, then it is sometimes
730	deleted from the CVS repository using administrative commands
731	that bypass the normal cvs access controls.  If your cvs working tree
732	contains references to a directory that has been deleted on the
733	server in this way, then "cvs update" reports this error.
734Fix:	Recursively delete the affected directory from your working tree
735	and try the update again.
736