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