1 .\" Copyright (c) 2002 Murray Stokely <murray@FreeBSD.org>
2 .\" All rights reserved.
4 .\" Redistribution and use in source and binary forms, with or without
5 .\" modification, are permitted provided that the following conditions
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.
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
32 .Nd "release building infrastructure"
35 provides a complete build environment suitable for users to make
39 All of the tools necessary to build a release are available from the
41 source code repository in
43 A complete release can actually be built with only a single command,
44 including the creation of ISO images suitable for burning to CD-ROM,
45 memory stick images, and an FTP install directory.
46 This command is aptly named
47 .Dq Li "make release" .
49 For some users, it may be desirable to provide an absolutely clean
50 build environment, with no local modifications to the source tree or to
52 and with clean checkouts of specific versions of the doc, src, and ports
54 For this purpose, a script
55 .Pq Pa src/release/release.sh
56 is provided to automate these checkouts and then execute
61 Before attempting to build a release, the user is expected to be
62 familiar with the contents of
64 and should have experience upgrading systems from source.
66 The release build process requires that
68 be populated with the output of
69 .Dq Li "make buildworld"
71 .Dq Li "make buildkernel" .
72 This is necessary to provide the object files for the release or, when
75 so that the object files for a complete system can be installed into a clean
79 If the target release build is for a different architecture or machine type,
84 variables must be used.
87 variables for more information.
89 The release procedure on some architectures may also require that the
91 (memory disk) device driver be present in the kernel
92 .Pq either by being compiled in or available as a module .
94 This document does not cover source code management, quality
95 assurance, or other aspects of the release engineering process.
96 .Sh CLEAN RELEASE GENERATION
99 are produced in a totally clean environment to
100 ensure consistency between the versions of the src, ports, and doc trees
101 and to avoid contamination from the host system
102 .Po such as local patches, changes
107 This is accomplished using the wrapper script
108 .Pa src/release/release.sh .
111 .Op Fl c Ar release.conf
122 .Dq Li "make buildworld"
124 .Dq Li "make installworld"
129 .Dq Li "make release"
132 environment and places the result in
137 configuration file supports the following variables:
140 The directory within which the release will be built.
141 .It Va CHROOT_MAKEENV
144 arguments to pass through, which directly affect the
145 tuning of the build chroot.
149 host used to check out the various trees.
151 .Pa svn://svn.FreeeBSD.org .
171 The target machine type for cross-building a release.
173 The target machine architecture for cross-building a release.
175 For the supported list of
179 combinations, consult the output of
184 The target kernel configuration to use.
189 entries may be specified.
193 to use for the release build.
196 to prevent polluting the release with local system changes.
200 to use for the release build.
203 to prevent polluting the release with local system changes.
205 Additional flags to pass to
208 Additional flags to pass to
213 Defaults to setting the number of
217 to the number of CPUs available on a SMP-capable system.
219 Additional flags to pass to
224 Defaults to setting the number of
228 to half the number of CPUs available on a SMP-capable system.
230 Set to a non-empty value to skip the
237 distribution package from being created.
239 Set to a non-empty value to skip the
246 distribution package from being created.
247 Setting this also sets
250 Set to a non-empty value to include the
253 .It Va WITH_COMPRESSED_IMAGES
254 Set to a non-empty value to compress the release images with
258 images are not removed.
259 .It Va XZ_THREADS Pq Vt int
260 Set to the number of threads
262 should use when compressing images.
267 which uses all available cores on the system.
269 The command run to obtain the source trees.
271 .Qq Cm svn checkout .
272 .It Va CHROOTBUILD_SKIP
280 build environment setup are skipped.
281 This is intended solely for cases where the
283 userland are provided by alternate means.
284 .It Va SRC_UPDATE_SKIP
285 Set to a non-empty value to prevent checkout or update of
289 This is intended for use only when
291 is expected to exist by alternative means.
292 .It Va DOC_UPDATE_SKIP
293 Set to a non-empty value to prevent checkout or update of
297 This is intended for use only when
299 is expected to exist by alternative means.
300 .It Va PORTS_UPDATE_SKIP
301 Set to a non-empty value to prevent checkout or update of
305 This is intended for use only when
307 is expected to exist by alternative means.
312 variables are relevant only to release builds for embedded systems:
315 Set to a non-null value to enable functionality for embedded device
326 .Va EMBEDDED_TARGET_ARCH
327 must also be defined.
328 When the build environment is created,
330 runs a separate build script located in an architecture-specific
332 .Pa src/release/${EMBEDDED_TARGET}/ .
334 Set to the list of any ports that are required for the target device
339 port is built by default.
340 .It Va EMBEDDED_TARGET
341 When set, its value is passed to
345 .Pq value of Cm uname Fl m
346 to cross build the target userland.
347 .It Va EMBEDDED_TARGET_ARCH
348 When set, its value is passed to
352 .Pq value of Cm uname Fl p
353 to cross build the target userland.
355 .Sh VIRTUAL MACHINE DISK IMAGES
358 variables are relevant only to virtual machine disk image builds:
361 Set to a non-null value to build virtual machine disk images as part
362 of the release build.
364 may also be specified as an environment variable passed to
369 version 20140927 or later.
370 .It Va WITH_COMPRESSED_VMIMAGES
371 Set to a non-null value to compress the virtual machine disk images with
377 Note that compressing virtual machine disk images may take a very long
378 time on some systems.
380 Set to change the name of the resulting virtual machine disk image file.
384 Set to change the size of the virtual machine disk capacity.
391 Virtual machine disk images are, by default, created as sparse images.
393 .Va WITH_COMPRESSED_VMIMAGES
394 is used, the resulting files compressed with
396 compress to roughly the same size, regardless of the specified disk image
399 Set to the target virtual disk image format(s) to create.
401 .Va vhdf , Va vmdk , Va qcow2 ,
407 for valid format values
408 .Pq requires version 20140927 or later .
411 For a list of supported
414 .Pq including cloud hosting provider formats
415 along with a brief description, run:
416 .Bd -literal -offset indent
418 make -C release list-vmtargets
420 .Sh CLOUD HOSTING MACHINE IMAGES
423 release build tools support building virtual machine images for various
424 cloud hosting providers, each with their own specific configuration to
425 include support for each hosting provider by default.
429 environment variables are supported:
432 Set to a list of one or more cloud hosting providers, enclosed in quotes.
436 .It Va WITH_CLOUDWARE
437 Set to a non-empty value to enable building virtual machine images
438 for various cloud hosting providers.
448 variables can be added to
450 and used in conjunction with
453 For a list of supported
456 .Bd -literal -offset indent
458 make -C release list-cloudware
462 .Pq Pa src/release/Makefile
464 Most developers will only be concerned with the
469 .\" XXX: Some sort of introduction to this list? All the others have one.
470 .Bl -tag -width ".Cm packagesystem"
472 Meta-target to build all release media and distributions applicable to this
475 Copy all produced release media to
478 Builds installation CD-ROM images.
481 (memory disk) device driver be present in the kernel
482 (either by being compiled in or available as a module).
483 This target produces files called
489 Builds installation DVD-ROM images.
492 (memory disk) device driver be present in the kernel
493 (either by being compiled in or available as a module).
494 This target produces the
498 Builds an installation memory stick image named
500 Not applicable on all platforms.
504 device driver be present in the kernel
505 .Pq either by being compiled in or available as a module .
509 with the exception that the installation distribution sets
512 Creates a directory named
514 containing the distribution files used in network installations
515 and suitable for upload to an FTP mirror.
517 Creates virtual machine disk images in various formats.
523 environment variable to be set to a non-null value.
527 virtual machine images for various cloud hosting providers.
529 .Qq CLOUD HOSTING MACHINE IMAGES
530 for implementation details.
531 .It Cm list-cloudware
532 Displays the list of valid
535 .It Cm list-vmtargets
536 Displays the list of valid
543 Major subtargets called by targets above:
544 .Bl -tag -width ".Cm packagesystem"
546 Generates all the distribution archives
547 .Pq base, kernel, ports, doc
548 applicable on this platform.
550 Builds a bootable installation system containing all the distribution files
553 target, and suitable for imaging by the
560 Builds the release documentation.
561 This includes the release notes,
562 hardware guide, and installation instructions.
563 Other documentation, such as the Handbook,
571 .Bl -tag -width ".Ev TARGET_ARCH"
573 Optional base name for generated media images
574 .Pq e.g., FreeBSD-9.0-RC2-amd64 .
575 Defaults to the output of
576 .Ic `uname -s`-`uname -r`-`uname -p`
579 Location of a directory containing the src tree.
580 By default, the directory
581 above the one containing the makefile
584 Location of a directory containing the ports tree.
587 If it is unset or cannot be found, ports will not be included in the release.
589 Location of a directory containing the doc tree.
592 If it is unset or cannot be found, most documentation will not be included in
597 If defined, the Ports Collection will be omitted from the release.
599 If set, do not include system source code in the release.
601 If defined, the XML-based documentation from the
603 Documentation Project will not be built.
606 distribution will still be created with the minimal documentation set
610 The target hardware platform.
611 This is analogous to the
614 This is necessary to cross-build some target architectures.
615 For example, cross-building for ARM64 machines requires
616 .Ev TARGET_ARCH Ns = Ns Li aarch64
618 .Ev TARGET Ns = Ns Li arm64 .
621 defaults to the current hardware platform.
623 The target machine processor architecture.
624 This is analogous to the
627 Set this to cross-build for a different architecture.
630 defaults to the current machine architecture, unless
632 is also set, in which case it defaults to the appropriate
633 value for that platform.
634 Typically, one only needs to set
638 .Bl -tag -compact -width Pa
639 .It Pa /usr/doc/Makefile
640 .It Pa /usr/doc/share/mk/doc.project.mk
641 .It Pa /usr/ports/Mk/bsd.port.mk
642 .It Pa /usr/ports/Mk/bsd.sites.mk
643 .It Pa /usr/share/examples/etc/make.conf
644 .It Pa /usr/src/Makefile
645 .It Pa /usr/src/Makefile.inc1
646 .It Pa /usr/src/release/Makefile
647 .It Pa /usr/src/release/Makefile.vm
648 .It Pa /usr/src/release/release.sh
649 .It Pa /usr/src/release/release.conf.sample
650 .It Pa /usr/src/release/tools/*.conf
651 .It Pa /usr/src/release/tools/vmimage.subr
654 The following sequence of commands can be used to build a
655 .Dq "-CURRENT snapshot":
656 .Bd -literal -offset indent
658 svn co svn://svn.freebsd.org/base/head src
660 make buildworld buildkernel
663 make install DESTDIR=/var/freebsd-snapshot
666 After running these commands, all produced distribution files (tarballs
667 for FTP, CD-ROM images, etc.) are available in the
668 .Pa /var/freebsd-snapshot
671 The following sequence of commands can be used to build a
672 .Dq "-CURRENT snapshot"
673 in a clean environment, including ports and documentation:
674 .Bd -literal -offset indent
679 Optionally, a configuration file can be used customize the release build,
680 such as the subversion revision to use, the branch of the subversion tree for
685 .Bd -literal -offset indent
687 sh release.sh -c $HOME/release.conf
690 Configuration files specific to various supported embedded systems, such as
691 the Raspberry Pi, exist in the directory corresponding to the
695 For example, to build an image for the Raspberry Pi:
696 .Bd -literal -offset indent
698 sh release.sh -c arm/RPI-B.conf
701 To build an image for the Raspberry Pi 3:
702 .Bd -literal -offset indent
704 sh release.sh -c arm64/RPI3.conf
707 After running these commands, all prepared release files are available in the
710 The target directory can be changed by specifying the
718 .Xr svn 1 Pq Pa ports/devel/subversion ,
728 .%T "FreeBSD Release Engineering"
729 .%U https://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/freebsd-releng/
732 .%T "FreeBSD Developers' Handbook"
733 .%U https://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
738 used a manual checklist, compiled by
740 to produce a release.
741 Apart from being incomplete, the list put a lot of specific demands on
742 available file systems and was quite torturous to execute.
746 release engineering effort, significant
747 effort was spent getting
748 .Pa src/release/Makefile
749 into a shape where it could at least automate most of the tediousness
750 of building a release in a sterile environment.
755 .Pa src/release/Makefile
756 was overhauled and the wrapper script
757 .Pa src/release/generate-release.sh
758 introduced to support the introduction of a new installer.
763 .Pa src/release/release.sh
764 was introduced to support per-build configuration files.
765 .Pa src/release/release.sh
766 is heavily based on the
767 .Pa src/release/generate-release.sh
770 At near 1000 revisions spread over multiple branches, the
773 .Pa src/release/Makefile
774 contains a vivid historical record of some
775 of the hardships release engineers go through.
777 .Pa src/release/Makefile
778 was originally written by
783 .An Poul-Henning Kamp .
785 This manual page was originally written by
786 .An Murray Stokely Aq Mt murray@FreeBSD.org .
789 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
791 .Fa generate-release.sh
796 It was later updated by
797 .An Glen Barber Aq Mt gjb@FreeBSD.org