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