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