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