share/man/man7/release.7

   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 March 28, 2018
  28 .Dt RELEASE 7
  29 .Os
  30 .Sh NAME
  31 .Nm release
  32 .Nd "release building infrastructure"
  33 .Sh DESCRIPTION
  34 .Fx
  35 provides a complete build environment suitable for users to make
  36 full releases of the
  37 .Fx
  38 operating system.
  39 All of the tools necessary to build a release are available from the
  40 .Fx
  41 source code repository in
  42 .Pa src/release .
  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" .
  48 .Pp
  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
  51 .Xr make.conf 5 ,
  52 and with clean checkouts of specific versions of the doc, src, and ports
  53 trees.
  54 For this purpose, a script
  55 .Pq Pa src/release/release.sh
  56 is provided to automate these checkouts and then execute
  57 .Dq Li "make release"
  58 in a clean
  59 .Xr chroot 8 .
  60 .Pp
  61 Before attempting to build a release, the user is expected to be
  62 familiar with the contents of
  63 .Xr build 7 ,
  64 and should have experience upgrading systems from source.
  65 .Pp
  66 The release build process requires that
  67 .Pa /usr/obj
  68 be populated with the output of
  69 .Dq Li "make buildworld"
  70 and
  71 .Dq Li "make buildkernel" .
  72 This is necessary to provide the object files for the release or, when
  73 using
  74 .Pa release.sh ,
  75 so that the object files for a complete system can be installed into a clean
  76 .Xr chroot 8
  77 environment.
  78 .Pp
  79 If the target release build is for a different architecture or machine type,
  80 the
  81 .Va TARGET
  82 and
  83 .Va TARGET_ARCH
  84 variables must be used.
  85 See the supported
  86 .Fa release.conf
  87 variables for more information.
  88 .Pp
  89 The 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
  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
  97 Official releases of
  98 .Fx
  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
 103 to
 104 .Xr make.conf 5 ,
 105 etc.
 106 .Pc .
 107 This 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
 114 checks out the
 115 .Li src/ ,
 116 .Li ports/ ,
 117 and
 118 .Li doc/
 119 trees to
 120 .Va CHROOTDIR ,
 121 then calls
 122 .Dq Li "make buildworld"
 123 and
 124 .Dq Li "make installworld"
 125 to generate a
 126 .Xr chroot 8
 127 environment.
 128 Next,
 129 .Dq Li "make release"
 130 is run within the
 131 .Xr chroot 8
 132 environment and places the result in
 133 .Pa $CHROOTDIR/R .
 134 .Pp
 135 The optional
 136 .Fa release.conf
 137 configuration file supports the following variables:
 138 .Bl -tag -width Ev
 139 .It Va CHROOTDIR
 140 The directory within which the release will be built.
 141 .It Va CHROOT_MAKEENV
 142 Additional
 143 .Xr make 1
 144 arguments to pass through, which directly affect the
 145 tuning of the build chroot.
 146 .It Va SVNROOT
 147 The
 148 .Xr svn 1
 149 host used to check out the various trees.
 150 Defaults to
 151 .Pa svn://svn.FreeeBSD.org .
 152 .It Va SRCBRANCH
 153 The
 154 .Li src/
 155 branch to use.
 156 Defaults to
 157 .Va head/@rHEAD .
 158 .It Va DOCBRANCH
 159 The
 160 .Li doc/
 161 branch to use.
 162 Defaults to
 163 .Va head/@rHEAD .
 164 .It Va PORTBRANCH
 165 The
 166 .Li ports/
 167 branch to use.
 168 Defaults to
 169 .Va head/@rHEAD .
 170 .It Va TARGET
 171 The target machine type for cross-building a release.
 172 .It Va TARGET_ARCH
 173 The target machine architecture for cross-building a release.
 174 .Pp
 175 For the supported list of
 176 .Va TARGET
 177 and
 178 .Va TARGET_ARCH
 179 combinations, consult the output of
 180 .Dq make targets
 181 as documented in
 182 .Xr build 7 .
 183 .It Va KERNEL
 184 The target kernel configuration to use.
 185 Defaults to
 186 .Va GENERIC .
 187 Multiple
 188 .Va KERNEL
 189 entries may be specified.
 190 .It Va MAKE_CONF
 191 The
 192 .Xr make.conf 5
 193 to use for the release build.
 194 Defaults to
 195 .Fa /dev/null
 196 to prevent polluting the release with local system changes.
 197 .It Va SRC_CONF
 198 The
 199 .Xr src.conf 5
 200 to use for the release build.
 201 Defaults to
 202 .Fa /dev/null
 203 to prevent polluting the release with local system changes.
 204 .It Va MAKE_FLAGS
 205 Additional flags to pass to
 206 .Xr make 1 .
 207 .It Va WORLD_FLAGS
 208 Additional flags to pass to
 209 .Xr make 1
 210 during the
 211 .Dq buildworld
 212 phase.
 213 Defaults to setting the number of
 214 .Xr make 1
 215 jobs
 216 .Pq Ar -j
 217 to the number of CPUs available on a SMP-capable system.
 218 .It Va KERNEL_FLAGS
 219 Additional flags to pass to
 220 .Xr make 1
 221 during the
 222 .Dq buildkernel
 223 phase.
 224 Defaults to setting the number of
 225 .Xr make 1
 226 jobs
 227 .Pq Ar -j
 228 to half the number of CPUs available on a SMP-capable system.
 229 .It Va NODOC
 230 Set to a non-empty value to skip the
 231 .Li doc/
 232 tree checkout.
 233 When set,
 234 .Va NODOC
 235 will prevent the
 236 .Fa doc.txz
 237 distribution package from being created.
 238 .It Va NOPORTS
 239 Set to a non-empty value to skip the
 240 .Li ports/
 241 tree checkout.
 242 When set,
 243 .Va NOPORTS
 244 will prevent the
 245 .Fa ports.txz
 246 distribution package from being created.
 247 Setting this also sets
 248 .Va NODOC .
 249 .It Va WITH_DVD
 250 Set to a non-empty value to include the
 251 .Cm dvdrom
 252 target.
 253 .It Va WITH_COMPRESSED_IMAGES
 254 Set to a non-empty value to compress the release images with
 255 .Xr xz 1 .
 256 The original
 257 .Pq uncompressed
 258 images are not removed.
 259 .It Va XZ_THREADS Pq Vt int
 260 Set to the number of threads
 261 .Xr xz 1
 262 should use when compressing images.
 263 By default,
 264 .Va XZ_THREADS
 265 is set to
 266 .Va 0 ,
 267 which uses all available cores on the system.
 268 .It Va VCSCMD
 269 The command run to obtain the source trees.
 270 Defaults to
 271 .Qq Cm svn checkout .
 272 .It Va CHROOTBUILD_SKIP
 273 If defined, the
 274 .Li buildworld ,
 275 .Li installworld ,
 276 and
 277 .Li distribution
 278 stages of the
 279 .Xr chroot 8
 280 build environment setup are skipped.
 281 This is intended solely for cases where the
 282 .Xr chroot 8
 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
 286 .Fa /usr/src
 287 within the
 288 .Xr chroot 8 .
 289 This is intended for use only when
 290 .Fa /usr/src
 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
 294 .Fa /usr/doc
 295 within the
 296 .Xr chroot 8 .
 297 This is intended for use only when
 298 .Fa /usr/doc
 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
 302 .Fa /usr/ports
 303 within the
 304 .Xr chroot 8 .
 305 This is intended for use only when
 306 .Fa /usr/ports
 307 is expected to exist by alternative means.
 308 .El
 309 .Sh EMBEDDED BUILDS
 310 The following
 311 .Fa release.conf
 312 variables are relevant only to release builds for embedded systems:
 313 .Bl -tag -width Ev
 314 .It Va EMBEDDEDBUILD
 315 Set to a non-null value to enable functionality for embedded device
 316 release builds.
 317 .Pp
 318 When set,
 319 .Va WITH_DVD
 320 is unset, and
 321 .Va NODOC
 322 is defined.
 323 Additionally,
 324 .Va EMBEDDED_TARGET
 325 and
 326 .Va EMBEDDED_TARGET_ARCH
 327 must also be defined.
 328 When the build environment is created,
 329 .Fa release.sh
 330 runs a separate build script located in an architecture-specific
 331 directory in
 332 .Pa src/release/${EMBEDDED_TARGET}/ .
 333 .It Va EMBEDDEDPORTS
 334 Set to the list of any ports that are required for the target device
 335 in the format of
 336 .Fa category/port .
 337 The
 338 .Fa devel/subversion
 339 port is built by default.
 340 .It Va EMBEDDED_TARGET
 341 When set, its value is passed to
 342 .Xr make 1
 343 to set the
 344 .Va TARGET
 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
 349 .Xr make 1
 350 to set the
 351 .Va TARGET_ARCH
 352 .Pq value of Cm uname Fl p
 353 to cross build the target userland.
 354 .El
 355 .Sh VIRTUAL MACHINE DISK IMAGES
 356 The following
 357 .Fa release.conf
 358 variables are relevant only to virtual machine disk image builds:
 359 .Bl -tag -width Ev
 360 .It Va WITH_VMIMAGES
 361 Set to a non-null value to build virtual machine disk images as part
 362 of the release build.
 363 .Va WITH_VMIMAGES
 364 may also be specified as an environment variable passed to
 365 .Xr make 1 .
 366 .Pp
 367 The option requires
 368 .Xr mkimg 1
 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
 372 .Xr xz 1
 373 as part of the
 374 .Cm install
 375 .Xr make 1
 376 target.
 377 Note that compressing virtual machine disk images may take a very long
 378 time on some systems.
 379 .It Va VMBASE
 380 Set to change the name of the resulting virtual machine disk image file.
 381 The default value is
 382 .Va vm .
 383 .It Va VMSIZE
 384 Set to change the size of the virtual machine disk capacity.
 385 The default value is
 386 .Va 20G .
 387 See
 388 .Xr truncate 1
 389 for valid values.
 390 .Pp
 391 Virtual machine disk images are, by default, created as sparse images.
 392 When
 393 .Va WITH_COMPRESSED_VMIMAGES
 394 is used, the resulting files compressed with
 395 .Xr xz 1
 396 compress to roughly the same size, regardless of the specified disk image
 397 size.
 398 .It Va VMFORMATS
 399 Set to the target virtual disk image format(s) to create.
 400 By default, the
 401 .Va vhdf , Va vmdk , Va qcow2 ,
 402 and
 403 .Va raw
 404 formats are created.
 405 See
 406 .Xr mkimg 1
 407 for valid format values
 408 .Pq requires version 20140927 or later .
 409 .El
 410 .Pp
 411 For a list of supported
 412 .Va VMFORMATS
 413 values
 414 .Pq including cloud hosting provider formats
 415 along with a brief description, run:
 416 .Bd -literal -offset indent
 417 cd /usr/src
 418 make -C release list-vmtargets
 419 .Ed
 420 .Sh CLOUD HOSTING MACHINE IMAGES
 421 The
 422 .Fx
 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.
 426 .Pp
 427 The following
 428 .Xr make 1
 429 environment variables are supported:
 430 .Bl -tag -width Ev
 431 .It Va CLOUDWARE
 432 Set to a list of one or more cloud hosting providers, enclosed in quotes.
 433 Requires
 434 .Va WITH_CLOUDWARE
 435 to also be set.
 436 .It Va WITH_CLOUDWARE
 437 Set to a non-empty value to enable building virtual machine images
 438 for various cloud hosting providers.
 439 Requires
 440 .Va CLOUDWARE
 441 to also be set.
 442 .El
 443 .Pp
 444 Additionally, the
 445 .Va CLOUDWARE
 446 and
 447 .Va WITH_CLOUDWARE
 448 variables can be added to
 449 .Pa release.conf ,
 450 and used in conjunction with
 451 .Pa release.sh .
 452 .Pp
 453 For a list of supported
 454 .Va CLOUDWARE
 455 values, run:
 456 .Bd -literal -offset indent
 457 cd /usr/src
 458 make -C release list-cloudware
 459 .Ed
 460 .Sh MAKEFILE TARGETS
 461 The release makefile
 462 .Pq Pa src/release/Makefile
 463 is fairly abstruse.
 464 Most developers will only be concerned with the
 465 .Cm release
 466 and
 467 .Cm install
 468 targets.
 469 .\" XXX: Some sort of introduction to this list?  All the others have one.
 470 .Bl -tag -width ".Cm packagesystem"
 471 .It Cm release
 472 Meta-target to build all release media and distributions applicable to this
 473 platform.
 474 .It Cm install
 475 Copy all produced release media to
 476 .Pa ${DESTDIR} .
 477 .It Cm cdrom
 478 Builds installation CD-ROM images.
 479 This may require the
 480 .Xr md 4
 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
 484 .Pa disc1.iso
 485 and
 486 .Pa bootonly.iso
 487 as its output.
 488 .It Cm dvdrom
 489 Builds installation DVD-ROM images.
 490 This may require the
 491 .Xr md 4
 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
 495 .Pa dvd1.iso
 496 file as its output.
 497 .It Cm memstick
 498 Builds an installation memory stick image named
 499 .Pa memstick.img .
 500 Not applicable on all platforms.
 501 Requires that the
 502 .Xr md 4
 503 .Pq memory disk
 504 device driver be present in the kernel
 505 .Pq either by being compiled in or available as a module .
 506 .It Cm mini-memstick
 507 Similar to
 508 .Cm memstick ,
 509 with the exception that the installation distribution sets
 510 are not included.
 511 .It Cm ftp
 512 Creates a directory named
 513 .Pa ftp
 514 containing the distribution files used in network installations
 515 and suitable for upload to an FTP mirror.
 516 .It Cm vm-image
 517 Creates virtual machine disk images in various formats.
 518 The
 519 .Cm vm-image
 520 target requires the
 521 .Va WITH_VMIMAGES
 522 .Xr make 1
 523 environment variable to be set to a non-null value.
 524 .It Cm vm-cloudware
 525 Builds
 526 .Fx
 527 virtual machine images for various cloud hosting providers.
 528 See
 529 .Qq CLOUD HOSTING MACHINE IMAGES
 530 for implementation details.
 531 .It Cm list-cloudware
 532 Displays the list of valid
 533 .Va CLOUDWARE
 534 values.
 535 .It Cm list-vmtargets
 536 Displays the list of valid
 537 .Va VMFORMAT
 538 and
 539 .Va CLOUDWARE
 540 values.
 541 .El
 542 .Pp
 543 Major subtargets called by targets above:
 544 .Bl -tag -width ".Cm packagesystem"
 545 .It Cm packagesystem
 546 Generates all the distribution archives
 547 .Pq base, kernel, ports, doc
 548 applicable on this platform.
 549 .It Cm disc1
 550 Builds a bootable installation system containing all the distribution files
 551 packaged by the
 552 .Cm packagesystem
 553 target, and suitable for imaging by the
 554 .Cm cdrom ,
 555 .Cm dvdrom
 556 and
 557 .Cm memstick
 558 targets.
 559 .It Cm reldoc
 560 Builds the release documentation.
 561 This includes the release notes,
 562 hardware guide, and installation instructions.
 563 Other documentation, such as the Handbook,
 564 is built during the
 565 .Cm base.txz
 566 target invoked by
 567 .Cm packagesystem .
 568 .El
 569 .Sh ENVIRONMENT
 570 Optional variables:
 571 .Bl -tag -width ".Ev TARGET_ARCH"
 572 .It Ev OSRELEASE
 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`
 577 within the chroot.
 578 .It Ev WORLDDIR
 579 Location of a directory containing the src tree.
 580 By default, the directory
 581 above the one containing the makefile
 582 .Pq Pa src .
 583 .It Ev PORTSDIR
 584 Location of a directory containing the ports tree.
 585 By default,
 586 .Pa /usr/ports .
 587 If it is unset or cannot be found, ports will not be included in the release.
 588 .It Ev DOCDIR
 589 Location of a directory containing the doc tree.
 590 By default,
 591 .Pa /usr/doc .
 592 If it is unset or cannot be found, most documentation will not be included in
 593 the release; see
 594 .Ev NODOC
 595 below.
 596 .It Ev NOPORTS
 597 If defined, the Ports Collection will be omitted from the release.
 598 .It Ev NOSRC
 599 If set, do not include system source code in the release.
 600 .It Ev NODOC
 601 If defined, the XML-based documentation from the
 602 .Fx
 603 Documentation Project will not be built.
 604 However, the
 605 .Dq doc
 606 distribution will still be created with the minimal documentation set
 607 provided in
 608 .Pa src/share/doc .
 609 .It Ev TARGET
 610 The target hardware platform.
 611 This is analogous to the
 612 .Dq Nm uname Fl m
 613 output.
 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
 617 and
 618 .Ev TARGET Ns = Ns Li arm64 .
 619 If not set,
 620 .Ev TARGET
 621 defaults to the current hardware platform.
 622 .It Ev TARGET_ARCH
 623 The target machine processor architecture.
 624 This is analogous to the
 625 .Dq Nm uname Fl p
 626 output.
 627 Set this to cross-build for a different architecture.
 628 If not set,
 629 .Ev TARGET_ARCH
 630 defaults to the current machine architecture, unless
 631 .Ev TARGET
 632 is also set, in which case it defaults to the appropriate
 633 value for that platform.
 634 Typically, one only needs to set
 635 .Ev TARGET .
 636 .El
 637 .Sh FILES
 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
 652 .El
 653 .Sh EXAMPLES
 654 The following sequence of commands can be used to build a
 655 .Dq "-CURRENT snapshot":
 656 .Bd -literal -offset indent
 657 cd /usr
 658 svn co svn://svn.freebsd.org/base/head src
 659 cd src
 660 make buildworld buildkernel
 661 cd release
 662 make release
 663 make install DESTDIR=/var/freebsd-snapshot
 664 .Ed
 665 .Pp
 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
 669 directory.
 670 .Pp
 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
 675 cd /usr/src/release
 676 sh release.sh
 677 .Ed
 678 .Pp
 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
 681 .Li src/ ,
 682 .Li ports/ ,
 683 and
 684 .Li doc/ .
 685 .Bd -literal -offset indent
 686 cd /usr/src/release
 687 sh release.sh -c $HOME/release.conf
 688 .Ed
 689 .Pp
 690 Configuration files specific to various supported embedded systems, such as
 691 the Raspberry Pi, exist in the directory corresponding to the
 692 .Va TARGET
 693 .Xr make 1
 694 variable.
 695 For example, to build an image for the Raspberry Pi:
 696 .Bd -literal -offset indent
 697 cd /usr/src/release
 698 sh release.sh -c arm/RPI-B.conf
 699 .Ed
 700 .Pp
 701 To build an image for the Raspberry Pi 3:
 702 .Bd -literal -offset indent
 703 cd /usr/src/release
 704 sh release.sh -c arm64/RPI3.conf
 705 .Ed
 706 .Pp
 707 After running these commands, all prepared release files are available in the
 708 .Pa /scratch
 709 directory.
 710 The target directory can be changed by specifying the
 711 .Va CHROOTDIR
 712 variable in
 713 .Li release.conf .
 714 .Sh SEE ALSO
 715 .Xr cc 1 ,
 716 .Xr install 1 ,
 717 .Xr make 1 ,
 718 .Xr svn 1 Pq Pa ports/devel/subversion ,
 719 .Xr uname 1 ,
 720 .Xr md 4 ,
 721 .Xr make.conf 5 ,
 722 .Xr build 7 ,
 723 .Xr ports 7 ,
 724 .Xr chroot 8 ,
 725 .Xr mtree 8 ,
 726 .Xr sysctl 8
 727 .Rs
 728 .%T "FreeBSD Release Engineering"
 729 .%U https://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/freebsd-releng/
 730 .Re
 731 .Rs
 732 .%T "FreeBSD Developers' Handbook"
 733 .%U https://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
 734 .Re
 735 .Sh HISTORY
 736 .Fx
 737 1.x
 738 used a manual checklist, compiled by
 739 .An Rod Grimes ,
 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.
 743 .Pp
 744 As part of the
 745 .Fx 2.0
 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.
 751 .Pp
 752 For the
 753 .Fx 9.0
 754 release,
 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.
 759 .Pp
 760 For the
 761 .Fx 9.2
 762 release,
 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
 768 script.
 769 .Pp
 770 At near 1000 revisions spread over multiple branches, the
 771 .Xr svn 1
 772 log of
 773 .Pa src/release/Makefile
 774 contains a vivid historical record of some
 775 of the hardships release engineers go through.
 776 .Sh AUTHORS
 777 .Pa src/release/Makefile
 778 was originally written by
 779 .An -nosplit
 780 .An Rod Grimes ,
 781 .An Jordan Hubbard ,
 782 and
 783 .An Poul-Henning Kamp .
 784 .Pp
 785 This manual page was originally written by
 786 .An Murray Stokely Aq Mt murray@FreeBSD.org .
 787 .Pp
 788 It was updated by
 789 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
 790 to include the
 791 .Fa generate-release.sh
 792 script used for the
 793 .Fx 9.0
 794 release cycle.
 795 .Pp
 796 It was later updated by
 797 .An Glen Barber Aq Mt gjb@FreeBSD.org
 798 to include the
 799 .Fa release.sh
 800 script used for the
 801 .Fx 9.2
 802 release cycle.