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