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