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
317 .Va EMBEDDED_TARGET_ARCH
318 must also be defined.
319 When the build environment is created,
321 runs a separate build script located in an architecture-specific
323 .Pa src/release/${EMBEDDED_TARGET}/ .
325 Set to the list of any ports that are required for the target device
330 port is built by default.
331 .It Va EMBEDDED_TARGET
332 When set, its value is passed to
336 .Pq value of Cm uname Fl m
337 to cross build the target userland.
338 .It Va EMBEDDED_TARGET_ARCH
339 When set, its value is passed to
343 .Pq value of Cm uname Fl p
344 to cross build the target userland.
346 .Sh VIRTUAL MACHINE DISK IMAGES
349 variables are relevant only to virtual machine disk image builds:
352 Set to a non-null value to build virtual machine disk images as part
353 of the release build.
355 may also be specified as an envirionment variable passed to
360 version 20140927 or later.
361 .It Va WITH_COMPRESSED_VMIMAGES
362 Set to a non-null value to compress the virtual machine disk images with
368 Note that compressing virtual machine disk images may take a very long
369 time on some systems.
371 Set to change the name of the resulting virtual machine disk image file.
375 Set to change the size of the virtual machine disk capacity.
382 Virtual machine disk images are, by default, created as sparse images.
384 .Va WITH_COMPRESSED_VMIMAGES
385 is used, the resulting files compressed with
387 compress to roughly the same size, regardless of the specified disk image
390 Set to the target virtual disk image format(s) to create.
392 .Va vhdf , Va vmdk , Va qcow2 ,
398 for valid format values
399 .Pq requires version 20140927 or later .
402 For a list of supported
405 .Pq including cloud hosting provider formats
406 along with a brief description, run:
407 .Bd -literal -offset indent
409 make -C release list-vmtargets
411 .Sh CLOUD HOSTING MACHINE IMAGES
414 release build tools support building virtual machine images for various
415 cloud hosting providers, each with their own specific configuration to
416 include support for each hosting provider by default.
420 environment variables are supported:
424 Set to a list of one or more cloud hosting providers, enclosed in quotes.
428 .It Va WITH_CLOUDWARE
429 Set to a non-empty value to enable building virtual machine images
430 for various cloud hosting providers.
440 variables can be added to
442 and used in conjunction with
445 For a list of supported
448 .Bd -literal -offset indent
450 make -C release list-cloudware
454 .Pq Pa src/release/Makefile
456 Most developers will only be concerned with the
461 .\" XXX: Some sort of introduction to this list? All the others have one.
462 .Bl -tag -width ".Cm packagesystem"
464 Meta-target to build all release media and distributions applicable to this
467 Copy all produced release media to
470 Builds installation CD-ROM images.
473 (memory disk) device driver be present in the kernel
474 (either by being compiled in or available as a module).
475 This target produces files called
481 Builds installation DVD-ROM images.
484 (memory disk) device driver be present in the kernel
485 (either by being compiled in or available as a module).
486 This target produces the
490 Builds an installation memory stick image named
492 Not applicable on all platforms.
496 device driver be present in the kernel
497 .Pq either by being compiled in or available as a module .
501 with the exception that the installation distribution sets
504 Creates a directory named
506 containing the distribution files used in network installations
507 and suitable for upload to an FTP mirror.
509 Creates virtual machine disk images in various formats.
515 envirionment variable to be set to a non-null value.
519 virtual machine images for various cloud hosting providers.
521 .Qq CLOUD HOSTING MACHINE IMAGES
522 for implementation details.
523 .It Cm list-cloudware
524 Displays the list of valid
527 .It Cm list-vmtargets
528 Displays the list of valid
535 Major subtargets called by targets above:
536 .Bl -tag -width ".Cm packagesystem"
538 Generates all the distribution archives
539 .Pq base, kernel, ports, doc
540 applicable on this platform.
542 Builds a bootable installation system containing all the distribution files
545 target, and suitable for imaging by the
552 Builds the release documentation.
553 This includes the release notes,
554 hardware guide, and installation instructions.
555 Other documentation, such as the Handbook,
563 .Bl -tag -width ".Ev TARGET_ARCH"
565 Optional base name for generated media images
566 .Pq e.g., FreeBSD-9.0-RC2-amd64 .
567 Defaults to the output of
568 .Ic `uname -s`-`uname -r`-`uname -p`
571 Location of a directory containing the src tree.
572 By default, the directory
573 above the one containing the makefile
576 Location of a directory containing the ports tree.
579 If it is unset or cannot be found, ports will not be included in the release.
581 Location of a directory containing the doc tree.
584 If it is unset or cannot be found, most documentation will not be included in
589 If defined, the Ports Collection will be omitted from the release.
591 If set, do not include system source code in the release.
593 If defined, the XML-based documentation from the
595 Documentation Project will not be built.
598 distribution will still be created with the minimal documentation set
602 The target hardware platform.
603 This is analogous to the
606 This is necessary to cross-build some target architectures.
607 For example, cross-building for PC98 machines requires
608 .Ev TARGET_ARCH Ns = Ns Li i386
610 .Ev TARGET Ns = Ns Li pc98 .
613 defaults to the current hardware platform.
615 The target machine processor architecture.
616 This is analogous to the
619 Set this to cross-build for a different architecture.
622 defaults to the current machine architecture, unless
624 is also set, in which case it defaults to the appropriate
625 value for that platform.
626 Typically, one only needs to set
630 .Bl -tag -compact -width Pa
631 .It Pa /usr/doc/Makefile
632 .It Pa /usr/doc/share/mk/doc.project.mk
633 .It Pa /usr/ports/Mk/bsd.port.mk
634 .It Pa /usr/ports/Mk/bsd.sites.mk
635 .It Pa /usr/share/examples/etc/make.conf
636 .It Pa /usr/src/Makefile
637 .It Pa /usr/src/Makefile.inc1
638 .It Pa /usr/src/release/Makefile
639 .It Pa /usr/src/release/Makefile.vm
640 .It Pa /usr/src/release/release.sh
641 .It Pa /usr/src/release/release.conf.sample
642 .It Pa /usr/src/release/tools/*.conf
643 .It Pa /usr/src/release/tools/vmimage.subr
646 The following sequence of commands can be used to build a
647 .Dq "-CURRENT snapshot":
648 .Bd -literal -offset indent
650 svn co svn://svn.freebsd.org/base/head src
652 make buildworld buildkernel
655 make install DESTDIR=/var/freebsd-snapshot
658 After running these commands, all produced distribution files (tarballs
659 for FTP, CD-ROM images, etc.) are available in the
660 .Pa /var/freebsd-snapshot
663 The following sequence of commands can be used to build a
664 .Dq "-CURRENT snapshot"
665 in a clean environment, including ports and documentation:
666 .Bd -literal -offset indent
671 Optionally, a configuration file can be used customize the release build,
672 such as the subversion revision to use, the branch of the subversion tree for
677 .Bd -literal -offset indent
679 sh release.sh -c $HOME/release.conf
682 After running these commands, all prepared release files are available in the
685 The target directory can be changed by specifying the
693 .Xr svn 1 Pq Pa ports/devel/subversion ,
703 .%T "FreeBSD Release Engineering"
704 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
707 .%T "FreeBSD Release Engineering of Third Party Packages"
708 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng-packages/
711 .%T "FreeBSD Developers' Handbook"
712 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
717 used a manual checklist, compiled by
719 to produce a release.
720 Apart from being incomplete, the list put a lot of specific demands on
721 available file systems and was quite torturous to execute.
725 release engineering effort, significant
726 effort was spent getting
727 .Pa src/release/Makefile
728 into a shape where it could at least automate most of the tediousness
729 of building a release in a sterile environment.
734 .Pa src/release/Makefile
735 was overhauled and the wrapper script
736 .Pa src/release/generate-release.sh
737 introduced to support the introduction of a new installer.
742 .Pa src/release/release.sh
743 was introduced to support per-build configuration files.
744 .Pa src/release/release.sh
745 is heavily based on the
746 .Pa src/release/generate-release.sh
749 At near 1000 revisions spread over multiple branches, the
752 .Pa src/release/Makefile
753 contains a vivid historical record of some
754 of the hardships release engineers go through.
756 .Pa src/release/Makefile
757 was originally written by
762 .An Poul-Henning Kamp .
764 This manual page was originally written by
765 .An Murray Stokely Aq murray@FreeBSD.org .
768 .An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org
770 .Fa generate-release.sh
775 It was later updated by
776 .An Glen Barber Aq gjb@FreeBSD.org