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