UPDATING revision 1.133
1$NetBSD: UPDATING,v 1.133 2005/01/06 23:28:56 christos Exp $
2
3This file (UPDATING) is intended to be a brief reference to recent
4changes that might cause problems in the build process, and a guide for
5what to do if something doesn't work.
6
7For a more detailed description of the recommended way to build NetBSD
8using build.sh, see the BUILDING file.
9
10Note that much of the advice in this UPDATING file was written before
11build.sh existed.  Nevertheless, the advice here may be useful for
12working around specific problems with build.sh.
13
14See also: BUILDING, build.sh, Makefile.
15
16Recent changes:
17^^^^^^^^^^^^^^^
1820041229:
19	Make had a path resolution bug that manifested itself as not
20	being able to install openpam.3. This bug has been fixed, but
21	you might need to rebuild make manually first to get through
22	the build.
23
2420041201:
25	Userland programs have been changed to use /dev/bpf instead of
26	/dev/bpfX. You need to create that device by installing a new
27	MAKEDEV and running it, or mv /dev/bpf0 /dev/bpf && rm /dev/bpf[0-9]*
28
2920041006:
30
31	A bug was introduced into /bin/sh (var.c rev 1.35) which causes
32	variables to not export correctly to subshells in all cases. This
33	will cause builds to break if that version of /bin/sh is installed
34	on the system. The proper version of /bin/sh can be verified with:
35
36        ident /bin/sh | grep var
37
38	Any /bin/sh w. version 1.35 will not work and needs to be updated
39	before attempting a build.
40	
4120041001:
42	The ipfilter kernel sources moved from sys/netinet to
43	dist/sys/ipf/netinet. Due to the move some Makefile
44	dependencies are now dangling requiring a make cleandir
45	before they work again (kdump, ktruss, rescue, ipf, and
46	ftp-proxy are the victims).
47
4820040715:
49	The rc.d/sendmail script now uses a heuristic to determine
50	if sendmail should be started at boot time.  It checks the
51	contents of /etc/mailer.conf, /etc/mail/submit.cf, and the
52	owner and mode of the sendmail binary to see if any changes
53	to the mail infrastructure have been made.  If no changes
54	are detected, it will start an SMTP listener.
55
56	Setting sendmail=NO in /etc/rc.conf will override this.
57
58	If you are only using sendmail by default and only for
59	local delivery, it is important that you also update your
60	sendmail.cf so that the SMTP listener only listens on the
61	loopback interface.
62
6320040715:
64	The method by which athhal-elf.o gets pulled into i386
65	kernel builds has been changed again.  The latest version
66	of bsd.files.mk is no longer required.
67
6820040621:
69	Due to the recent rototill of tools/compat it's crucial one starts
70	from a clean objdir under tools/*.
71
72	This is mostly due to generated files (yacc and lex sources) needing
73	to be generated with new rules from bsd.hostprog.mk.
74
75	The safest course is to rm -rf all objects under tools before building.
76
7720040516:
78	The end-user modifiable X11 configuration has been moved
79	from /usr/X11R6/lib/X11/<dir> to /etc/X11/<dir>.
80	Ensure that src and xsrc is up to date, and run
81	"make cleandir" in src/x11 before your next build.
82
83	postinstall currently doesn't migrate the files from
84	/usr/X11R6/lib/X11/* to /etc/X11/* although it does
85	detect that this needs to occur, so you'll have to
86	manually move these files yourself.
87
8820040426:
89	Support for the original dynamic sysctl node structure has
90	been removed in favor of the newer layout.  This affects
91	consumers of the create and delete interface, as well as
92	the dynamic discovery mechanism.  This is believed only to
93	be the sysctl(8) binary itself, at this point in time, so
94	the only effect of this should be that a sysctl binary
95	built from sources dated between 2003/12/04 and 2004/03/24
96	will not work on a kernel built from sources dated after
97	2004/04/25.  If you need a new sysctl binary but build.sh
98	does not work, make sure that your revision of
99	src/sys/sys/sysctl.h is 1.112 (or later), and then the
100	do the following:
101
102	cd /usr/src (or wherever your source tree is)
103	make USETOOLS=no includes
104	cd lib/libc
105	make USETOOLS=no dependall install
106	cd ../../sbin/sysctl
107	make USETOOLS=no dependall install
108
109	If you are using older sysctl binary, GNU autoconf would fail to
110	identify your machine architecture, and tries to build binary for
111	"unknown-unknown-netbsd20F" or something like that.  if that happens,
112	make sure to follow the above steps.
113
11420040425:
115	The ffs superblock issues listed below under 20040109 and 20030402
116	are now automatically addressed by the /etc/rc.d/fixsb script or by
117	sysinst when it checks a a filesystem. The manual fsck_ffs -b16 -c4
118	invocation mentioned below will continue to work and is now
119	automated by those scripts.  Note that under certain circumstances,
120	affected filesystems upgraded to a -current kernel first before
121	upgrading their userland with the fixsb and fsck_ffs fixes may
122	encounter a 'freeing free inode' panic when writing to the affected
123	filesystem, so it is a good idea to repair the filesystem as soon as
124	possible.  For more details on the fixsb script, see pr install/25138.
125
12620040418:
127	statfs(2) and friends have been replaced with statvfs(2). Before
128	installing a newly build userland make sure that you are running
129	a newly built kernel with COMPAT_20 set. In addition your libc
130	build might not work (undefined SYS_statfs symbol) because make
131	clean does not know how to remove files it does not know about
132	anymore. Manually remove all generated .S sources and objects
133	from the libc build directory.
134
13520040326:
136	The method by which athhal-elf.o gets pulled into i386 kernel builds
137	has been changed. The file is now stored as a uuencoded file in CVS
138	and the generated Makefile will use the new .uue rules from bsd.file.mk
139	to build it.
140
141	This means you must have the latest bsd.files.mk installed when
142	building a kernel without USETOOLS=yes.
143
14420040318:
145	A bug in the cgd(4) blowfish code was corrected, without
146	provision of backwards compatibility, after several public
147	notices over several months. Users of cgd with blowfish cipher
148	ONLY must dump their data before updating their kernels, and
149	recreate cgd's and restore data using the new kernel. See
150	(recent message to current-users, URL when mail-index has updated)
151
15220040313:
153	On acorn32, the opms and qms drivers have been withdrawn, and
154	the old wsqms driver is now called qms.  Kernel config files
155	will need updating.  See the ones in sys/arch/acorn32/conf
156	for examples.
157
15820040125:
159	On acorn32, the beep and sysbeep devices are no longer
160	needed, and will need to be deleted from kernel configuration
161	files.
162
16320040109:
164	Compatibility for old ffs superblock layouts has been
165	added, and the restrictive fsck checks have been reenabled
166	when using those layouts.  If you have been using -current
167	since 20030402, you may find that fsck again signals fatal
168	superblock mismatches.  To repair, make sure you have
169	an updated fsck_ffs and then you can use fsck_ffs -b 16 -c 4
170	to complete the filesystem upgrade.  A message has
171	been added to the kernel which should detect this problem.
172	See the following discussion for more information:
173	http://mail-index.NetBSD.org/current-users/2004/01/11/0022.html
174
17520031203:
176	New binutils builds may fail due to old dependencies.
177	It's necessary to "make cleandir" to ensure that
178	the dependencies will be rebuilt correctly.
179
18020031111:
181	A newer mkdep is needed.  Error noting that is
182		cc: Ambiguous abbreviation --
183
18420031008:
185	/usr/include/sys/disklabel_mbr.h was removed.
186	It's necessary to "make cleandir" to ensure that
187	the dependencies will be rebuilt correctly.
188
18920031007:
190	A sign exension bug was fixed which set all the high bits
191	of our newly expanded ffs fs_flags.  This should only
192	affect users who installed or upgraded in September of 2003.
193	A small utility program was posted to tech-kern which
194	should fix this problem, and a warning message was added
195	to the kernel which should discover and warn about it.  See
196	http://mail-index.NetBSD.org/tech-kern/2003/10/07/0005.html
197
19820030906:
199	With the addition of siginfo support the old signal trampoline
200	code has been deprecated to COMPAT_16. Make sure that your running
201	kernel has COMPAT_16 enabled before building userland.
202
20320030801:
204	With the new openssl, there is some header and library shuffling.
205	rm -f /usr/include/des.h /usr/include/kerberosIV/* /lib/libdes* \
206	/usr/lib/libdes* before building.
207
20820030703:
209	Texinfo was updated to 4.6.  To avoid failures when trying to
210	build the included texinfo files, do:
211
212	cd src/gnu/usr.bin/texinfo
213	make MKINFO=no dependall install
214
21520030630:
216	Groff was updated to 1.19; it's probably necessary to do
217		cd share/mk && make install
218		cd src/gnu/usr.bin/groff
219		make MKMAN=no dependall install
220	(untested).
221
22220030516:
223	Due to bugs in the export handling code, invalid export lines
224	were accepted before and caused the kernel to panic when
225	mountd got restarted because it freed memory that had already
226	been freed. This has been fixed and the kernel checks
227	export addresses very strictly. If you upgrade your kernel,
228	make sure you also upgrade mountd, because if your export
229	file contains lines with an old inet4 address syntax (i.e.
230	a.b.c or a.b or a), they will get rejected by the new kernel.
231
23220030402:
233	The superblock layout for FFS was changed.  If you have 1.6
234	fsck binaries, they will signal a fatal superblock mismatch
235	with the first alternate, because they compare too many
236	fields (even ones that aren't useful).  If possible, upgrade
237	your fsck_ffs binary before using a new kernel.
238	None of this signals actual filesystem damage.
239
24020030324:
241	sendmail version 8.12.8 was imported.  Since sendmail is
242	now setgid to the smmsp group, and runs in "collection"
243	mode for most common activities, there is a new config
244	file called submit.cf that needs to live in /etc/mail.
245	The generic submit.cf sample in /usr/share/sendmail/cf
246	is named netbsd-msp.cf.  Upgrading your regular sendmail
247	configuration file is also strongly advised.
248
249	See the section named "MESSAGE SUBMISSION PROGRAM" in
250	the updated /usr/share/sendmail/README file for more
251	information.
252
25320030117:
254	Texinfo was updated to 4.3.  To avoid failures when trying to
255	build the included texinfo files, do:
256
257	cd src/gnu/usr.bin/texinfo
258	make MKINFO=no dependall install
259
26020021223:
261	The METALOG format changed slightly, to remove the leading
262	"${DESTDIR}" from path names.
263	This only affects people building with UNPRIVED.
264	For complete safety, remove the DESTDIR entirely and
265	update tools/mtree, before running make build.
266
26720021219:
268	CVS repository layout was changed.  See the following for details
269	if you are using (anonymous) cvs to update your tree.
270
271	http://mail-index.NetBSD.org/netbsd-announce/2002/12/19/0000.html
272
27320021219:
274	install(1) had a '-N dbdir' option added, to specify an
275	alternate location to look up users & groups (instead
276	of the host system passwd(5) and group(5) databases).
277
278	The build system was modified to take advantage of
279	this option (using ${NETBSDSRCDIR}/etc), so if you
280	use USETOOLS==no, you may have to rebuild and
281	reinstall usr.bin/xinstall first.
282
28320021130:
284	fparseln(3) moved from libutil to libc.
285	If building to DESTDIR=/, reinstall the includes
286	and rebuild libc:
287		make includes
288		make do-lib-libc
289	If using build.sh, "cd tools/compat && make clean"
290	before rebuilding the tools.
291
29220021126:
293	The mk.conf(5) variable SYS_INCLUDE has been deprecated,
294	including the optional "SYS_INCLUDE=symlinks" support.
295	All header files, including <sys/*.h> are copied into
296	/usr/include.
297
29820021121:
299	The C run-time support files crtbegin.o and crtend.o
300	(and their companions crtbeginS.o and crtendS.o) were
301	split up, with new crti.o and crtn.o files resulting.
302	This means that libtool needs to be rebuilt once the
303	new libraries are installed.  The process of rebuilding
304	libtool will cause it to automatically notice the new
305	required files, but it *must* be rebuilt in order to
306	do this.
307
308	An out-of-date libtool will result in shared libraries
309	which lack _init() and _fini() routines, which means that
310	their global contructors/destructors will not be invoked.
311
31220021121:
313	A bug related to how ARM ELF objects were tagged has been
314	corrected.
315
316	NetBSD ARM ELF uses the soft-VFP floating point model by
317	default.  However, the assembler lacked support for marking
318	objects as using the VFP floating point format, and the
319	compiler was not properly passing the flag indicating "soft-VFP"
320	to the assembler.
321
322	Unfortunately, this means that the linker will now consider
323	old (i.e. not marked "softvfp") NetBSD ARM ELF objects to be
324	incompatible with new (properly marked) objects.
325
326	The problem will only manifest itself if you attempt to compile
327	a new program using the fixed toolchain, and link that program
328	against old libraries which do not have the proper "softvfp"
329	markings.  ALL OF YOUR EXISTING BINARIES AND SHARED LIBRARIES
330	WILL CONTINUE TO WORK PROPERLY.
331
332	The only work-around for the problem is to recompile all of
333	the libraries on the system.  The easiest way to do this for
334	system libraries is to install a binary snapshot; they are
335	generally available on releng.NetBSD.org.  Any packages you
336	have installed which supply libraries will have to be recompiled
337	if you wish to link new programs against those libraries.
338
339	If you have questions about this matter, please contact
340	port-arm@NetBSD.org.
341
34220021011:
343	Systrace has been improved to support privilege elevation.
344	Updating the kernel requires the userland part of systrace
345	to be rebuilt.
346
34720021010:
348	The config(8) grammar was changed to allow options to register
349	dependencies on attributes, as well as other options.  Users
350	must update and reinstall usr.sbin/config before building a new
351	kernel.
352
35320021009:
354	A new attribute dependency syntax was introduced to config(8),
355	which is now used by the SCSI configuration description.  Users
356	must update and reinstall usr.sbin/config before building a new
357	kernel.
358
35920021003:
360	Several changes have been made to the autoconfiguration
361	framework.  Users must update and reinstall usr.sbin/config
362	before building a new kernel.
363
36420021001:
365	The i386mp branch has been merged.  To compile a kernel, users
366	will need to add the option 'cpu* at mainbus?' to their configuration
367	file.  Multiprocessor kernels will need
368	ioapic*		at mainbus? apid ?
369	options		MULTIPROCESSOR
370	options		COM_MPLOCK
371
37220020922:
373	MKDYNAMICROOT=yes enabled by default, which means that
374	certain shared libraries are installed into /lib, the shared
375	linker is installed into /libexec, and all programs in /bin
376	and /sbin are dynamically linked.
377	If you do not use "make build", you should ensure that
378	you have the libraries and shared linker in the new locations,
379	with:
380		make do-lib-csu do-lib-libc do-lib do-gnu-lib do-ld.elf_so
381
38220020917:
383	USE_NEW_TOOLCHAIN has been replaced with:
384	    -	TOOLCHAIN_MISSING -- set to "yes" on platforms for which
385		there is no working in-tree toolchain (hppa, ns32k, sh5,
386		x86_64).
387	    -	EXTERNAL_TOOLCHAIN -- if defined by the user, points to the
388		root of an external toolchain (e.g. /usr/local/gnu).  This
389		enables the cross-build framework even for TOOLCHAIN_MISSING
390		platforms.
391
39220020906:
393	gehenna-devsw has been merged into the trunk. Need to update and
394	reinstall usr.sbin/config before building the kernel.
395
39620020822:
397	Crunched rescue tools (contents of /bin and /sbin, plus others)
398	are now provided in /rescue.
399
400	To ensure that these are built statically linked (no matter
401	what the setting of LDSTATIC is), use a crunchgen(1) built
402	from sources newer than 20020820 (see the next entry).
403
40420020820:
405	crunchgen(1) changed to ensure that the generated program
406	is statically linked.
407
408	Solution: update and reinstall usr.bin/crunch
409
41020020605:
411	smmsp user/group has been added for sendmail.
412
413	Add the following into /etc/group:
414
415	smmsp:*:17:
416
417	and the following to /etc/master.passwd (via vipw):
418
419	smmsp:*:17:17::0:0:Sendmail Message Submission Program:/nonexistent:/sbin/nologin
420
42120020515:
422	sshd user/group has been added.  Need to hand add this in, or sshd
423	will not let you log in (with default, or UsePrivlegeSeparation=yes)
424
425	Add the following into /etc/group:
426
427	sshd:*:16:
428
429	and the following to /etc/master.passwd (via vipw):
430
431	sshd:*:16:16::0:0:& pseudo-user:/var/chroot/sshd:/sbin/nologin
432	
433	Also /var/chroot/sshd directory needs to be present (digged as part of
434	the build process).
435
43620020426:
437	NBUILDJOBS obsoleted in favor of just using -j.
438
43920020426:
440	etc/postinstall added, which performs various checks for 
441	configuration file updates and changes, and can fix most of
442	the problems identified.
443	This should make it much easier to upgrade a system's
444	configuration from earlier systems (as far back as NetBSD 1.5).
445
44620020320:
447	<bsd.lib.mk> needs a new install(1) for its "-a cmd" support.
448	Build and install at usr.bin/xinstall before the build.
449
45020020319:
451	Raw IPv6 socket now makes strict checking for sa_family and sa_len
452	on send(2) operation.  Be sure to have sbin/rtsol and usr.sbin/rtsold
453	newer than November 2001 when you upgrade the kernel.
454
45520020311:
456	ssh configuration files were moved from /etc to /etc/ssh.  Beware
457	if you restart your machine from remote.  Note that sshd.conf needs
458	to be changed (due to the use of "/etc" inside).
459
46020020223:
461	Users of the VAX port will need to rebuild and install gas
462	so it deal with the now present register prefix used in all
463	the VAX assembly files.
464
46520020118:
466	ntpd user/group has been added.  Need to hand add this in or builds
467	will break as mtree aborts early.
468
469	Add the following into /etc/group:
470
471	ntpd:*:15:
472
473	and the following to /etc/master.passwd (via vipw):
474
475	ntpd:*:15:15::0:0:Ntpd pseudo-user:/var/chroot/ntpd:/sbin/nologin
476
47720011207:
478	If you're attempting to build a snapshot on sparc64 and are getting
479	reloc errors from the toolchain groff binary this means your native
480	toolchain has some broken C++ bits.
481
482	To fix:
483
484	Build a new toolchain (i.e. build.sh -t)
485	Use the new toolchain to build and install natively (i.e. /usr/lib)
486
487	gnu/lib/libgcc
488	gnu/lib/libstdc++
489
490	After this a snapshot will be able to be built.
491
49220011201:
493	In order for a sparc64 build to work you must have a working awk. If
494	you've built and installed a system with the new toolchain up to this
495	point you do not have a working awk as its ability to do floating
496	point is broken. 
497
498	To build:
499
500	remake and install gnu/lib/libgcc
501	remake and install gnu/usr.bin/gawk into /usr/bin (make sure it links
502	against the new libgcc.a)
503
50420011128:
505	Kernel config information was changed to use defflag in
506	the various "files" files.  Bug fixes to config(8) are
507	required in order for this to work properly.  Make sure
508	to build and install in usr.sbin/config before attempting
509	to build a new kernel.
510
51120011030:
512	libc/locale/wcstod.c now needs new lint(1). Update lint(1)
513	before building libc.
514
51520011029:
516	The new document BUILDING.mdoc (view with nroff | more, or
517	see pre-generated .txt and .html versions) describes the build
518	procedure in great detail.  BUILDING, and the USE_NEW_TOOLCHAIN
519	build process, are intended in the long run to replace this
520	manual update log.
521
522	Users building a USE_NEW_TOOLCHAIN system should read the
523	BUILDING document for caveats.  Generally, BUILDING supersedes
524	UPDATING for these systems, as tool updating is taken care of
525	by the new build system.
526
52720011028:
528	src/etc/Makefile now needs install to be able to handle
529	symlinks that point to nowhere. A bug in install that
530	prevented this was corrected.
531
532	Solution: update and reinstall usr.bin/xinstall
533	Better Solution: Use the new toolchain and it will just work
534	for you.
535
53620011006:
537	/etc/mtree/NetBSD.dist has been updated to take advantage of
538	absolute path support added to mtree(8). Older mtree(8)s don't
539	understand the format.
540
541	Solution: update and reinstall usr.sbin/mtree
542
54320011004:
544	Crunchgen has been updated to work via reach-over makefiles. Updating
545	is suggested before running a snapshot build
546
54720010915:
548	The new "ubcperf" code committed by Chuck Silvers removed
549	a header file, uvm/uvm_vnode.h.  There may be stale .depend
550	files that still reference this file.
551
552	Solution: "make cleandir && make dependall" in affected
553	directories.
554
55520010803:
556	grep.info is now built from grep.texi using makeinfo.  Since it
557	requires makeinfo v4.0, you need to install new texinfo before
558	building gnu/usr.bin/grep.  To install new texinfo, please follow
559	the instruction described in 20010726 entry.
560
56120010803: 
562	(i386 only): i386 kernel now uses new instructions like
563	`fxsave' which old gas doesn't understand.  To build the
564	kernel successfully, you need to build and install a new toolchain, 
565	(i.e., build.sh -t) or 	(temporarily) comment out "options I686_CPU" 
566	from your kernel configuration until you rebuild your userland.
567	See 20011029 above and BUILDING file in this directory for more information.
568	[updated 20020630 since i386 gas moved when USE_NEW_TOOLCHAIN enabled]
569
57020010731:
571	Bootloader update on ELF platforms.  DDB in kernels from before
572	this will be unable to read symbol tables provided by newer
573	bootloaders.
574
57520010726:
576	Texinfo was updated to 4.0.  To avoid failures when trying to
577	build the included texinfo files, do:
578
579	cd src/gnu/usr.bin/texinfo
580	make MKINFO=no dependall install
581
58220010718:
583	Enabled correct .init/.fini processing in crt0.  The way this
584	was done was to change a -I directive to cc(1), which means
585	make(1) will have a stale dependency (it will be checking the
586	timestamp on the wrong "dot_init.h").
587
588	The symptom you will see is that new programs die with SIGSEGV
589	if you have a stale dependency.
590
591	Solution: "make cleandir" in both lib/csu and libexec/ld.elf_so
592	before starting your build.
593
59420010628:
595	A construct was added to uvm_page.h that uncovered a bug
596	in lint(1).  If you get a warning/error about a non-portable
597	bitfield, update your lint(1) before proceeding.
598
59920010226:
600	Added named user/group to system. Need to hand add this in or builds
601	will break as mtree aborts early.
602
603	To work around add by hand:
604
605	named:*:14:
606
607	to /etc/group and add:
608
609	named:*:14:14::0:0:Named pseudo-user:/var/named:/sbin/nologin
610
611	to master.passwd (use vipw for instance if doing by hand).
612
613	Now a make build should progress.
614
61520010219:
616	get/setprogname() added. Any hostprogs that may use this will need
617	to be bootstrapped manually until the host system is current.
618
619	Known problems: sys/arch/macppc/stand/fixcoff
620			usr.sbin/config (adding -DMAKE_BOOTSTRAP to
621			  CFLAGS and rebuilding should work)
622			usr.sbin/mdsetimage - Build a static copy if
623			  building a snapshot before fully bootstrapped.
624
62520010204:
626	prepare the code to compile with stricter gcc flags. in
627	particular start eliminating redundant declarations. Yacc
628	needs to be installed before make build.
629
63020010114:
631	introduce .if commands(target) in make(1). You need to
632	bring everything up-to-date first, then without installing
633	anything make and install in usr.bin/make, then proceed
634	with make build.
635
63620010101:
637	bsd.subdir.mk committed 20001230 had a bug which caused
638	afterinstall targets to run too soon; update again.
639
64020001230:
641	New share/mk files needed to support .WAIT in SUBDIR variables.
642	If you get make errors, 
643		(cd share/mk; make install)
644	Also, PRINTOBJDIR has changed and is now used more heavily.
645
64620001019:
647	The `ca' device driver has been replaced by `ld'; although the
648	major and minor numbers haven't changed, you should update your /dev
649	directory.
650
65120000929:
652	The following make directives are obsoleted.
653	MKCRYPTO_RSA NOCRYPTO_RSA NOCRYPTO_RC5 NOCRYPTO_IDEA 
654	By default, RSA is built into libcrypto.  IDEA and RC5 will not be
655	built into libcrypto.  By using MKCRYPTO_{RC5,IDEA}, you can build
656	additional library libcrypto_{idea,rc5}.
657
658
659Hints for a more successful build:
660^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
661    Use build.sh, but do not use its "expert mode":
662	This will automatically build the tools in the
663	   correct order, and it will keep the tools and the
664	   new build products from interfering with the running
665	   system.  This will allow you to ignore most of the
666	   other advice in this file.
667    Build a new kernel first:
668	This makes sure that any new system calls or features
669	   expected by the new userland will be present.  This
670	   helps to avoid critical errors when upgrading.
671    Use object directories:
672	This helps to keep stale object
673	   files from polluting the build if a Makefile "forgets"
674	   about one.  It also makes it easier to clean up after
675	   a build.  It's also necessary if you want to use the
676	   same source tree for multiple machines.
677	   To use object directories with build.sh:
678	    a) invoke build.sh with the "-M" or "-O" options.
679	   To use object directories without using build.sh:
680	    a) cd /usr/src ; make cleandir
681	    b) Add "OBJMACHINE=yes" to /etc/mk.conf
682	    c) Add "MKOBJDIRS=yes" to /etc/mk.conf
683	    d) cd /usr/src ; make build
684	   Note that running "make obj" in a directory will create
685	   in obj.$MACHINE directory.
686    Build to a DESTDIR:
687	This helps to keep old installed files (especially libraries)
688	   from interfering with the new build.
689	   To build to a DESTDIR with build.sh, use the "-D" option.
690	   To build to a DESTDIR without using build.sh, set the DESTDIR
691	   environment variable before running make build.  It should be
692	   set to the pathname of an initially empty directory.
693	   Problems: if you do not use build.sh, you might need to
694		update critical utilities without using DESTDIR since
695		nothing is executed from what is installed in DESTDIR.
696		(See critical utils, below.)
697    Build often:
698	This keeps critical utilities current enough to not choke
699	on any other part of the source tree that depends on up to
700	date functionality.  If you use build.sh, you should not have
701	this problem.
702 
703What to do if things don't work:
704^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
705When things don't work there is usually a few things that commonly
706should be done.
707    1)	make includes
708	This should be done automatically by make build.
709    2)  cd share/mk && make install
710	Again, automatically done by make build.
711
712Failsafe rebuild of a small part of the tree:
713^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
714To make sure you rebuild something correctly you want to do
715something like the following:
716    1)  Make sure the includes and .mk files are up to date.
717    2)  Make sure any program used to build the particular
718	utility is up to date.  (yacc, lex, etc...)
719    3)  cd ...path/to/util...
720	make cleandir
721	rm ...all obj directories...
722	make cleandir			# yes, again
723	make obj
724	make depend && make
725
726Failsafe rebuild of the entire tree:
727^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
728If you really want to make sure the source tree is clean and
729ready for a build try the following.  Note that sourcing /etc/mk.conf
730(a make(1) Makefile) in this manner is not right, and will not work
731for anyone who uses any make(1) features in /etc/mk.conf.
732
733---cut here---
734#!/bin/sh
735. /etc/mk.conf
736
737if [ -z $NETBSDSRCDIR ] ; then
738    NETBSDSRCDIR=/usr/src
739fi
740if [ \! -d $NETBSDSRCDIR ] ; then
741    echo Unable to find sources
742    exit 1
743fi
744find $NETBSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
745
746if [ -z $BSDOBJDIR ] ; then
747    BSDOBJDIR=/usr/obj
748fi
749if [ -d $BSDOBJDIR ] ; then
750    rm -rf $BSDOBJDIR
751fi
752
753cd $NETBSDSRCDIR && make cleandir
754
755---cut here---
756
757Critical utilities:
758^^^^^^^^^^^^^^^^^^^
759	gnu/usr.bin/egcs
760	usr.bin/compile_et
761	usr.bin/make
762	usr.bin/yacc
763	usr.bin/lex
764	usr.bin/xlint
765	usr.sbin/config
766
767Other problems and possible solutions:
768^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
769Symptom:Unreasonable compiler errors.
770Fix:	Rebuild gnu/usr.bin/egcs
771
772Symptom:Complaints involving a Makefile.
773Fix:	Rebuild usr.bin/make:
774	cd usr.bin/make && make && make install
775	Or, a failsafe method if that doesn't work:
776	cd usr.bin/make && cc *.c */*.c -I . -o make && mv make /usr/bin
777
778Fix:	Make sure .mk files are up to date.
779	cd share/mk && make install
780
781Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
782Fix:	Rebuild usr.sbin/config
783
784Symptom:
785Fix:	Rebuild usr.bin/yacc
786
787Symptom:
788Fix:	Rebuild usr.bin/lex
789
790Symptom:
791Fix:	rm /usr/lib/libbfd.a
792
793Symptom:Obsolete intermediate files are used during compilation
794Fix:	Try the following sequence of commands in the directory in question.
795	make cleandir; rm `make print-objdir`; make cleandir; make obj
796	(If you built the tree without "make obj" in the past, obsolete files
797	may remain.  The command tries to clean everything up)
798
799Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible pointer type
800Fix:	Rebuild and install usr.bin/menuc
801
802Symptom:mklocale not found during build in share/locale/ctype
803Fix:	Build and install usr.bin/mklocale
804
805Symptom:undefined reference to `__assert13' or `__unsetenv13'
806Fix:    Rebuild and install lib/libc
807
808Symptom:usr.sbin/config fails to build.
809Fix:	Try building with -DMAKE_BOOTSTRAP added to CFLAGS in Makefile.
810
811Symptom:undefined reference to `getprogname' or `setprogname'
812Fix:    Rebuild and install lib/libc
813
814Symptom:lint does not understand the '-X' option
815Fix:    May need to build & install libs with NOLINT=1 before rebuilding lint
816