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