summaryrefslogtreecommitdiff
path: root/share/man/man8/release.8
blob: 96ae96c518026ab3e90b3738ecff900d9693ecc9 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
.\"	$OpenBSD: release.8,v 1.12 2000/12/17 00:39:26 marc Exp $
.\"
.\"	Copyright (c) 2000 Marco S. Hyman
.\"
.\"	Permission to copy all or part of this material for any purpose is
.\"	granted provided that the above copyright notice and this paragraph
.\"	are duplicated in all copies.  THIS SOFTWARE IS PROVIDED ``AS IS''
.\"	AND WITHOUT ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, WITHOUT
.\"	LIMITATION, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
.\"	FOR A PARTICULAR PURPOSE.
.\"
.Dd July 6, 2000
.Dt RELEASE 8
.Os
.Sh NAME
.Nm release
.Nd building an
.Ox
release
.Sh DESCRIPTION
There are several steps necessary to build a system release.
They are:
.Pp
.Bl -enum -compact
.It
Update sources.
.It
Build and install a new kernel.
.It
Build a new system.
.It
Make and validate the system release.
.It
Build and install X11.
.It
Make and validate the X11 release.
.It
Make the third party packages.
.El
.Pp
The following sections describe each of the required steps in detail.
.Ss "1. Update sources"
.Pp
A
.Nm
should always start from a known set of
.Em coherent
sources.
The easiest way to ensure that the sources are complete and coherent
is to check them out using the
.Tn CVS
tag the
.Ox
developers add to the repository prior to making a release.
There are two tags, one which identifies the release as it exists on the
.Tn CD\-ROM
and another which identifies the
.Em stable
branch.
The
.Em stable
branch, starting with
.Ox 2.7 ,
contains the patches described in
.Pa http://www.openbsd.org/errata.html .
The tags are of the form:
.Bl -tag -width OPENBSD_x_y_BASE
.It Va OPENBSD_x_y_BASE
This tag marks the source as it exists on the release
.Tn CD\-ROM
where
.Ar x
is the major release number and
.Ar y
is the minor release number.
.It Va OPENBSD_x_y
This tag is a moving target.
It marks the sources that belong to the stable branch.
This branch
.Em only
contains errata, no new features.
.El
.Pp
To update your sources to the versions identified by one of the above
tags use the commands:
.Pp
.Bl -bullet -offset indent -compact
.It
.Li "cd /usr/src && cvs up -r TAG -Pd"
.It
.Li "cd X11SRC && cvs up -r TAG -Pd"
.It
.Li "cd PORTSPATH && cvs up -r TAG -Pd"
.El
.Pp
Replace
.Va X11SRC
with the path to your
.Tn X11R6
sources.
Replace
.Va PORTSPATH
with the path to your ports tree sources, typically
.Pa /usr/ports .
The above command assume an existing source tree.
.Pp
See
.Pa http://www.openbsd.org/anoncvs.html
for instructions on fetching the sources for the first time.
.Bd -offset indent
.Sy Warning :
.Tn CVS
tags are
.Sq sticky .
See
.Xr cvs 1
for more information.
.Ed
.Ss "2. Build and install a new kernel"
.Pp
For safety, you should always build and install a new kernel before
building the programs that will use the kernel.
This ensures that any new system calls, for example, will be present
when needed.
To build a kernel the steps are:
.Pp
.Bl -bullet -offset indent -compact
.It
.Li "cd /sys/arch/${ARCH}/conf"
.br
where
.Va ${ARCH}
is the architecture of your machine, e.g.,
.Li i386 .
.It
.Li "vi ${NAME}"
.br
where
.Va ${NAME}
is your kernel configuration file.
You should
.Em not
edit
.Li GENERIC ,
create your own kernel configuration if you need to make modifications.
If using
.Li GENERIC
you can skip this step.
And yes, you may use
.Li emacs
or any other editor you choose.
.It
.Li "config ${NAME}"
.It
.Li "cd ../compile/${NAME}"
.It
.Li "make clean && make depend && make"
.br
In this instance
.Li "make clean"
is your friend.
.It
.Li su
.It
.Li "mv /bsd /bsd.old && mv bsd / && chown root.wheel /bsd"
.It
.Li "shutdown -r now"
.El
.Pp
If the system does not come up you can boot using
.Pa bsd.old .
.Ss "3. Build a new system"
.Pp
Now that you are running using your new kernel you can build a new system.
It's safer (but slower) to remove and re-build your object directories
and re-building them before the build.
The steps are:
.Pp
.Bl -bullet -offset indent -compact
.It
.Li "cd /usr/obj && mkdir -p .old && sudo mv * .old && sudo rm -rf .old &"
.br
This moves all your existing object out of the way and then removes them in
the background.
.It
.Li "cd /usr/src && nice make obj"
.br
this re-builds your obj directories
.It
.Li su
.It
.Li "nice make build"
.br
If you have set
.Xr sudo 8
up, you can combine this with the previous step using the command
.Bd -literal -offset indent -compact
nice make SUDO=sudo build
.Ed
.It
Update
.Pa /etc ,
.Pa /var ,
and
.Pa /dev/MAKEDEV
by hand.
.El
.Pp
At this point your system is up-to-date and running the code that you
are going to make into a release.
.Ss "4. Make and validate the system release"
.Pp
The system release consists of a generic kernel, one
.Tn CD\-ROM
and two floppy boot-able file-systems, the release
.Sq tarballs ,
installation instructions, and checksum files.
.Pp
The release process requires two work areas.
They are:
.Bl -tag -width "RELEASEDIR "
.It Va DESTDIR
This is the name of a directory which will be the root of a a complete
.Ox
installation, thus it must be on a disk partition large enough to
store the entire operating system (less
.Tn X11R6
and any third party
.Sq packages ) .
The directory can be removed once the release is created.
In any case the release process ensures the directory is empty before starting.
.It Va RELEASEDIR
This is the name of a directory where the release output files are stored.
The following process will create the directory if necessary.
.It " "
.Sy Warning :
.Va DESTDIR
and 
.Va RELEASEDIR
must not refer to any directory with
.Pa /mnt
in its path as
.Pa /mnt
is used in the release generation process.
.El
.Pp
The floppy and
.Tn CD\-ROM
.Pa RAMDISK
images require a special tool which is created first.
The release process is:
.Pp
.Bl -bullet -offset indent -compact
.It
.Li su
.br
you must be root to create a release
.It
.Li "cd /usr/src/distrib/crunch && make clean && make && make install"
.br
create the special tools needed to build the release
.It
.Li "export DESTDIR=your-destdir RELEASEDIR=your-releasedir"
.It
.Li "test -d ${DESTDIR} && mv ${DESTDIR} ${DESTDIR}- && rm -rf ${DESTDIR}- &"
.It
.Li "mkdir -p ${DESTDIR} ${RELEASEDIR}"
.br
these two steps ensure
.Va ${DESTDIR}
exists as an empty directory and
.Va ${RELEASEDIR}
exists.
.Va ${RELEASEDIR}
need not be empty.
.It
.Li "cd /usr/src/etc && nice make release"
.It
.Li "cd /usr/src/distrib/sets && csh checkflist"
.br
this checks that the contents of
.Va ${DESTDIR}
pretty much match the contents of the release
.Sq tarballs .
.It
.Li "unset RELEASEDIR DESTDIR"
.El
.Pp
At this point you have most of an
.Ox
release.
The only thing missing is
.Va X11R6
(which is covered in the next section).
.Ss "5. Build and install X11"
.Pp
The
.Va X11
tree is primarily
.Xr imake 1 No Ns -based
and doesn't contain the
.Dq obj
directory mechanism that comes with Berkeley
.Xr make 1 .
While the tree can be built in place, it's better to refrain from
polluting the cvs sources.
An alternate build location needs to be selected, large enough to hold the
.Tn X11R6
object files, libraries, and binaries.
Call this location
.Va X11BLD .
.Va X11SRC
is the path to your
.Tn X11R6
sources.
Once you've selected
.Va X11BLD
the build process is:
.Pp
.Bl -bullet -offset indent -compact
.It
.Li su
.It
.Li "test -d X11BLD && mv X11BLD X11BLD- && rm -rf X11BLD- &"
.It
.Li "mkdir -p X11BLD"
.It
.Li "cd X11BLD && lndir X11SRC && nice make DESTDIR=/ build"
.El
.Pp
.Sy Note :
.Pa SuperProbe ,
built and installed above, requires version 8.0 of the
.Pa tcl/tk
libraries.   They must be installed to do a proper build. Version 8.0 of
.Pa tcl/tk
can be found in the ports tree at
.Pa /usr/ports/lang/tcl/8.0/
and
.Pa /usr/ports/x11/tk/8.0/ .
Version 8.0 is required to build X11.   Version 8.0 may coexist with
version 8.3.
.Pp
The above method mimics a
.Ic "make build"
in the
.Pa /usr/src
directory.
.Pa X11R6
is created and installed in
.Pa
/usr/X11R6 .
However, the install phase of the build does
.Em not
overwrite
.Pa /var/X11/xdm .
That directory must be installed by hand.   Or you can
.Ic "cd /var/X11 && mv xdm xdm-"
before the build and copy any local configuration from
.Pa xdm-
to
.Pa xdm
after the build.
.Ss "6. Make and validate the X11 release"
.Pp
.Va X11R6
uses the same
.Va DESTDIR
and
.Va RELEASEDIR
mechanism noted in the section on building a system release, above.
They may be the same values used above, but be warned that the
contents of
.Va DESTDIR
will be removed if you follow this procedure.   However,
.Va DESTDIR
should not be the same directory used to build the system release.  
It may be the same if you don't care to keep the contents of the
system release
.Va DESTDIR .
(The X11
.Va DESTDIR
needs to be emptied for release checklist processing.)
.Pp
The steps to build the release are (assuming you are still root, and still in
.Va X11BLD ) :
.Pp
.Bl -bullet -offset indent -compact
.It
.Li "export DESTDIR=your-destdir RELEASEDIR=your-releasedir"
.It
.Li "test -d ${DESTDIR} && mv ${DESTDIR} ${DESTDIR}- && rm -rf ${DESTDIR}- &"
.It
.Li "mkdir -p ${DESTDIR} ${RELEASEDIR}"
.It
.Li "nice make release"
.It
.Li "unset RELEASEDIR DESTDIR"
.El
.Pp
At this point you have both system and
.Tn X11R6
.Sq tarballs
in your release directory.
.Ss "7. Make the third party packages"
.Pp
The
.Sq ports
sub-system of contributed applications is described in
.Xr ports 7 .
For ease of installation ports can be pre-compiled into
.Sq packages
which can then be installed onto machines using
.Xr pkg_add 1 .
Packages are created by:
.Pp
.Bl -bullet -offset indent -compact
.It
Select an application to build, we'll call it
.Va CATEGORY/PORT .
.It
.Li "cd /usr/ports/CATEGORY/PORT"
.It
.Li su
.It
.Li "make package"
.El
.Pp
That's all there is to it.
.Sh SEE ALSO
.Xr cvs 1 ,
.Xr pkg_add 1 ,
.Xr ports 7 ,
.Xr sudo 8
.Sh HISTORY
This document first appeared in
.Ox 2.8 .