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 May 17, 2005 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 40CVS repository in 41.Pa src/release . 42A complete release can actually be built with only a single command, 43including the creation of ISO images suitable for burning to CD-ROM, 44installation floppies, and an FTP install directory. 45This command is aptly named 46.Dq Li "make release" . 47.Pp 48Before attempting to build a release, the user is expected to be 49familiar with the contents of 50.Xr build 7 , 51and should have experience upgrading systems from source. 52The release build process requires that 53.Pa /usr/obj 54be populated with the output of 55a native 56.Dq Li "make buildworld" 57compiled from sources matching the currently running kernel. 58This is necessary so that the object files for a complete system can 59be installed into a clean 60.Xr chroot 8 61environment. 62The release procedure also requires that the 63.Xr md 4 64(memory disk) device driver be present in the kernel 65(either by being compiled in or available as a module). 66.Pp 67This document does not cover source code management, quality 68assurance, or other aspects of the release engineering process. 69.Sh TARGETS 70The release makefile 71.Pq Pa src/release/Makefile 72is fairly abstruse. 73Most developers will only be concerned with the 74.Cm release 75target. 76.\" XXX: Some sort of introduction to this list? All the others have one. 77.Bl -tag -width ".Cm package-split" 78.It Cm release 79Uses 80.Dq Li "make installworld" 81to install a clean system into a 82.Xr chroot 8 83environment on the file system. 84Checks out the specified version of the source code and then rebuilds 85the entire system in the clean environment with 86.Dq Li "make buildworld" . 87The detailed steps that follow are then executed to package up the 88different distributions, build the installation floppy disks, build 89release documentation, and so on. 90.Pp 91This target must be built as root with the 92.Va kern.securelevel 93sysctl set to \-1 (the default). 94.It Cm rerelease 95Assumes that the output of a release build has been manually modified, 96and performs the minimal number of steps to rebuild the release using 97the intermediate output of the previous 98.Dq Li "make release" . 99.It Cm floppies 100Generate a new set of boot and fixit floppies. 101This will call the 102.Cm release.4 , 103.Cm release.8 , 104.Cm floppies.1 , 105.Cm floppies.2 , 106and 107.Cm floppies.3 108targets to re-generate the floppy images of a previous 109.Dq Li "make release" . 110This is most often used to build custom boot floppies. 111.It Cm package-split 112Generates the portions of the disc 1 and disc 2 images related to packages. 113It uses the list of desired packages from the 114.Pa src/release/scripts/package-split.py 115script to pull packages out of a package build provided by the ports team 116and organize them appropriately. 117The resulting directory can then be passed to 118.Dq Li "make release" 119via the 120.Va CD_PACKAGE_TREE 121variable to populate the ISO images built by the 122.Cm iso.1 123target with the correct package related bits. 124.El 125.Pp 126Targets called by 127.Dq Li "make release" : 128.Bl -tag -width ".Cm fetch-distfiles" 129.It Cm release.1 130Cleans out the 131.Pa ${CHROOTDIR}/R 132directory and uses 133.Xr mtree 8 134to build the directory hierarchy for the system. 135.It Cm release.2 136Installs the system into the distribution directories. 137.It Cm release.3 138Makes and installs the 139.Pa GENERIC 140kernel as well as any other kernels listed in 141.Va KERNELS . 142.It Cm release.4 143Uses 144.Xr crunchgen 1 145to build 146.Dq crunched 147binaries to live on the installation floppies. 148.It Cm release.5 149Builds synthetic distributions, and cleans up the previously built 150distribution trees. 151.It Cm release.6 152Creates tarballs of the assembled distribution trees. 153.It Cm release.7 154Makes source distributions. 155.It Cm release.8 156Creates the MFS root file systems. 157.It Cm floppies.1 158Creates the boot and kernel floppies. 159.It Cm floppies.2 160Creates the fixit floppy. 161.It Cm floppies.3 162Finalizes the 163.Pa ${CHROOTDIR}/R/ftp/stage/floppies 164staging directory. 165.It Cm ftp.1 166Sets up a suitable area for FTP installations in 167.Pa ${CHROOTDIR}/R/ftp . 168.It Cm cdrom.1 169Create the layout for the live file system CD-ROM image in 170.Pa ${CHROOTDIR}/R/cdrom . 171.It Cm cdrom.2 172Create the layout for the first and second CD-ROM images. 173.It Cm cdrom.3 174Create the layout for the boot-only CD-ROM image and the boot-only UFS 175miniroot image. 176.It Cm iso.1 177Builds ISO images (installation and 178.Dq live 179file system) from the CD-ROM release area 180(disabled by default, see 181.Va MAKE_ISOS 182below). 183.It Cm fetch-distfiles 184Fetches distfiles needed during the release build that are not already in 185.Va RELEASEDISTFILES . 186.It Cm doc.1 187Builds all of the necessary tools to turn the 188.Fx 189Documentation Project source documents (SGML, XML) into HTML 190and text documents that will accompany the release. 191Also, builds and installs the actual user documentation. 192This includes the Handbook, FAQ, articles, and so on. 193.It Cm doc.2 194Builds the release documentation. 195This includes the release notes, 196hardware guide, and installation instructions. 197.El 198.Sh ENVIRONMENT 199Variables that must be specified: 200.Bl -tag -width ".Va BUILDNAME" 201.It Va BUILDNAME 202The name of the release to be built. 203This is used to set the 204.Va RELEASE 205value in 206.Pa sys/conf/newvers.sh , 207which affects the output of 208.Xr uname 1 . 209.It Va CHROOTDIR 210The directory to be used as the 211.Xr chroot 8 212environment for the entire release build. 213.\" XXX: I recommend against hardcoding specific numbers like "2.3" here; 214.\" XXX: perhaps it should be replaced with something to the effect of 215.\" XXX: "we do not know how much space you'll need, but make sure you have 216.\" XXX: at least 3 GB to be safe" (I know i'm still hardcoding a number, 217.\" XXX: but at least it looks less like a decree and more like an estimate. 218This file system should have at least 3.2 gigabytes of free space on the 219i386 architecture. 220.It Va CVSROOT 221The location of the 222.Fx 223CVS repository. 224This path name is in reference to the real system root, 225.Em not 226the root of the 227.Xr chroot 8 228directory tree. 229.El 230.Pp 231Optional variables: 232.Bl -tag -width ".Va NO_PREFETCHDISTFILES" 233.It Va CD_PACKAGE_TREE 234A directory containing extra bits for the first and second CD-ROM images. 235The extra files for the first disc should be in 236.Pa ${CD_PACKAGE_TREE}/disc1 237and the extra files for the second disc should be in 238.Pa ${CD_PACKAGE_TREE}/disc2 . 239Typically, this variable will be set to the output directory of an earlier 240invocation of the 241.Cm package-split 242target. 243.It Va CVSARGS 244Additional arguments for 245.Xr cvs 1 246that come before the subcommands such as 247.Dq Li "-qR" . 248.It Va CVSCMDARGS 249Additional arguments for 250.Xr cvs 1 251.Ic checkout 252and 253.Ic update 254commands. 255For example, setting this variable to 256.Dq Li "-D '01/01/2002 00:00:00 GMT'" 257for 258.Dq Li "make release" 259or 260.Dq Li "make rerelease" 261will ask 262.Xr cvs 1 263to check out or update sources as of 00:00:00 GMT, January 1 2002, respectively. 264.It Va DOC_LANG 265The list of languages and encodings the SGML-based documentation 266should be built for. 267If not set, the documentation is built for all available languages. 268.It Va DOCRELEASETAG 269The CVS tag to use when checking out the documentation tree. 270Usually, 271the head of the documentation tree is used by default. 272If 273.Va RELEASETAG 274specifies a release tag, 275then the associated release version is used as the default instead. 276.It Va EXTLOCALDIR 277The directory that will be copied to 278.Pa ${CHROOTDIR}/usr/local . 279.It Va EXTSRCDIR 280The directory specified by this variable will be copied into 281.Pa ${CHROOTDIR}/usr/src 282instead of that directory being populated by a CVS checkout. 283For 284.Dq Li "rerelease" , 285this will NOT be copied; cvs update will be used instead. 286.It Va EXTDOCDIR 287The directory specified by this variable will be copied into 288.Pa ${CHROOTDIR}/usr/doc . 289For 290.Dq Li "rerelease" , 291this will NOT be copied; cvs update will be used instead. 292.It Va EXTPORTSDIR 293The directory specified by this variable will be copied into 294.Pa ${CHROOTDIR}/usr/ports . 295For 296.Dq Li "rerelease" , 297this will do NOTHING. 298.It Va KERNEL_FLAGS 299The contents of this variable are passed to 300.Xr make 1 301when building kernels during the release build. 302For example, setting this variable to 303.Dq Li "-j 4" 304will instruct 305.Xr make 1 306to execute up to four processes at a time. 307.It Va KERNELS 308Specifies a list of additional kernel configurations to compile and 309install into the 310.Dq base 311distribution. 312Each kernel is installed into 313.Pa /boot/<config> 314so that it can be booted from the loader via 315.Dq Li "boot <config>" . 316.It Va LOCAL_PATCHES 317Patch files against 318.Pa /usr/src 319that will be applied in the 320.Xr chroot 8 321environment before the release build begins. 322.It Va PATCH_FLAGS 323Arguments for the 324.Xr patch 1 325command used to apply 326.Va LOCAL_PATCHES 327patch file. 328.It Va LOCAL_SCRIPT 329A script that will be run in the 330.Xr chroot 8 331environment immediately after any local patches are applied. 332.It Va MAKE_ISOS 333If defined, bootable ISO CD-ROM images will be created from the 334contents of the CD-ROM stage directory. 335.It Va NOCDROM 336If defined, the CD-ROM stage directories will not be created. 337.It Va NODOC 338If defined, the SGML-based documentation from the 339.Fx 340Documentation Project will not be built. 341However, the 342.Dq doc 343distribution will still be created with the minimal documentation set 344provided in 345.Pa src/share/doc . 346.It Va NO_FLOPPIES 347If defined, no boot and fixit floppy disk images will be created (for those 348platforms supporting them). 349.It Va NOPORTS 350If defined, the Ports Collection will be omitted from the release. 351.It Va PORTSRELEASETAG 352The CVS tag to use when checking out the ports tree. 353Usually, 354the head of the ports tree is used by default. 355If 356.Va RELEASETAG 357specifies a release tag, 358then the associated release version is used as the default instead. 359.It Va NO_PREFETCHDISTFILES 360If this variable is defined, 361then distfiles needed during the release build will not be downloaded prior to 362entering the 363.Xr chroot 8 364environment. 365Note that if 366.Va NO_PREFETCHDISTFILES 367is not set, 368the fetching is done after any distfiles are obtained via 369.Va RELEASEDISTFILES . 370.It Va RELEASEDISTFILES 371The directory where the distribution files for ports required by the 372release build can be found. 373This may save a significant amount of time over downloading the 374distfiles through a slow link. 375.It Va RELEASENOUPDATE 376If this variable is defined for 377.Dq Li "make rerelease" , 378the source code will not be updated with 379.Dq Li "cvs update" . 380.It Va RELEASETAG 381The CVS tag corresponding to the release that is to be built. 382If undefined, the release will be built from the 383.Dv HEAD 384of the CVS tree 385(a 386.Dq "-CURRENT snapshot" ) . 387.It Va SEPARATE_LIVEFS 388Store the live file system on its own CD-ROM image rather than placing it on 389the first disc. 390.It Va TARGET_ARCH 391The target machine processor architecture. 392This is analogous to the 393.Dq Nm uname Fl p 394output. 395Set this to cross-build for a different architecture. 396.It Va TARGET 397The target hardware platform. 398This is analogous to the 399.Dq Nm uname Fl m 400output. 401This is necessary to cross-build some target architectures. 402For example, cross-building for PC98 machines requires 403.Va TARGET_ARCH Ns = Ns Li i386 404and 405.Va TARGET Ns = Ns Li pc98 . 406.It Va WORLDDIR 407The directory where 408.Dq Li "make buildworld" 409was run; defaults to 410.Pa ${.CURDIR}/.. 411which usually points to 412.Pa /usr/src . 413.It Va WORLD_FLAGS 414The contents of this variable are passed to 415.Xr make 1 416when building world during the release build. 417For example, setting this variable to 418.Dq Li "-j 4" 419will instruct 420.Xr make 1 421to execute up to four processes at a time. 422.El 423.Sh FILES 424.Bl -tag -compact 425.It Pa /usr/doc/Makefile 426.It Pa /usr/doc/share/mk/doc.project.mk 427.It Pa /usr/ports/Mk/bsd.port.mk 428.It Pa /usr/ports/Mk/bsd.sites.mk 429.It Pa /usr/share/examples/etc/make.conf 430.It Pa /usr/src/Makefile 431.It Pa /usr/src/Makefile.inc1 432.It Pa /usr/src/release/Makefile 433.It Pa /usr/src/release/${arch}/boot_crunch.conf 434.It Pa /usr/src/release/${arch}/fixit_crunch.conf 435.El 436.Sh EXAMPLES 437The following sequence of commands was used to build the 438.Fx 4.9 439release: 440.Bd -literal -offset indent 441cd /usr 442cvs co -rRELENG_4_9_0_RELEASE src 443cd src 444make buildworld 445cd release 446make release CHROOTDIR=/local3/release BUILDNAME=4.9-RELEASE \\ 447 CVSROOT=/host/cvs/usr/home/ncvs RELEASETAG=RELENG_4_9_0_RELEASE 448.Ed 449.Pp 450After running these commands, a complete system suitable for FTP or 451CD-ROM distribution is available in the 452.Pa /local3/release/R 453directory. 454.Pp 455The following sequence of commands can be used to build a 456.Dq "-CURRENT snapshot" 457of a 458locally modified source tree: 459.Bd -literal -offset indent 460cd /usr/src 461cvs diff -u > /path/to/local.patch 462make buildworld 463cd release 464make release CHROOTDIR=/local3/release BUILDNAME=6.0-CURRENT \\ 465 CVSROOT=/host/cvs/usr/home/ncvs LOCAL_PATCHES=/path/to/local.patch 466.Ed 467.Sh SEE ALSO 468.Xr cc 1 , 469.Xr crunchgen 1 , 470.Xr cvs 1 , 471.Xr install 1 , 472.Xr make 1 , 473.Xr patch 1 , 474.Xr uname 1 , 475.Xr md 4 , 476.Xr make.conf 5 , 477.Xr build 7 , 478.Xr ports 7 , 479.Xr chroot 8 , 480.Xr mtree 8 , 481.Xr sysctl 8 482.Rs 483.%T "FreeBSD Release Engineering" 484.%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/ 485.Re 486.Rs 487.%T "FreeBSD Release Engineering of Third Party Packages" 488.%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng-packages/ 489.Re 490.Rs 491.%T "FreeBSD Developers' Handbook" 492.%O http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/ 493.Re 494.Sh HISTORY 495.Fx 4961.x 497used a manual checklist, compiled by 498.An Rod Grimes , 499to produce a release. 500Apart from being incomplete, the list put a lot of specific demands on 501available file systems and was quite torturous to execute. 502.Pp 503As part of the 504.Fx 2.0 505release engineering effort, significant 506effort was spent getting 507.Pa src/release/Makefile 508into a shape where it could at least automate most of the tediousness 509of building a release in a sterile environment. 510.Pp 511With its almost 1000 revisions spread over multiple branches, the 512.Xr cvs 1 513log of 514.Pa src/release/Makefile 515contains a vivid historical record of some 516of the hardships release engineers go through. 517.Sh AUTHORS 518.Pa src/release/Makefile 519was originally written by 520.An -nosplit 521.An Rod Grimes , 522.An Jordan Hubbard , 523and 524.An Poul-Henning Kamp . 525This manual page was written by 526.An Murray Stokely Aq murray@FreeBSD.org . 527.Sh BUGS 528Infrastructure changes are occasionally made to the 529.Fx 530documentation set in such a way that release builds on security 531branches can fail. 532To work around this, release builds can be made to checkout the 533documentation from the last fully supported release of 534.Fx . 535For example: 536.Pp 537.Dl "make release RELEASETAG=RELENG_4_9 DOCRELEASETAG=RELEASE_4_9_0 ..." 538