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 July 21, 2022 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 be built with only a single command, 44including the creation of ISO images suitable for burning to CD-ROM, 45memory stick images, and a network 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. 54For this purpose, a script 55.Pq Pa src/release/release.sh 56is provided to automate these checkouts and then execute 57.Dq Li "make release" 58in a clean 59.Xr chroot 8 . 60.Pp 61Before attempting to build a release, the user is expected to be 62familiar with the contents of 63.Xr build 7 , 64and should have experience upgrading systems from source. 65.Pp 66The release build process requires that 67.Pa /usr/obj 68be populated with the output of 69.Dq Li "make buildworld" 70and 71.Dq Li "make buildkernel" . 72This is necessary to provide the object files for the release or, when 73using 74.Pa release.sh , 75so that the object files for a complete system can be installed into a clean 76.Xr chroot 8 77environment. 78.Pp 79If the target release build is for a different architecture or machine type, 80the 81.Va TARGET 82and 83.Va TARGET_ARCH 84variables must be used. 85See the supported 86.Fa release.conf 87variables for more information. 88.Pp 89The release procedure on some architectures may also require that the 90.Xr md 4 91(memory disk) device driver be present in the kernel 92.Pq either by being compiled in or available as a module . 93.Pp 94This document does not cover source code management, quality 95assurance, or other aspects of the release engineering process. 96.Sh CLEAN RELEASE GENERATION 97Official releases of 98.Fx 99are produced in a clean environment to 100ensure consistency between the versions of the src, ports, and doc trees 101and to avoid contamination from the host system 102.Po such as local patches, changes 103to 104.Xr make.conf 5 , 105etc. 106.Pc . 107This is accomplished using the wrapper script 108.Pa src/release/release.sh . 109.Pp 110.Ic release.sh 111.Op Fl c Ar release.conf 112.Pp 113.Ic release.sh 114checks out the 115.Li src/ , 116.Li ports/ , 117and 118.Li doc/ 119trees to 120.Va CHROOTDIR , 121then calls 122.Dq Li "make buildworld" 123and 124.Dq Li "make installworld" 125to generate a 126.Xr chroot 8 127environment. 128Next, 129.Dq Li "make release" 130is run within the 131.Xr chroot 8 132environment and places the result in 133.Pa $CHROOTDIR/R . 134.Pp 135The optional 136.Fa release.conf 137configuration file supports the following variables: 138.Bl -tag -width Ev 139.It Va CHROOTDIR 140The directory within which the release will be built. 141.It Va CHROOT_MAKEENV 142Additional 143.Xr make 1 144arguments to pass through, which directly affect the 145tuning of the build chroot. 146.It Va NOGIT 147Do not explicitly require the 148.Xr git 1 149port to be installed. 150.It Va GITROOT 151The 152.Xr git 1 153host used to check out the various trees. 154Defaults to 155.Pa https://git.FreeeBSD.org . 156.It Va SRCBRANCH 157The 158.Li src/ 159branch to use. 160Defaults to 161.Fl b Va main . 162.It Va PORTBRANCH 163The 164.Li ports/ 165branch to use. 166Defaults to 167.Va head/@rHEAD . 168.It Va TARGET 169The target machine type for cross-building a release. 170.It Va TARGET_ARCH 171The target machine architecture for cross-building a release. 172.Pp 173For the supported list of 174.Va TARGET 175and 176.Va TARGET_ARCH 177combinations, consult the output of 178.Dq make targets 179as documented in 180.Xr build 7 . 181.It Va KERNEL 182The target kernel configuration to use. 183Defaults to 184.Va GENERIC . 185Multiple 186.Va KERNEL 187entries may be specified. 188.It Va MAKE_CONF 189The 190.Xr make.conf 5 191to use for the release build. 192Defaults to 193.Fa /dev/null 194to prevent polluting the release with local system changes. 195.It Va SRC_CONF 196The 197.Xr src.conf 5 198to use for the release build. 199Defaults to 200.Fa /dev/null 201to prevent polluting the release with local system changes. 202.It Va MAKE_FLAGS 203Additional flags to pass to 204.Xr make 1 . 205.It Va WORLD_FLAGS 206Additional flags to pass to 207.Xr make 1 208during the 209.Dq buildworld 210phase. 211Defaults to setting the number of 212.Xr make 1 213jobs 214.Pq Ar -j 215to the number of CPUs available on a SMP-capable system. 216.It Va KERNEL_FLAGS 217Additional flags to pass to 218.Xr make 1 219during the 220.Dq buildkernel 221phase. 222Defaults to setting the number of 223.Xr make 1 224jobs 225.Pq Ar -j 226to half the number of CPUs available on a SMP-capable system. 227.It Va NOPORTS 228Set to a non-empty value to skip the 229.Li ports/ 230tree checkout. 231When set, 232.Va NOPORTS 233will prevent the 234.Fa ports.txz 235distribution package from being created. 236.It Va WITH_DVD 237Set to a non-empty value to include the 238.Cm dvdrom 239target. 240.It Va WITH_COMPRESSED_IMAGES 241Set to a non-empty value to compress the release images with 242.Xr xz 1 . 243The original 244.Pq uncompressed 245images are not removed. 246.It Va XZ_THREADS Pq Vt int 247Set to the number of threads 248.Xr xz 1 249should use when compressing images. 250By default, 251.Va XZ_THREADS 252is set to 253.Va 0 , 254which uses all available cores on the system. 255.It Va VCSCMD 256The command run to obtain the source trees. 257Defaults to 258.Qq Cm git clone Fl q . 259.It Va CHROOTBUILD_SKIP 260If defined, the 261.Li buildworld , 262.Li installworld , 263and 264.Li distribution 265stages of the 266.Xr chroot 8 267build environment setup are skipped. 268This is intended solely for cases where the 269.Xr chroot 8 270userland are provided by alternate means. 271.It Va SRC_UPDATE_SKIP 272Set to a non-empty value to prevent checkout or update of 273.Fa /usr/src 274within the 275.Xr chroot 8 . 276This is intended for use only when 277.Fa /usr/src 278is expected to exist by alternative means. 279.It Va PORTS_UPDATE_SKIP 280Set to a non-empty value to prevent checkout or update of 281.Fa /usr/ports 282within the 283.Xr chroot 8 . 284This is intended for use only when 285.Fa /usr/ports 286is expected to exist by alternative means. 287.El 288.Sh EMBEDDED BUILDS 289The following 290.Fa release.conf 291variables are relevant only to release builds for embedded systems: 292.Bl -tag -width Ev 293.It Va EMBEDDEDBUILD 294Set to a non-null value to enable functionality for embedded device 295release builds. 296.Pp 297When set, 298.Va WITH_DVD 299is unset. 300Additionally, 301.Va EMBEDDED_TARGET 302and 303.Va EMBEDDED_TARGET_ARCH 304must also be defined. 305When the build environment is created, 306.Fa release.sh 307runs a separate build script located in an architecture-specific 308directory in 309.Pa src/release/${EMBEDDED_TARGET}/ . 310.It Va EMBEDDEDPORTS 311Set to the list of any ports that are required for the target device 312in the format of 313.Fa category/port . 314.It Va EMBEDDED_TARGET 315When set, its value is passed to 316.Xr make 1 317to set the 318.Va TARGET 319.Pq value of Cm uname Fl m 320to cross build the target userland. 321.It Va EMBEDDED_TARGET_ARCH 322When set, its value is passed to 323.Xr make 1 324to set the 325.Va TARGET_ARCH 326.Pq value of Cm uname Fl p 327to cross build the target userland. 328.El 329.Sh VIRTUAL MACHINE DISK IMAGES 330The following 331.Fa release.conf 332variables are relevant only to virtual machine disk image builds: 333.Bl -tag -width Ev 334.It Va WITH_VMIMAGES 335Set to a non-null value to build virtual machine disk images as part 336of the release build. 337.Va WITH_VMIMAGES 338may also be specified as an environment variable passed to 339.Xr make 1 . 340.It Va WITH_COMPRESSED_VMIMAGES 341Set to a non-null value to compress the virtual machine disk images with 342.Xr xz 1 343as part of the 344.Cm install 345.Xr make 1 346target. 347Note that compressing virtual machine disk images may take a very long 348time on some systems. 349.It Va VMBASE 350Set to change the name of the resulting virtual machine disk image file. 351The default value is 352.Va vm . 353.It Va VMSIZE 354Set to change the size of the virtual machine disk capacity. 355The default value is 356.Va 20g . 357See 358.Xr makefs 8 359for valid values. 360.Pp 361Virtual machine disk images are, by default, created as sparse images. 362When 363.Va WITH_COMPRESSED_VMIMAGES 364is used, the resulting files compressed with 365.Xr xz 1 366compress to roughly the same size, regardless of the specified disk image 367size. 368.It Va VMFORMATS 369Set to the target virtual disk image format(s) to create. 370By default, the 371.Va vhdf , Va vmdk , Va qcow2 , 372and 373.Va raw 374formats are created. 375See 376.Xr mkimg 1 377for valid format values. 378.El 379.Pp 380For a list of supported 381.Va VMFORMATS 382values 383.Pq including cloud hosting provider formats 384along with a brief description, run: 385.Bd -literal -offset indent 386cd /usr/src 387make -C release list-vmtargets 388.Ed 389.Sh CLOUD HOSTING MACHINE IMAGES 390The 391.Fx 392release build tools support building virtual machine images for various 393cloud hosting providers, each with their own specific configuration to 394include support for each hosting provider by default. 395.Pp 396The following 397.Xr make 1 398environment variables are supported: 399.Bl -tag -width Ev 400.It Va CLOUDWARE 401Set to a list of one or more cloud hosting providers, enclosed in quotes. 402Requires 403.Va WITH_CLOUDWARE 404to also be set. 405.It Va WITH_CLOUDWARE 406Set to a non-empty value to enable building virtual machine images 407for various cloud hosting providers. 408Requires 409.Va CLOUDWARE 410to also be set. 411.El 412.Pp 413Additionally, the 414.Va CLOUDWARE 415and 416.Va WITH_CLOUDWARE 417variables can be added to 418.Pa release.conf , 419and used in conjunction with 420.Pa release.sh . 421.Pp 422For a list of supported 423.Va CLOUDWARE 424values, run: 425.Bd -literal -offset indent 426cd /usr/src 427make -C release list-cloudware 428.Ed 429.Sh MAKEFILE TARGETS 430The release makefile 431.Pq Pa src/release/Makefile 432is fairly abstruse. 433Most developers will only be concerned with the 434.Cm release 435and 436.Cm install 437targets. 438.\" XXX: Some sort of introduction to this list? All the others have one. 439.Bl -tag -width ".Cm packagesystem" 440.It Cm release 441Meta-target to build all release media and distributions applicable to this 442platform. 443.It Cm install 444Copy all produced release media to 445.Pa ${DESTDIR} . 446.It Cm cdrom 447Builds installation CD-ROM images. 448This may require the 449.Xr md 4 450(memory disk) device driver be present in the kernel 451(either by being compiled in or available as a module). 452This target produces files called 453.Pa disc1.iso 454and 455.Pa bootonly.iso 456as its output. 457.It Cm dvdrom 458Builds installation DVD-ROM images. 459This may require the 460.Xr md 4 461(memory disk) device driver be present in the kernel 462(either by being compiled in or available as a module). 463This target produces the 464.Pa dvd1.iso 465file as its output. 466.It Cm memstick 467Builds an installation memory stick image named 468.Pa memstick.img . 469Not applicable on all platforms. 470Requires that the 471.Xr md 4 472.Pq memory disk 473device driver be present in the kernel 474.Pq either by being compiled in or available as a module . 475.It Cm mini-memstick 476Similar to 477.Cm memstick , 478with the exception that the installation distribution sets 479are not included. 480.It Cm ftp 481Creates a directory named 482.Pa ftp 483containing the distribution files used in network installations 484and suitable for upload to an FTP mirror. 485.It Cm vm-image 486Creates virtual machine disk images in various formats. 487The 488.Cm vm-image 489target requires the 490.Va WITH_VMIMAGES 491.Xr make 1 492environment variable to be set to a non-null value. 493.It Cm vm-cloudware 494Builds 495.Fx 496virtual machine images for various cloud hosting providers. 497See 498.Qq CLOUD HOSTING MACHINE IMAGES 499for implementation details. 500.It Cm list-cloudware 501Displays the list of valid 502.Va CLOUDWARE 503values. 504.It Cm list-vmtargets 505Displays the list of valid 506.Va VMFORMAT 507and 508.Va CLOUDWARE 509values. 510.El 511.Pp 512Major subtargets called by targets above: 513.Bl -tag -width ".Cm packagesystem" 514.It Cm packagesystem 515Generates all the distribution archives 516.Pq base, kernel, ports, doc 517applicable on this platform. 518.It Cm disc1 519Builds a bootable installation system containing all the distribution files 520packaged by the 521.Cm packagesystem 522target, and suitable for imaging by the 523.Cm cdrom , 524.Cm dvdrom 525and 526.Cm memstick 527targets. 528.It Cm reldoc 529Builds the release documentation. 530This includes the release notes, 531hardware guide, and installation instructions. 532Other documentation, such as the Handbook, 533is built during the 534.Cm base.txz 535target invoked by 536.Cm packagesystem . 537.El 538.Sh ENVIRONMENT 539Optional variables: 540.Bl -tag -width ".Ev TARGET_ARCH" 541.It Ev OSRELEASE 542Optional base name for generated media images when invoking the 543.Cm install 544target 545.Pq e.g., FreeBSD-12.1-RELEASE-amd64 . 546Defaults to the output of 547.Ic `uname -s`-`uname -r`-`uname -p` 548within the chroot. 549.It Ev WORLDDIR 550Location of a directory containing the src tree. 551By default, the directory 552above the one containing the makefile 553.Pq Pa src . 554.It Ev PORTSDIR 555Location of a directory containing the ports tree. 556By default, 557.Pa /usr/ports . 558If it is unset or cannot be found, ports will not be included in the release. 559.It Ev NOPORTS 560If defined, the Ports Collection will be omitted from the release. 561.It Ev NOSRC 562If set, do not include system source code in the release. 563.It Ev TARGET 564The target hardware platform. 565This is analogous to the 566.Dq Nm uname Fl m 567output. 568This is necessary to cross-build some target architectures. 569For example, cross-building for ARM64 machines requires 570.Ev TARGET_ARCH Ns = Ns Li aarch64 571and 572.Ev TARGET Ns = Ns Li arm64 . 573If not set, 574.Ev TARGET 575defaults to the current hardware platform. 576.It Ev TARGET_ARCH 577The target machine processor architecture. 578This is analogous to the 579.Dq Nm uname Fl p 580output. 581Set this to cross-build for a different architecture. 582If not set, 583.Ev TARGET_ARCH 584defaults to the current machine architecture, unless 585.Ev TARGET 586is also set, in which case it defaults to the appropriate 587value for that platform. 588Typically, one only needs to set 589.Ev TARGET . 590.El 591.Sh FILES 592.Bl -tag -compact -width Pa 593.It Pa /usr/doc/Makefile 594.It Pa /usr/doc/share/mk/doc.project.mk 595.It Pa /usr/ports/Mk/bsd.port.mk 596.It Pa /usr/ports/Mk/bsd.sites.mk 597.It Pa /usr/share/examples/etc/make.conf 598.It Pa /usr/src/Makefile 599.It Pa /usr/src/Makefile.inc1 600.It Pa /usr/src/release/Makefile 601.It Pa /usr/src/release/Makefile.vm 602.It Pa /usr/src/release/release.sh 603.It Pa /usr/src/release/release.conf.sample 604.It Pa /usr/src/release/tools/*.conf 605.It Pa /usr/src/release/tools/vmimage.subr 606.El 607.Sh EXAMPLES 608The following sequence of commands can be used to build a 609.Dq "-CURRENT snapshot": 610.Bd -literal -offset indent 611cd /usr 612git clone -b main https://git.freebsd.org/src.git src 613cd src 614make buildworld buildkernel 615cd release 616make obj 617make release 618make install DESTDIR=/var/freebsd-snapshot 619.Ed 620.Pp 621After running these commands, all produced distribution files (tarballs 622for FTP, CD-ROM images, etc.) are available in the 623.Pa /var/freebsd-snapshot 624directory. 625.Pp 626The following sequence of commands can be used to build a 627.Dq "-CURRENT snapshot" 628in a clean environment, including ports and documentation: 629.Bd -literal -offset indent 630cd /usr/src/release 631sh release.sh 632.Ed 633.Pp 634Optionally, a configuration file can be used to customize the release build: 635.Bd -literal -offset indent 636cd /usr/src/release 637sh release.sh -c $HOME/release.conf 638.Ed 639.Pp 640Configuration files specific to various supported embedded systems, such as 641the Raspberry Pi, exist in the directory corresponding to the 642.Va TARGET 643.Xr make 1 644variable. 645For example, to build an image for the Raspberry Pi: 646.Bd -literal -offset indent 647cd /usr/src/release 648sh release.sh -c arm/RPI-B.conf 649.Ed 650.Pp 651To build an image for the Raspberry Pi 3: 652.Bd -literal -offset indent 653cd /usr/src/release 654sh release.sh -c arm64/RPI3.conf 655.Ed 656.Pp 657After running these commands, all prepared release files are available in the 658.Pa /scratch 659directory. 660The target directory can be changed by specifying the 661.Va CHROOTDIR 662variable in 663.Li release.conf . 664.Sh COMPATIBILITY 665The reldoc target was removed in commit f61e92ca5a23, and 666.Ev DOCDIR , 667.Ev DOCBRANCH , 668.Ev DOC_UPDATE_SKIP , 669and 670.Ev NODOC 671are therefore no longer supported. 672.Sh SEE ALSO 673.Xr cc 1 , 674.Xr git 1 Pq Pa ports/devel/git , 675.Xr install 1 , 676.Xr make 1 , 677.Xr mkimg 1 , 678.Xr uname 1 , 679.Xr md 4 , 680.Xr make.conf 5 , 681.Xr build 7 , 682.Xr ports 7 , 683.Xr chroot 8 , 684.Xr mtree 8 , 685.Xr sysctl 8 686.Rs 687.%T "FreeBSD Release Engineering" 688.%U https://docs.freebsd.org/en/articles/freebsd-releng/ 689.Re 690.Rs 691.%T "FreeBSD Developers' Handbook" 692.%U https://docs.freebsd.org/en/books/developers-handbook/ 693.Re 694.Sh HISTORY 695.Fx 6961.x 697used a manual checklist, compiled by 698.An Rod Grimes , 699to produce a release. 700Apart from being incomplete, the list put a lot of specific demands on 701available file systems and was quite torturous to execute. 702.Pp 703As part of the 704.Fx 2.0 705release engineering effort, significant 706effort was spent getting 707.Pa src/release/Makefile 708into a shape where it could at least automate most of the tediousness 709of building a release in a sterile environment. 710.Pp 711For the 712.Fx 9.0 713release, 714.Pa src/release/Makefile 715was overhauled and the wrapper script 716.Pa src/release/generate-release.sh 717introduced to support the introduction of a new installer. 718.Pp 719For the 720.Fx 9.2 721release, 722.Pa src/release/release.sh 723was introduced to support per-build configuration files. 724.Pa src/release/release.sh 725is heavily based on the 726.Pa src/release/generate-release.sh 727script. 728.Pp 729At near 1000 revisions spread over multiple branches, the 730.Xr git 1 731log of 732.Pa src/release/Makefile 733contains a vivid historical record of some 734of the hardships release engineers go through. 735.Sh AUTHORS 736.Pa src/release/Makefile 737was originally written by 738.An -nosplit 739.An Rod Grimes , 740.An Jordan Hubbard , 741and 742.An Poul-Henning Kamp . 743.Pp 744This manual page was originally written by 745.An Murray Stokely Aq Mt murray@FreeBSD.org . 746.Pp 747It was updated by 748.An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org 749to include the 750.Fa generate-release.sh 751script used for the 752.Fx 9.0 753release cycle. 754.Pp 755It was later updated by 756.An Glen Barber Aq Mt gjb@FreeBSD.org 757to include the 758.Fa release.sh 759script used for the 760.Fx 9.2 761release cycle. 762