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