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.
260 The command run to obtain the source trees.
262 .Qq Cm svn checkout .
263 .It Va CHROOTBUILD_SKIP
271 build environment setup are skipped.
272 This is intended solely for cases where the
274 userland are provided by alternate means.
275 .It Va SRC_UPDATE_SKIP
276 Set to a non-empty value to prevent checkout or update of
280 This is intended for use only when
282 is expected to exist by alternative means.
283 .It Va DOC_UPDATE_SKIP
284 Set to a non-empty value to prevent checkout or update of
288 This is intended for use only when
290 is expected to exist by alternative means.
291 .It Va PORTS_UPDATE_SKIP
292 Set to a non-empty value to prevent checkout or update of
296 This is intended for use only when
298 is expected to exist by alternative means.
303 variables are relevant only to release builds for embedded systems:
306 Set to a non-null value to enable functionality for embedded device
308 .Pq This option is considered highly experimental.
319 must also be defined.
320 When the build environment is created,
322 runs a separate build script located in an architecture-specific
324 .Pa src/release/${XDEV}/ .
326 Set to the list of any ports that are required for the target device
331 port is built by default.
333 Set to the source URL for the Crochet build tool.
335 Set to the subversion branch from
341 Set to the source URL of u-boot, if required.
343 Set to the subversion branch from
349 Set to the target directory within
352 .Va ${UBOOTSRC}/${UBOOTBRANCH} .
354 .Sh VIRTUAL MACHINE DISK IMAGES
357 variables are relevant only to virtual machine disk image builds:
360 Set to a non-null value to build virtual machine disk images as part
361 of the release build.
363 may also be specified as an envirionment variable passed to
368 version 20140927 or later.
369 .It Va WITH_COMPRESSED_VMIMAGES
370 Set to a non-null value to compress the virtual machine disk images with
376 Note that compressing virtual machine disk images may take a very long
377 time on some systems.
379 Set to change the name of the resulting virtual machine disk image file.
383 Set to change the size of the virtual machine disk capacity.
390 Virtual machine disk images are, by default, created as sparse images.
392 .Va WITH_COMPRESSED_VMIMAGES
393 is used, the resulting files compressed with
395 compress to roughly the same size, regardless of the specified disk image
398 Set to the target virtual disk image format(s) to create.
400 .Va vhdf , Va vmdk , Va qcow2 ,
406 for valid format values
407 .Pq requires version 20140927 or later .
410 For a list of supported
413 .Pq including cloud hosting provider formats
414 along with a brief description, run:
415 .Bd -literal -offset indent
417 make -C release list-vmtargets
419 .Sh CLOUD HOSTING MACHINE IMAGES
422 release build tools support building virtual machine images for various
423 cloud hosting providers, each with their own specific configuration to
424 include support for each hosting provider by default.
428 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 envirionment 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 PC98 machines requires
616 .Ev TARGET_ARCH Ns = Ns Li i386
618 .Ev TARGET Ns = Ns Li pc98 .
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 After running these commands, all prepared release files are available in the
693 The target directory can be changed by specifying the
701 .Xr svn 1 Pq Pa ports/devel/subversion ,
711 .%T "FreeBSD Release Engineering"
712 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
715 .%T "FreeBSD Release Engineering of Third Party Packages"
716 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng-packages/
719 .%T "FreeBSD Developers' Handbook"
720 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
725 used a manual checklist, compiled by
727 to produce a release.
728 Apart from being incomplete, the list put a lot of specific demands on
729 available file systems and was quite torturous to execute.
733 release engineering effort, significant
734 effort was spent getting
735 .Pa src/release/Makefile
736 into a shape where it could at least automate most of the tediousness
737 of building a release in a sterile environment.
742 .Pa src/release/Makefile
743 was overhauled and the wrapper script
744 .Pa src/release/generate-release.sh
745 introduced to support the introduction of a new installer.
750 .Pa src/release/release.sh
751 was introduced to support per-build configuration files.
752 .Pa src/release/release.sh
753 is heavily based on the
754 .Pa src/release/generate-release.sh
757 At near 1000 revisions spread over multiple branches, the
760 .Pa src/release/Makefile
761 contains a vivid historical record of some
762 of the hardships release engineers go through.
764 .Pa src/release/Makefile
765 was originally written by
770 .An Poul-Henning Kamp .
772 This manual page was originally written by
773 .An Murray Stokely Aq murray@FreeBSD.org .
776 .An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org
778 .Fa generate-release.sh
783 It was later updated by
784 .An Glen Barber Aq gjb@FreeBSD.org