1.\" Copyright (c) 2002 Murray Stokely <murray@FreeBSD.org> 2.\" 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.\" 1. Redistributions of source code must retain the above copyright 8.\" notice, this list of conditions and the following disclaimer. 9.\" 2. Redistributions in binary form must reproduce the above copyright 10.\" notice, this list of conditions and the following disclaimer in the 11.\" documentation and/or other materials provided with the distribution. 12.\" 13.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 14.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 15.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 16.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 17.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 18.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 19.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 20.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 21.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 22.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 23.\" SUCH DAMAGE. 24.\" 25.\" $FreeBSD$ 26.\" 27.Dd March 18, 2011 28.Dt RELEASE 7 29.Os 30.Sh NAME 31.Nm release 32.Nd "release building infrastructure" 33.Sh DESCRIPTION 34.Fx 35provides a complete build environment suitable for users to make 36full releases of the 37.Fx 38operating system. 39All of the tools necessary to build a release are available from the 40.Fx 41source code repository in 42.Pa src/release . 43A complete release can actually be built with only a single command, 44including the creation of ISO images suitable for burning to CD-ROM, 45memory stick images, and an FTP install directory. 46This command is aptly named 47.Dq Li "make release" . 48.Pp 49For some users, it may be desirable to provide an absolutely clean 50build environment, with no local modifications to the source tree or to 51.Xr make.conf 5 , 52and with clean checkouts of specific versions of the doc, src, and ports 53trees. For this purpose, a script 54.Pq Pa src/release/generate-release.sh 55is provided to automate these checkouts and then execute 56.Dq Li "make release" 57in a clean 58.Xr chroot 8 . 59.Pp 60Before attempting to build a release, the user is expected to be 61familiar with the contents of 62.Xr build 7 , 63and should have experience upgrading systems from source. 64.Pp 65The release build process requires that 66.Pa /usr/obj 67be populated with the output of 68.Dq Li "make buildworld" 69and 70.Dq Li "make buildkernel" . 71This is necessary to provide the object files for the release or, when 72using 73.Pa generate-release.sh , 74so that the object files for a complete system can be installed into a clean 75.Xr chroot 8 76environment. In this second case, the built world must be capable of running 77on the build system (i.e. it must be for the same architecture and be 78compatible with the installed kernel). 79The release procedure on some architectures may also require that the 80.Xr md 4 81(memory disk) device driver be present in the kernel 82(either by being compiled in or available as a module). 83.Pp 84This document does not cover source code management, quality 85assurance, or other aspects of the release engineering process. 86.Sh CLEAN RELEASE GENERATION 87Official releases of FreeBSD are produced in a totally clean environment to 88ensure consistency between the versions of the src, ports, and doc trees 89and to avoid contamination from the host system (e.g. local patches, changes 90to 91.Xr make.conf 5 , 92etc.). This is accomplished using the wrapper script 93.Pa src/release/generate-release.sh . 94.Pp 95.Ic generate-release.sh 96svn-branch scratch-dir 97.Pp 98.Ic generate-release.sh 99calls 100.Dq Li "make installworld" 101to generate a 102.Xr chroot 8 103environment in 104.Ar scratch-dir . 105It then checks out the src tree specified by 106.Ar svn-branch 107using 108.Xr svn 1 109and (optionally) the ports and documentation trees using 110.Xr csup 1 111or 112.Xr cvs 1 . 113Once the various source trees have been obtained, it executes 114.Dq Li "make release" 115within the 116.Xr chroot 8 117environment and places the result in 118.Pa $scratch-dir/R . 119Note that because this uses a chroot, it cannot be used to cross-build 120.Fx 121release media. 122.Pp 123Environment variables: 124.Bl -tag -width ".Cm MAKE_FLAGS" 125.It Ev CVSUP_HOST 126The CVSUP server to use for the doc and ports trees. One of 127.Ev CVSUP_HOST 128or 129.Ev CVSROOT 130must be specified for ports and documentation to be included in the release. 131.It Ev CVSROOT 132The location of the 133.Fx 134CVS repository to use for the doc and ports trees. One of 135.Ev CVSUP_HOST 136or 137.Ev CVSROOT 138must be specified for ports and documentation to be included in the release. 139.It Ev CVS_TAG 140If the variable 141.Ev CVS_TAG 142is set, that tag will be used for CVS checkouts (doc and ports), otherwise 143.Ic generate-release.sh 144will use HEAD. 145.It Ev MAKE_FLAGS 146This environment variable can be set to pass flags (e.g. -j) to 147.Xr make 1 148when invoked by the script. 149.It Ev SVNROOT 150The location of the FreeBSD SVN source repository. Defaults to 151.Pa svn://svn.freebsd.org/base . 152.El 153.Sh MAKEFILE TARGETS 154The release makefile 155.Pq Pa src/release/Makefile 156is fairly abstruse. 157Most developers will only be concerned with the 158.Cm release 159and 160.Cm install 161targets. 162.\" XXX: Some sort of introduction to this list? All the others have one. 163.Bl -tag -width ".Cm packagesystem" 164.It Cm release 165Meta-target to build all release media and distributions applicable to this 166platform. 167.It Cm install 168Copy all produced release media to 169.Pa ${DESTDIR} . 170.It Cm cdrom 171Builds installation CD-ROM images. On some systems, this may require that 172.Xr mkisofs 8 173be installed 174.Pq Pa sysutils/cdrtools 175and possibly that the 176.Xr md 4 177(memory disk) device driver be present in the kernel 178(either by being compiled in or available as a module). This target 179produces files called 180.Pa release.iso 181and 182.Pa bootonly.iso 183as its output. 184.It Cm memstick 185Builds an installation memory stick image named 186.Pa memstick . 187Not applicable on all platforms. Requires that the 188.Xr md 4 189(memory disk) device driver be present in the kernel 190(either by being compiled in or available as a module). 191.It Cm ftp 192Creates a directory named 193.Pa ftp 194containing the distribution files used in network installations 195and suitable for upload to an FTP mirror. 196.El 197.Pp 198Major subtargets called by targets above: 199.Bl -tag -width ".Cm packagesystem" 200.It Cm packagesystem 201Generates all the distribution archives (e.g. base, kernel, ports, doc) 202applicable on this platform. 203.It Cm system 204Builds a bootable installation system containing all the distribution files 205packaged by the 206.Cm packagesystem 207target, and suitable for imaging by the 208.Cm cdrom 209and 210.Cm memstick 211targets. 212.It Cm reldoc 213Builds the release documentation. 214This includes the release notes, 215hardware guide, and installation instructions. Other documentation (e.g. 216the Handbook) is built during the 217.Cm base.txz 218target invoked by 219.Cm packagesystem. 220.El 221.Sh ENVIRONMENT 222Optional variables: 223.Bl -tag -width ".Va TARGET_ARCH" 224.It Va WORLDDIR 225Location of a directory containing the src tree. By default, the directory 226above the one containing the makefile 227.Pq Pa src . 228.It Va PORTSDIR 229Location of a directory containing the ports tree. By default, 230.Pa /usr/ports . 231If it is unset or cannot be found, ports will not be included in the release. 232.It Va DOCDIR 233Location of a directory containing the doc tree. By default, 234.Pa /usr/doc . 235If it is unset or cannot be found, most documentation will not be included in 236the release; see 237.Ev NODOC 238below. 239.It Va NOPORTS 240If defined, the Ports Collection will be omitted from the release. 241.It Va NOSRC 242If set, do not include system source code in the release. 243.It Va NODOC 244If defined, the SGML-based documentation from the 245.Fx 246Documentation Project will not be built. 247However, the 248.Dq doc 249distribution will still be created with the minimal documentation set 250provided in 251.Pa src/share/doc . 252.It Va TARGET 253The target hardware platform. 254This is analogous to the 255.Dq Nm uname Fl m 256output. 257This is necessary to cross-build some target architectures. 258For example, cross-building for PC98 machines requires 259.Va TARGET_ARCH Ns = Ns Li i386 260and 261.Va TARGET Ns = Ns Li pc98 . 262If not set, 263.Va TARGET 264defaults to the current hardware platform. 265.It Va TARGET_ARCH 266The target machine processor architecture. 267This is analogous to the 268.Dq Nm uname Fl p 269output. 270Set this to cross-build for a different architecture. 271If not set, 272.Va TARGET_ARCH 273defaults to the current machine architecture, unless 274.Va TARGET 275is also set, in which case it defaults to the appropriate 276value for that platform. 277Typically, one only needs to set 278.Va TARGET . 279.El 280.Sh FILES 281.Bl -tag -compact 282.It Pa /usr/doc/Makefile 283.It Pa /usr/doc/share/mk/doc.project.mk 284.It Pa /usr/ports/Mk/bsd.port.mk 285.It Pa /usr/ports/Mk/bsd.sites.mk 286.It Pa /usr/share/examples/etc/make.conf 287.It Pa /usr/src/Makefile 288.It Pa /usr/src/Makefile.inc1 289.It Pa /usr/src/release/Makefile 290.It Pa /usr/src/release/generate-release.sh 291.El 292.Sh EXAMPLES 293The following sequence of commands can be used to build a 294.Dq "-CURRENT snapshot": 295.Bd -literal -offset indent 296cd /usr 297svn co svn://svn.freebsd.org/base/head src 298cd src 299make buildworld buildkernel 300cd release 301make release 302make install DESTDIR=/var/freebsd-snapshot 303.Ed 304.Pp 305After running these commands, all produced distribution files (tarballs 306for FTP, CD-ROM images, etc.) are available in the 307.Pa /var/freebsd-snapshot 308directory. 309.Pp 310The following sequence of commands can be used to build a 311.Dq "-CURRENT snapshot" 312in a clean environment, including ports and documentation: 313.Bd -literal -offset indent 314cd /usr/src 315make buildworld 316cd release 317export CVSUP_HOST=cvsupN.freebsd.org 318sh generate-release.sh head /local3/release 319.Ed 320.Pp 321After running these commands, all prepared release files are available in the 322.Pa /local3/release/R 323directory. 324.Sh SEE ALSO 325.Xr cc 1 , 326.Xr cvs 1 , 327.Xr install 1 , 328.Xr make 1 , 329.Xr svn 1 Pq Pa ports/devel/subversion-freebsd , 330.Xr uname 1 , 331.Xr md 4 , 332.Xr make.conf 5 , 333.Xr build 7 , 334.Xr ports 7 , 335.Xr chroot 8 , 336.Xr mtree 8 , 337.Xr sysctl 8 338.Rs 339.%T "FreeBSD Release Engineering" 340.%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/ 341.Re 342.Rs 343.%T "FreeBSD Release Engineering of Third Party Packages" 344.%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng-packages/ 345.Re 346.Rs 347.%T "FreeBSD Developers' Handbook" 348.%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/ 349.Re 350.Sh HISTORY 351.Fx 3521.x 353used a manual checklist, compiled by 354.An Rod Grimes , 355to produce a release. 356Apart from being incomplete, the list put a lot of specific demands on 357available file systems and was quite torturous to execute. 358.Pp 359As part of the 360.Fx 2.0 361release engineering effort, significant 362effort was spent getting 363.Pa src/release/Makefile 364into a shape where it could at least automate most of the tediousness 365of building a release in a sterile environment. 366.Pp 367For the 368.Fx 9.0 369release, 370.Pa src/release/Makefile 371was overhauled and the wrapper script 372.Pa src/release/generate-release.sh 373introduced to support the introduction of a new installer. 374.Pp 375At near 1000 revisions spread over multiple branches, the 376.Xr cvs 1 377log of 378.Pa src/release/Makefile 379contains a vivid historical record of some 380of the hardships release engineers go through. 381.Sh AUTHORS 382.Pa src/release/Makefile 383was originally written by 384.An -nosplit 385.An Rod Grimes , 386.An Jordan Hubbard , 387and 388.An Poul-Henning Kamp . 389This manual page was written by 390.An Murray Stokely Aq murray@FreeBSD.org . 391