UPDATING revision 1.9 1 1.9 sommerfe $NetBSD: UPDATING,v 1.9 2001/01/01 15:29:16 sommerfeld Exp $
2 1.1 abs
3 1.1 abs This file is intended to be a brief introduction to the build
4 1.1 abs process and a reference on what to do if something doesn't work.
5 1.1 abs
6 1.1 abs For a more detailed description see Makefile.
7 1.1 abs
8 1.1 abs Recent changes:
9 1.1 abs ^^^^^^^^^^^^^^^
10 1.9 sommerfe
11 1.9 sommerfe 20010101:
12 1.9 sommerfe bsd.subdir.mk committed 20001230 had a bug which caused
13 1.9 sommerfe afterinstall targets to run too soon; update again.
14 1.8 sommerfe
15 1.8 sommerfe 20001230:
16 1.8 sommerfe New share/mk files needed to support .WAIT in SUBDIR variables.
17 1.8 sommerfe If you get make errors,
18 1.8 sommerfe (cd share/mk; make install)
19 1.8 sommerfe Also, PRINTOBJDIR has changed and is now used more heavily.
20 1.6 ad
21 1.6 ad 20001019:
22 1.7 ad The `ca' device driver has been replaced by `ld'; although the
23 1.6 ad major and minor numbers haven't changed, you should update your /dev
24 1.6 ad directory.
25 1.1 abs
26 1.4 itojun 20000929:
27 1.4 itojun The following make directives are obsoleted.
28 1.4 itojun MKCRYPTO_RSA NOCRYPTO_RSA NOCRYPTO_RC5 NOCRYPTO_IDEA
29 1.4 itojun By default, RSA is built into libcrypto. IDEA and RC5 will not be
30 1.4 itojun bulit into libcrypto. By using MKCRYPTO_{RC5,IDEA}, you can build
31 1.4 itojun additional library libcrypto_{idea,rc5}.
32 1.4 itojun
33 1.1 abs 20000623:
34 1.1 abs MKCRYPTO and friends added to share/mk/bsd.own.mk.
35 1.1 abs 'cd share/mk ; make install' needed before make build.
36 1.1 abs
37 1.1 abs
38 1.1 abs Hints for a more successful build:
39 1.1 abs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
40 1.2 mrg Build a new kernel first:
41 1.2 mrg This makes sure that any new system calls or features
42 1.2 mrg expected by the new userland will be present. This
43 1.2 mrg helps to avoid critical errors when upgrading.
44 1.1 abs Use object directories:
45 1.1 abs This helps to keep stale object
46 1.1 abs files from polluting the build if a Makefile "forgets"
47 1.1 abs about one. It also makes it easier to clean up after
48 1.1 abs a build. It's also necessary if you want to use the
49 1.1 abs same source tree for multiple machines.
50 1.1 abs To use object directories:
51 1.1 abs a) cd /usr/src ; make cleandir
52 1.2 mrg b) Add "OBJMACHINE=yes" to /etc/mk.conf
53 1.2 mrg c) Add "MKOBJDIRS=yes" to /etc/mk.conf
54 1.1 abs d) cd /usr/src ; make build
55 1.2 mrg Note that running "make obj" in a directory will create
56 1.2 mrg in obj.$MACHINE directory.
57 1.1 abs Build to a DESTDIR:
58 1.1 abs This helps to keep old
59 1.1 abs installed files (especially libraries) from interfering
60 1.1 abs with the new build.
61 1.1 abs To build to a DESTDIR, set the DESTDIR environment
62 1.2 mrg variable before running make build. It should be set to
63 1.2 mrg the pathname of an initially empty directory.
64 1.1 abs Problems: you might need to update critical utilities
65 1.1 abs without using DESTDIR since nothing is executed
66 1.1 abs from what is installed in DESTDIR.
67 1.1 abs (See critical utils, below)
68 1.1 abs Build often:
69 1.1 abs This keeps critical utilities current enough to not choke
70 1.1 abs on any other part of the source tree that depends on up to
71 1.1 abs date functionality.
72 1.1 abs
73 1.1 abs What to do if things don't work:
74 1.1 abs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
75 1.1 abs When things don't work there is usually a few things that commonly
76 1.1 abs should be done.
77 1.1 abs 1) make includes
78 1.1 abs This should be done automatically by make build.
79 1.1 abs 2) cd share/mk && make install
80 1.1 abs Again, automatically done by make build.
81 1.1 abs
82 1.1 abs Failsafe rebuild of a small part of the tree:
83 1.1 abs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
84 1.1 abs To make sure you rebuild something correctly you want to do
85 1.1 abs something like the following:
86 1.1 abs 1) Make sure the includes and .mk files are up to date.
87 1.1 abs 2) Make sure any program used to build the particular
88 1.1 abs utility is up to date. (yacc, lex, etc...)
89 1.1 abs 3) cd ...path/to/util...
90 1.1 abs make cleandir
91 1.1 abs rm ...all obj directories...
92 1.1 abs make cleandir # yes, again
93 1.1 abs make obj
94 1.1 abs make depend && make
95 1.1 abs
96 1.1 abs Failsafe rebuild of the entire tree:
97 1.1 abs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
98 1.1 abs If you really want to make sure the source tree is clean and
99 1.2 mrg ready for a build try the following. Note that sourcing /etc/mk.conf
100 1.2 mrg (a make(1) Makefile) in this manner is not right, and will not work
101 1.2 mrg for anyone who uses any make(1) features in /etc/mk.conf.
102 1.1 abs
103 1.1 abs ---cut here---
104 1.1 abs #!/bin/sh
105 1.1 abs . /etc/mk.conf
106 1.1 abs
107 1.1 abs if [ -z $BSDSRCDIR ] ; then
108 1.1 abs BSDSRCDIR=/usr/src
109 1.1 abs fi
110 1.1 abs if [ \! -d $BSDSRCDIR ] ; then
111 1.1 abs echo Unable to find sources
112 1.1 abs exit 1
113 1.1 abs fi
114 1.1 abs find $BSDSRCDIR -name \*.o -o -name obj.\* -o -name obj -exec rm \{\} \;
115 1.1 abs
116 1.1 abs if [ -z $BSDOBJDIR ] ; then
117 1.1 abs BSDOBJDIR=/usr/obj
118 1.1 abs fi
119 1.1 abs if [ -d $BSDOBJDIR ] ; then
120 1.1 abs rm -rf $BSDOBJDIR
121 1.1 abs fi
122 1.1 abs
123 1.1 abs cd $BSDSRCDIR && make cleandir
124 1.1 abs
125 1.1 abs ---cut here---
126 1.1 abs
127 1.1 abs Critical utilities:
128 1.1 abs ^^^^^^^^^^^^^^^^^^^
129 1.1 abs gnu/usr.bin/egcs
130 1.3 itojun usr.bin/compile_et
131 1.1 abs usr.bin/make
132 1.1 abs usr.bin/yacc
133 1.1 abs usr.bin/lex
134 1.2 mrg usr.sbin/config
135 1.1 abs
136 1.1 abs Other problems and possibly solutions:
137 1.1 abs ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
138 1.1 abs Symptom:Unreasonable compiler errors.
139 1.1 abs Fix: Rebuild gnu/usr.bin/egcs
140 1.1 abs
141 1.1 abs Symptom:Complaints involving a Makefile.
142 1.1 abs Fix: Make sure .mk files are up to date.
143 1.1 abs cd share/mk && make install
144 1.1 abs Fix: Rebuild usr.bin/make
145 1.2 mrg
146 1.2 mrg Symptom:Kernel `config' fails to configure any kernel, including GENERIC.
147 1.2 mrg Fix: Rebuild usr.sbin/config
148 1.1 abs
149 1.1 abs Symptom:
150 1.1 abs Fix: Rebuild usr.bin/yacc
151 1.1 abs
152 1.1 abs Symptom:
153 1.1 abs Fix: Rebuild usr.bin/lex
154 1.1 abs
155 1.1 abs Symptom:
156 1.1 abs Fix: rm /usr/lib/libbfd.a
157 1.4 itojun
158 1.4 itojun Symptom:Obsolete intermediate files are used during compilation
159 1.4 itojun Fix: Try the following sequence of commands in the directory in question.
160 1.4 itojun make cleandir; rm `make print-objdir`; make cleandir; make obj
161 1.4 itojun (If you built the tree without "make obj" in the past, obsolete files
162 1.4 itojun may remain. The command tries to clean everything up)
163 1.5 wiz
164 1.5 wiz Symptom:.../sysinst/run.c:xx: warning: initialization from incompatible pointer type
165 1.5 wiz Fix: Rebuild and install usr.bin/menuc
166