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