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