1.\" 2.\" Copyright (c) 2006 The DragonFly Project. All rights reserved. 3.\" 4.\" Redistribution and use in source and binary forms, with or without 5.\" modification, are permitted provided that the following conditions 6.\" are met: 7.\" 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 13.\" distribution. 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. 17.\" 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 29.\" SUCH DAMAGE. 30.\" 31.\" $FreeBSD: src/share/man/man7/release.7,v 1.3.2.6 2003/04/12 20:42:30 murray Exp $ 32.\" 33.Dd May 12, 2010 34.Dt NRELEASE 7 35.Os 36.Sh NAME 37.Nm nrelease 38.Nd release building infrastructure 39.Sh DESCRIPTION 40.Dx 41provides a complete build environment suitable for users to make 42full releases of the 43.Dx 44operating system. 45All of the tools necessary to build releases are available from the 46git repository in 47.Pa src/nrelease . 48A complete release (that is, a live CD) can actually be built with 49only a single command. 50This command is aptly named 51.Dq Li "make release" . 52.Pp 53This document does not cover source code management, quality 54assurance, or other aspects of the release engineering process. 55.Sh TARGETS 56The release Makefile 57.Pq Pa src/nrelease/Makefile 58defines a number of targets which are roughly modeled after the 59targets used for building the system. 60.Bl -tag -width ".Cm realquickrel" 61.It Cm help 62Offer some help. 63.It Cm release 64Builds world and kernel, installs them, adds packages and prepares the ISO 65image. 66.It Cm quickrel 67Same as 68.Cm release 69but uses the 70.Cm quickworld 71target (alias 72.Cm quick ) . 73.It Cm realquickrel 74Same as 75.Cm release 76but uses the 77.Cm realquickworld 78target (alias 79.Cm realquick ) . 80.It Cm clean 81Removes the ISO root directory and object files. 82.It Cm realclean 83Same as 84.Cm clean 85but also removes external packages. 86.El 87.Pp 88The 89.Cm quickrel 90and 91.Cm realquickrel 92targets will only work if a full 93.Cm buildworld 94and 95.Cm buildkernel 96have been done before. 97For a description of the corresponding build targets, see 98.Xr build 7 . 99.Pp 100A number of additional targets may be specified along with 101.Cm release , 102.Cm quickrel , 103or 104.Cm realquickrel 105to add additional features: 106.Bl -tag -width ".Cm realquickrel" 107.It Cm gui 108Adds 109.Xr Xorg 1 110along with some additional applications to the ISO (LiveDVD). 111.El 112.Pp 113During the process of rolling a release a check is performed to find 114out if external packages to be put on the CD exist on your system. 115If they cannot be found, the release process will stop and give 116proper commands for downloading and setting up these packages. 117.Sh ENVIRONMENT 118.Bl -tag -width ".Va PKGSRC_EXTRA_PACKAGES" 119.It Va ISODIR 120Default prefix of 121.Va ISOFILE 122and 123.Va ISOROOT 124(default is 125.Pa /usr/release ) . 126.It Va ISOFILE 127Name of the ISO image to generate (default is 128.Pa /usr/release/dfly.iso ) . 129.It Va ISOROOT 130Location where the image contents are installed to before the ISO is prepared. 131.It Va KERNCONF 132Kernel configuration(s) to use. 133.It Va PKGBIN_MKISOFS 134Location of the 135.Xr mkisofs 8 136utility which is to be used during the build. 137.It Va PKGBIN_PKG_ADD 138Location of the 139.Xr pkg_add 1 140utility which is to be used during the build. 141.It Va PKGBIN_PKG_ADMIN 142Location of the 143.Xr pkg_admin 1 144utility which is to be used during the build. 145.It Va PKGBIN_PKG_DELETE 146Location of the 147.Xr pkg_delete 1 148utility which is to be used during the build. 149.It Va PKGSRC_PACKAGES 150List of packages to be added to the ISO. 151.It Va PKGSRC_EXTRA_PACKAGES 152List of packages, in addition to 153.Va PKGSRC_PACKAGES , 154to be added to the ISO. 155.It Va PKGSRC_PATH 156Location of 157.Xr pkgsrc 7 158tree to be used for package building. 159.It Va PKGSRC_PKG_PATH 160Specifies the location where binary 161.Xr pkgsrc 7 162packages are kept. 163.It Va WITHOUT_SRCS 164If set, this variable will prevent source code from being copied to 165the ISO image. 166.It Va IMGFILE 167The name of the image file (default is 168.Pa /usr/release/dfly.img ) . 169.It Va IMGMNT 170The mount point for the image (default is 171.Pa /usr/release/mnt ) . 172.It Va IMGUSBDEV 173The disk device to use in the image's 174.Xr fstab 5 175(default is 176.Pa /dev/da8 ) . 177.El 178.Sh FILES 179.Bl -tag -compact 180.It Pa /etc/make.conf 181.It Pa src/Makefile 182.It Pa src/Makefile.inc1 183.It Pa src/nrelease/Makefile 184.El 185.Sh EXAMPLES 186The following sequence of commands is used to build a standard 187.Dx 2.0 188installation CD image (assuming that a local git repository is 189available, see 190.Xr development 7 191for how to get this): 192.Bd -literal -offset indent 193cd /usr/src 194git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0 195cd nrelease 196make release 197.Ed 198.Pp 199After running these commands, the image will be available in the 200.Pa /usr/release 201directory. 202.\".Pp 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. 208.Sh SEE ALSO 209.Xr git 1 , 210.Xr make 1 , 211.Xr make.conf 5 , 212.Xr build 7 , 213.Xr development 7 , 214.Xr pkgsrc 7 215.Sh HISTORY 216The 217.Nm 218framework was added in 219.Dx 1.0 220to implement the idea of a 221.Dq "live CD" . 222.Sh AUTHORS 223.An -nosplit 224The 225.Nm 226infrastructure was written by 227.An Matthew Dillon . 228This manual page was written by 229.An Sascha Wildner . 230