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