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 .
411 .Pq Pa src/release/Makefile
413 Most developers will only be concerned with the
418 .\" XXX: Some sort of introduction to this list? All the others have one.
419 .Bl -tag -width ".Cm packagesystem"
421 Meta-target to build all release media and distributions applicable to this
424 Copy all produced release media to
427 Builds installation CD-ROM images.
430 (memory disk) device driver be present in the kernel
431 (either by being compiled in or available as a module).
432 This target produces files called
438 Builds installation DVD-ROM images.
441 (memory disk) device driver be present in the kernel
442 (either by being compiled in or available as a module).
443 This target produces the
447 Builds an installation memory stick image named
449 Not applicable on all platforms.
453 device driver be present in the kernel
454 .Pq either by being compiled in or available as a module .
458 with the exception that the installation distribution sets
461 Creates a directory named
463 containing the distribution files used in network installations
464 and suitable for upload to an FTP mirror.
466 Creates virtual machine disk images in various formats.
472 envirionment variable to be set to a non-null value.
475 Major subtargets called by targets above:
476 .Bl -tag -width ".Cm packagesystem"
478 Generates all the distribution archives
479 .Pq base, kernel, ports, doc
480 applicable on this platform.
482 Builds a bootable installation system containing all the distribution files
485 target, and suitable for imaging by the
492 Builds the release documentation.
493 This includes the release notes,
494 hardware guide, and installation instructions.
495 Other documentation, such as the Handbook,
503 .Bl -tag -width ".Ev TARGET_ARCH"
505 Optional base name for generated media images
506 .Pq e.g., FreeBSD-9.0-RC2-amd64 .
507 Defaults to the output of
508 .Ic `uname -s`-`uname -r`-`uname -p`
511 Location of a directory containing the src tree.
512 By default, the directory
513 above the one containing the makefile
516 Location of a directory containing the ports tree.
519 If it is unset or cannot be found, ports will not be included in the release.
521 Location of a directory containing the doc tree.
524 If it is unset or cannot be found, most documentation will not be included in
529 If defined, the Ports Collection will be omitted from the release.
531 If set, do not include system source code in the release.
533 If defined, the XML-based documentation from the
535 Documentation Project will not be built.
538 distribution will still be created with the minimal documentation set
542 The target hardware platform.
543 This is analogous to the
546 This is necessary to cross-build some target architectures.
547 For example, cross-building for PC98 machines requires
548 .Ev TARGET_ARCH Ns = Ns Li i386
550 .Ev TARGET Ns = Ns Li pc98 .
553 defaults to the current hardware platform.
555 The target machine processor architecture.
556 This is analogous to the
559 Set this to cross-build for a different architecture.
562 defaults to the current machine architecture, unless
564 is also set, in which case it defaults to the appropriate
565 value for that platform.
566 Typically, one only needs to set
570 .Bl -tag -compact -width Pa
571 .It Pa /usr/doc/Makefile
572 .It Pa /usr/doc/share/mk/doc.project.mk
573 .It Pa /usr/ports/Mk/bsd.port.mk
574 .It Pa /usr/ports/Mk/bsd.sites.mk
575 .It Pa /usr/share/examples/etc/make.conf
576 .It Pa /usr/src/Makefile
577 .It Pa /usr/src/Makefile.inc1
578 .It Pa /usr/src/release/Makefile
579 .It Pa /usr/src/release/release.sh
580 .It Pa /usr/src/release/release.conf.sample
583 The following sequence of commands can be used to build a
584 .Dq "-CURRENT snapshot":
585 .Bd -literal -offset indent
587 svn co svn://svn.freebsd.org/base/head src
589 make buildworld buildkernel
592 make install DESTDIR=/var/freebsd-snapshot
595 After running these commands, all produced distribution files (tarballs
596 for FTP, CD-ROM images, etc.) are available in the
597 .Pa /var/freebsd-snapshot
600 The following sequence of commands can be used to build a
601 .Dq "-CURRENT snapshot"
602 in a clean environment, including ports and documentation:
603 .Bd -literal -offset indent
608 Optionally, a configuration file can be used customize the release build,
609 such as the subversion revision to use, the branch of the subversion tree for
614 .Bd -literal -offset indent
616 sh release.sh -c $HOME/release.conf
619 After running these commands, all prepared release files are available in the
622 The target directory can be changed by specifying the
630 .Xr svn 1 Pq Pa ports/devel/subversion ,
640 .%T "FreeBSD Release Engineering"
641 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
644 .%T "FreeBSD Release Engineering of Third Party Packages"
645 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng-packages/
648 .%T "FreeBSD Developers' Handbook"
649 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
654 used a manual checklist, compiled by
656 to produce a release.
657 Apart from being incomplete, the list put a lot of specific demands on
658 available file systems and was quite torturous to execute.
662 release engineering effort, significant
663 effort was spent getting
664 .Pa src/release/Makefile
665 into a shape where it could at least automate most of the tediousness
666 of building a release in a sterile environment.
671 .Pa src/release/Makefile
672 was overhauled and the wrapper script
673 .Pa src/release/generate-release.sh
674 introduced to support the introduction of a new installer.
679 .Pa src/release/release.sh
680 was introduced to support per-build configuration files.
681 .Pa src/release/release.sh
682 is heavily based on the
683 .Pa src/release/generate-release.sh
686 At near 1000 revisions spread over multiple branches, the
689 .Pa src/release/Makefile
690 contains a vivid historical record of some
691 of the hardships release engineers go through.
693 .Pa src/release/Makefile
694 was originally written by
699 .An Poul-Henning Kamp .
701 This manual page was originally written by
702 .An Murray Stokely Aq murray@FreeBSD.org .
705 .An Nathan Whitehorn Aq nwhitehorn@FreeBSD.org
707 .Fa generate-release.sh
712 It was later updated by
713 .An Glen Barber Aq gjb@FreeBSD.org