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 October 28, 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 VMFS 369Set to specify the file system type to use. 370Valid values are 371.Va ufs 372and 373.Va zfs . 374The default value is 375.Va ufs . 376.It Va VMFORMATS 377Set to the target virtual disk image format(s) to create. 378By default, the 379.Va vhdf , Va vmdk , Va qcow2 , 380and 381.Va raw 382formats are created. 383See 384.Xr mkimg 1 385for valid format values. 386.El 387.Pp 388For a list of supported 389.Va VMFORMATS 390values 391.Pq including cloud hosting provider formats 392along with a brief description, run: 393.Bd -literal -offset indent 394cd /usr/src 395make -C release list-vmtargets 396.Ed 397.Sh CLOUD HOSTING MACHINE IMAGES 398The 399.Fx 400release build tools support building virtual machine images for various 401cloud hosting providers, each with their own specific configuration to 402include support for each hosting provider by default. 403.Pp 404The following 405.Xr make 1 406environment variables are supported: 407.Bl -tag -width Ev 408.It Va CLOUDWARE 409Set to a list of one or more cloud hosting providers, enclosed in quotes. 410Requires 411.Va WITH_CLOUDWARE 412to also be set. 413.It Va WITH_CLOUDWARE 414Set to a non-empty value to enable building virtual machine images 415for various cloud hosting providers. 416Requires 417.Va CLOUDWARE 418to also be set. 419.El 420.Pp 421Additionally, the 422.Va CLOUDWARE 423and 424.Va WITH_CLOUDWARE 425variables can be added to 426.Pa release.conf , 427and used in conjunction with 428.Pa release.sh . 429.Pp 430For a list of supported 431.Va CLOUDWARE 432values, run: 433.Bd -literal -offset indent 434cd /usr/src 435make -C release list-cloudware 436.Ed 437.Sh MAKEFILE TARGETS 438The release makefile 439.Pq Pa src/release/Makefile 440is fairly abstruse. 441Most developers will only be concerned with the 442.Cm release 443and 444.Cm install 445targets. 446.\" XXX: Some sort of introduction to this list? All the others have one. 447.Bl -tag -width ".Cm packagesystem" 448.It Cm release 449Meta-target to build all release media and distributions applicable to this 450platform. 451.It Cm install 452Copy all produced release media to 453.Pa ${DESTDIR} . 454.It Cm cdrom 455Builds installation CD-ROM images. 456This may require the 457.Xr md 4 458(memory disk) device driver be present in the kernel 459(either by being compiled in or available as a module). 460This target produces files called 461.Pa disc1.iso 462and 463.Pa bootonly.iso 464as its output. 465.It Cm dvdrom 466Builds installation DVD-ROM images. 467This may require the 468.Xr md 4 469(memory disk) device driver be present in the kernel 470(either by being compiled in or available as a module). 471This target produces the 472.Pa dvd1.iso 473file as its output. 474.It Cm memstick 475Builds an installation memory stick image named 476.Pa memstick.img . 477Not applicable on all platforms. 478Requires that the 479.Xr md 4 480.Pq memory disk 481device driver be present in the kernel 482.Pq either by being compiled in or available as a module . 483.It Cm mini-memstick 484Similar to 485.Cm memstick , 486with the exception that the installation distribution sets 487are not included. 488.It Cm ftp 489Creates a directory named 490.Pa ftp 491containing the distribution files used in network installations 492and suitable for upload to an FTP mirror. 493.It Cm vm-image 494Creates virtual machine disk images in various formats. 495The 496.Cm vm-image 497target requires the 498.Va WITH_VMIMAGES 499.Xr make 1 500environment variable to be set to a non-null value. 501.It Cm vm-cloudware 502Builds 503.Fx 504virtual machine images for various cloud hosting providers. 505See 506.Qq CLOUD HOSTING MACHINE IMAGES 507for implementation details. 508.It Cm list-cloudware 509Displays the list of valid 510.Va CLOUDWARE 511values. 512.It Cm list-vmtargets 513Displays the list of valid 514.Va VMFORMATS 515and 516.Va CLOUDWARE 517values. 518.El 519.Pp 520Major subtargets called by targets above: 521.Bl -tag -width ".Cm packagesystem" 522.It Cm packagesystem 523Generates all the distribution archives 524.Pq base, kernel, ports, doc 525applicable on this platform. 526.It Cm disc1 527Builds a bootable installation system containing all the distribution files 528packaged by the 529.Cm packagesystem 530target, and suitable for imaging by the 531.Cm cdrom , 532.Cm dvdrom 533and 534.Cm memstick 535targets. 536.It Cm reldoc 537Builds the release documentation. 538This includes the release notes, 539hardware guide, and installation instructions. 540Other documentation, such as the Handbook, 541is built during the 542.Cm base.txz 543target invoked by 544.Cm packagesystem . 545.El 546.Sh ENVIRONMENT 547Optional variables: 548.Bl -tag -width ".Ev TARGET_ARCH" 549.It Ev OSRELEASE 550Optional base name for generated media images when invoking the 551.Cm install 552target 553.Pq e.g., FreeBSD-12.1-RELEASE-amd64 . 554Defaults to the output of 555.Ic `uname -s`-`uname -r`-`uname -p` 556within the chroot. 557.It Ev WORLDDIR 558Location of a directory containing the src tree. 559By default, the directory 560above the one containing the makefile 561.Pq Pa src . 562.It Ev PORTSDIR 563Location of a directory containing the ports tree. 564By default, 565.Pa /usr/ports . 566If it is unset or cannot be found, ports will not be included in the release. 567.It Ev NOPORTS 568If defined, the Ports Collection will be omitted from the release. 569.It Ev NOSRC 570If set, do not include system source code in the release. 571.It Ev TARGET 572The target hardware platform. 573This is analogous to the 574.Dq Nm uname Fl m 575output. 576This is necessary to cross-build some target architectures. 577For example, cross-building for ARM64 machines requires 578.Ev TARGET_ARCH Ns = Ns Li aarch64 579and 580.Ev TARGET Ns = Ns Li arm64 . 581If not set, 582.Ev TARGET 583defaults to the current hardware platform. 584.It Ev TARGET_ARCH 585The target machine processor architecture. 586This is analogous to the 587.Dq Nm uname Fl p 588output. 589Set this to cross-build for a different architecture. 590If not set, 591.Ev TARGET_ARCH 592defaults to the current machine architecture, unless 593.Ev TARGET 594is also set, in which case it defaults to the appropriate 595value for that platform. 596Typically, one only needs to set 597.Ev TARGET . 598.El 599.Sh FILES 600.Bl -tag -compact -width Pa 601.It Pa /usr/doc/Makefile 602.It Pa /usr/doc/share/mk/doc.project.mk 603.It Pa /usr/ports/Mk/bsd.port.mk 604.It Pa /usr/ports/Mk/bsd.sites.mk 605.It Pa /usr/share/examples/etc/make.conf 606.It Pa /usr/src/Makefile 607.It Pa /usr/src/Makefile.inc1 608.It Pa /usr/src/release/Makefile 609.It Pa /usr/src/release/Makefile.vm 610.It Pa /usr/src/release/release.sh 611.It Pa /usr/src/release/release.conf.sample 612.It Pa /usr/src/release/tools/*.conf 613.It Pa /usr/src/release/tools/vmimage.subr 614.El 615.Sh EXAMPLES 616The following sequence of commands can be used to build a 617.Dq "-CURRENT snapshot": 618.Bd -literal -offset indent 619cd /usr 620git clone -b main https://git.freebsd.org/src.git src 621cd src 622make buildworld buildkernel 623cd release 624make obj 625make release 626make install DESTDIR=/var/freebsd-snapshot 627.Ed 628.Pp 629After running these commands, all produced distribution files (tarballs 630for FTP, CD-ROM images, etc.) are available in the 631.Pa /var/freebsd-snapshot 632directory. 633.Pp 634The following sequence of commands can be used to build a 635.Dq "-CURRENT snapshot" 636in a clean environment, including ports and documentation: 637.Bd -literal -offset indent 638cd /usr/src/release 639sh release.sh 640.Ed 641.Pp 642Optionally, a configuration file can be used to customize the release build: 643.Bd -literal -offset indent 644cd /usr/src/release 645sh release.sh -c $HOME/release.conf 646.Ed 647.Pp 648Configuration files specific to various supported embedded systems, such as 649the Raspberry Pi, exist in the directory corresponding to the 650.Va TARGET 651.Xr make 1 652variable. 653For example, to build an image for the Raspberry Pi: 654.Bd -literal -offset indent 655cd /usr/src/release 656sh release.sh -c arm/RPI-B.conf 657.Ed 658.Pp 659To build an image for the Raspberry Pi 3: 660.Bd -literal -offset indent 661cd /usr/src/release 662sh release.sh -c arm64/RPI3.conf 663.Ed 664.Pp 665After running these commands, all prepared release files are available in the 666.Pa /scratch 667directory. 668The target directory can be changed by specifying the 669.Va CHROOTDIR 670variable in 671.Li release.conf . 672.Sh COMPATIBILITY 673The reldoc target was removed in commit f61e92ca5a23, and 674.Ev DOCDIR , 675.Ev DOCBRANCH , 676.Ev DOC_UPDATE_SKIP , 677and 678.Ev NODOC 679are therefore no longer supported. 680.Sh SEE ALSO 681.Xr cc 1 , 682.Xr git 1 Pq Pa ports/devel/git , 683.Xr install 1 , 684.Xr make 1 , 685.Xr mkimg 1 , 686.Xr uname 1 , 687.Xr md 4 , 688.Xr make.conf 5 , 689.Xr build 7 , 690.Xr ports 7 , 691.Xr chroot 8 , 692.Xr mtree 8 , 693.Xr sysctl 8 694.Rs 695.%T "FreeBSD Release Engineering" 696.%U https://docs.freebsd.org/en/articles/freebsd-releng/ 697.Re 698.Rs 699.%T "FreeBSD Developers' Handbook" 700.%U https://docs.freebsd.org/en/books/developers-handbook/ 701.Re 702.Sh HISTORY 703.Fx 7041.x 705used a manual checklist, compiled by 706.An Rod Grimes , 707to produce a release. 708Apart from being incomplete, the list put a lot of specific demands on 709available file systems and was quite torturous to execute. 710.Pp 711As part of the 712.Fx 2.0 713release engineering effort, significant 714effort was spent getting 715.Pa src/release/Makefile 716into a shape where it could at least automate most of the tediousness 717of building a release in a sterile environment. 718.Pp 719For the 720.Fx 9.0 721release, 722.Pa src/release/Makefile 723was overhauled and the wrapper script 724.Pa src/release/generate-release.sh 725introduced to support the introduction of a new installer. 726.Pp 727For the 728.Fx 9.2 729release, 730.Pa src/release/release.sh 731was introduced to support per-build configuration files. 732.Pa src/release/release.sh 733is heavily based on the 734.Pa src/release/generate-release.sh 735script. 736.Pp 737At near 1000 revisions spread over multiple branches, the 738.Xr git 1 739log of 740.Pa src/release/Makefile 741contains a vivid historical record of some 742of the hardships release engineers go through. 743.Sh AUTHORS 744.Pa src/release/Makefile 745was originally written by 746.An -nosplit 747.An Rod Grimes , 748.An Jordan Hubbard , 749and 750.An Poul-Henning Kamp . 751.Pp 752This manual page was originally written by 753.An Murray Stokely Aq Mt murray@FreeBSD.org . 754.Pp 755It was updated by 756.An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org 757to include the 758.Fa generate-release.sh 759script used for the 760.Fx 9.0 761release cycle. 762.Pp 763It was later updated by 764.An Glen Barber Aq Mt gjb@FreeBSD.org 765to include the 766.Fa release.sh 767script used for the 768.Fx 9.2 769release cycle. 770