2 .\" Copyright (c) 2006 The DragonFly Project. All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
8 .\" 1. Redistributions of source code must retain the above copyright
9 .\" notice, this list of conditions and the following disclaimer.
10 .\" 2. Redistributions in binary form must reproduce the above copyright
11 .\" notice, this list of conditions and the following disclaimer in
12 .\" the documentation and/or other materials provided with the
14 .\" 3. Neither the name of The DragonFly Project nor the names of its
15 .\" contributors may be used to endorse or promote products derived
16 .\" from this software without specific, prior written permission.
18 .\" THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS
19 .\" ``AS IS'' AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT
20 .\" LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
21 .\" FOR A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE
22 .\" COPYRIGHT HOLDERS OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT,
23 .\" INCIDENTAL, SPECIAL, EXEMPLARY OR CONSEQUENTIAL DAMAGES (INCLUDING,
24 .\" BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES;
25 .\" LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED
26 .\" AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
27 .\" OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT
28 .\" OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
31 .\" $FreeBSD: src/share/man/man7/release.7,v 1.3.2.6 2003/04/12 20:42:30 murray Exp $
38 .Nd release building infrastructure
41 provides a complete build environment suitable for users to make
45 All of the tools necessary to build releases are available from the
48 A complete release (that is, a live CD) can actually be built with
49 only a single command.
50 This command is aptly named
51 .Dq Li "make release" .
53 This document does not cover source code management, quality
54 assurance, or other aspects of the release engineering process.
57 .Pq Pa src/nrelease/Makefile
58 defines a number of targets which are roughly modeled after the
59 targets used for building the system.
60 .Bl -tag -width ".Cm realquickrel"
64 Builds world and kernel, installs them, adds packages and prepares the ISO
81 Removes the ISO root directory and object files.
85 but also removes external packages.
92 targets will only work if a full
96 have been done before.
97 For a description of the corresponding build targets, see
100 A number of additional targets may be specified along with
105 to add additional features:
106 .Bl -tag -width ".Cm realquickrel"
110 along with some additional applications to the ISO (LiveDVD).
113 During the process of rolling a release a check is performed to find
114 out if external packages to be put on the CD exist on your system.
115 If they cannot be found, the release process will stop and give
116 proper commands for downloading and setting up these packages.
118 .Bl -tag -width ".Va PKGSRC_EXTRA_PACKAGES"
127 Name of the ISO image to generate (default is
128 .Pa /usr/release/dfly.iso ) .
130 Location where the image contents are installed to before the ISO is prepared.
132 Kernel configuration(s) to use.
133 .It Va PKGBIN_MKISOFS
136 utility which is to be used during the build.
137 .It Va PKGBIN_PKG_ADD
140 utility which is to be used during the build.
141 .It Va PKGBIN_PKG_ADMIN
144 utility which is to be used during the build.
145 .It Va PKGBIN_PKG_DELETE
148 utility which is to be used during the build.
149 .It Va PKGSRC_PACKAGES
150 List of packages to be added to the ISO.
151 .It Va PKGSRC_EXTRA_PACKAGES
152 List of packages, in addition to
153 .Va PKGSRC_PACKAGES ,
154 to be added to the ISO.
158 tree to be used for package building.
159 .It Va PKGSRC_PKG_PATH
160 Specifies the location where binary
164 If set, this variable will prevent source code from being copied to
167 The name of the image file (default is
168 .Pa /usr/release/dfly.img ) .
170 The mount point for the image (default is
171 .Pa /usr/release/mnt ) .
173 The disk device to use in the image's
180 .It Pa /etc/make.conf
182 .It Pa src/Makefile.inc1
183 .It Pa src/nrelease/Makefile
186 The following sequence of commands is used to build a standard
188 installation CD image (assuming that a local git repository is
191 for how to get this):
192 .Bd -literal -offset indent
194 git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0
199 After running these commands, the image will be available in the
203 .\"The steps required for engineering a release are documented in (CVS)
204 .\".Pa doc/notes/release.txt
205 .\"(how to branch the CVS tree etc.)
206 .\"They were put in an out of the way place so normal developers would not
207 .\"accidentally try to run the commands in question.
218 framework was added in
220 to implement the idea of a
226 infrastructure was written by
228 This manual page was written by