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 9, 2015 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.It Cm nopkgs 112Do not add any packages (for debugging purposes). 113This is equivalent to setting 114.Va DPORTS_PACKAGES 115empty. 116.El 117.Pp 118During the process of rolling a release a check is performed to find 119out if external packages to be put on the CD exist on your system. 120If they cannot be found, the release process will stop and give 121proper commands for downloading and setting up these packages. 122.Sh ENVIRONMENT 123.Bl -tag -width ".Va DPORTS_EXTRA_PACKAGES" 124.It Va ISODIR 125Default prefix of 126.Va ISOFILE 127and 128.Va ISOROOT 129(default is 130.Pa /usr/obj/release ) . 131.It Va ISOFILE 132Name of the ISO image to generate (default is 133.Pa /usr/obj/release/dfly.iso ) . 134.It Va ISOROOT 135Location where the image contents are installed to before the ISO is prepared. 136.It Va KERNCONF 137Kernel configuration(s) to use. 138.It Va PKGBIN_MKISOFS 139Location of the 140.Xr mkisofs 8 141utility which is to be used during the build. 142.It Va DPORTS_PACKAGES 143List of packages to be added to the ISO. 144.It Va DPORTS_EXTRA_PACKAGES 145List of packages, in addition to 146.Va DPORTS_PACKAGES , 147to be added to the ISO. 148.It Va DPORTS_PATH 149Location of the 150.Xr dports 7 151tree to be used for package building. 152.It Va WITHOUT_SRCS 153If set, this variable will prevent source code from being copied to 154the ISO image. 155.It Va IMGFILE 156The name of the image file (default is 157.Pa /usr/obj/release/dfly.img ) . 158.It Va IMGMNT 159The mount point for the image (default is 160.Pa /usr/obj/release/mnt ) . 161.It Va IMGUSBDEV 162The disk device to use in the image's 163.Xr fstab 5 164(default is 165.Pa /dev/da8 ) . 166.El 167.Sh FILES 168.Bl -tag -compact -width ".Pa src/nrelease/Makefile" 169.It Pa /etc/make.conf 170.It Pa src/Makefile 171.It Pa src/Makefile.inc1 172.It Pa src/nrelease/Makefile 173.El 174.Sh EXAMPLES 175The following sequence of commands is used to build a standard 176.Dx 2.0 177installation CD image (assuming that a local git repository is 178available, see 179.Xr development 7 180for how to get this): 181.Bd -literal -offset indent 182cd /usr/src 183git checkout -b rel2_0 crater/DragonFly_RELEASE_2_0 184cd nrelease 185make release 186.Ed 187.Pp 188After running these commands, the image will be available in the 189.Pa /usr/obj/release 190directory. 191.\".Pp 192.\"The steps required for engineering a release are documented in (CVS) 193.\".Pa doc/notes/release.txt 194.\"(how to branch the CVS tree etc.) 195.\"They were put in an out of the way place so normal developers would not 196.\"accidentally try to run the commands in question. 197.Sh SEE ALSO 198.Xr git 1 , 199.Xr make 1 , 200.Xr make.conf 5 , 201.Xr build 7 , 202.Xr development 7 , 203.Xr dports 7 204.Sh HISTORY 205The 206.Nm 207framework was added in 208.Dx 1.0 209to implement the idea of a 210.Dq "live CD" . 211.Sh AUTHORS 212.An -nosplit 213The 214.Nm 215infrastructure was written by 216.An Matthew Dillon . 217This manual page was written by 218.An Sascha Wildner . 219