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 January 28, 2017
  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 .Pq This option is considered highly experimental.
 318 .Pp
 319 When set,
 320 .Va WITH_DVD
 321 is unset, and
 322 .Va NODOC
 323 is defined.
 324 Additionally,
 325 .Va XDEV
 326 and
 327 .Va XDEV_ARCH
 328 must also be defined.
 329 When the build environment is created,
 330 .Fa release.sh
 331 runs a separate build script located in an architecture-specific
 332 directory in
 333 .Pa src/release/${XDEV}/ .
 334 .It Va EMBEDDEDPORTS
 335 Set to the list of any ports that are required for the target device
 336 in the format of
 337 .Fa category/port .
 338 The
 339 .Fa devel/subversion
 340 port is built by default.
 341 .It Va CROCHETSRC
 342 Set to the source URL for the Crochet build tool.
 343 .It Va CROCHETBRANCH
 344 Set to the subversion branch from
 345 .Va ${CROCHETSRC}
 346 to use.
 347 Defaults to
 348 .Pa trunk .
 349 .It Va UBOOTSRC
 350 Set to the source URL of u-boot, if required.
 351 .It Va UBOOTBRANCH
 352 Set to the subversion branch from
 353 .Va ${UBOOTSRC}
 354 to use.
 355 Defaults to
 356 .Pa trunk .
 357 .It Va UBOOTDIR
 358 Set to the target directory within
 359 .Va ${CHROOTDIR}
 360 to check out
 361 .Va ${UBOOTSRC}/${UBOOTBRANCH} .
 362 .El
 363 .Sh VIRTUAL MACHINE DISK IMAGES
 364 The following
 365 .Fa release.conf
 366 variables are relevant only to virtual machine disk image builds:
 367 .Bl -tag -width Ev
 368 .It Va WITH_VMIMAGES
 369 Set to a non-null value to build virtual machine disk images as part
 370 of the release build.
 371 .Va WITH_VMIMAGES
 372 may also be specified as an environment variable passed to
 373 .Xr make 1 .
 374 .Pp
 375 The option requires
 376 .Xr mkimg 1
 377 version 20140927 or later.
 378 .It Va WITH_COMPRESSED_VMIMAGES
 379 Set to a non-null value to compress the virtual machine disk images with
 380 .Xr xz 1
 381 as part of the
 382 .Cm install
 383 .Xr make 1
 384 target.
 385 Note that compressing virtual machine disk images may take a very long
 386 time on some systems.
 387 .It Va VMBASE
 388 Set to change the name of the resulting virtual machine disk image file.
 389 The default value is
 390 .Va vm .
 391 .It Va VMSIZE
 392 Set to change the size of the virtual machine disk capacity.
 393 The default value is
 394 .Va 20G .
 395 See
 396 .Xr truncate 1
 397 for valid values.
 398 .Pp
 399 Virtual machine disk images are, by default, created as sparse images.
 400 When
 401 .Va WITH_COMPRESSED_VMIMAGES
 402 is used, the resulting files compressed with
 403 .Xr xz 1
 404 compress to roughly the same size, regardless of the specified disk image
 405 size.
 406 .It Va VMFORMATS
 407 Set to the target virtual disk image format(s) to create.
 408 By default, the
 409 .Va vhdf , Va vmdk , Va qcow2 ,
 410 and
 411 .Va raw
 412 formats are created.
 413 See
 414 .Xr mkimg 1
 415 for valid format values
 416 .Pq requires version 20140927 or later .
 417 .El
 418 .Pp
 419 For a list of supported
 420 .Va VMFORMATS
 421 values
 422 .Pq including cloud hosting provider formats
 423 along with a brief description, run:
 424 .Bd -literal -offset indent
 425 cd /usr/src
 426 make -C release list-vmtargets
 427 .Ed
 428 .Sh CLOUD HOSTING MACHINE IMAGES
 429 The
 430 .Fx
 431 release build tools support building virtual machine images for various
 432 cloud hosting providers, each with their own specific configuration to
 433 include support for each hosting provider by default.
 434 .Pp
 435 The following
 436 .Xr make 1
 437 environment variables are supported:
 438 .Bl -tag -width Ev
 439 .It Va CLOUDWARE
 440 Set to a list of one or more cloud hosting providers, enclosed in quotes.
 441 Requires
 442 .Va WITH_CLOUDWARE
 443 to also be set.
 444 .It Va WITH_CLOUDWARE
 445 Set to a non-empty value to enable building virtual machine images
 446 for various cloud hosting providers.
 447 Requires
 448 .Va CLOUDWARE
 449 to also be set.
 450 .El
 451 .Pp
 452 Additionally, the
 453 .Va CLOUDWARE
 454 and
 455 .Va WITH_CLOUDWARE
 456 variables can be added to
 457 .Pa release.conf ,
 458 and used in conjunction with
 459 .Pa release.sh .
 460 .Pp
 461 For a list of supported
 462 .Va CLOUDWARE
 463 values, run:
 464 .Bd -literal -offset indent
 465 cd /usr/src
 466 make -C release list-cloudware
 467 .Ed
 468 .Sh MAKEFILE TARGETS
 469 The release makefile
 470 .Pq Pa src/release/Makefile
 471 is fairly abstruse.
 472 Most developers will only be concerned with the
 473 .Cm release
 474 and
 475 .Cm install
 476 targets.
 477 .\" XXX: Some sort of introduction to this list?  All the others have one.
 478 .Bl -tag -width ".Cm packagesystem"
 479 .It Cm release
 480 Meta-target to build all release media and distributions applicable to this
 481 platform.
 482 .It Cm install
 483 Copy all produced release media to
 484 .Pa ${DESTDIR} .
 485 .It Cm cdrom
 486 Builds installation CD-ROM images.
 487 This may require the
 488 .Xr md 4
 489 (memory disk) device driver be present in the kernel
 490 (either by being compiled in or available as a module).
 491 This target produces files called
 492 .Pa disc1.iso
 493 and
 494 .Pa bootonly.iso
 495 as its output.
 496 .It Cm dvdrom
 497 Builds installation DVD-ROM images.
 498 This may require the
 499 .Xr md 4
 500 (memory disk) device driver be present in the kernel
 501 (either by being compiled in or available as a module).
 502 This target produces the
 503 .Pa dvd1.iso
 504 file as its output.
 505 .It Cm memstick
 506 Builds an installation memory stick image named
 507 .Pa memstick.img .
 508 Not applicable on all platforms.
 509 Requires that the
 510 .Xr md 4
 511 .Pq memory disk
 512 device driver be present in the kernel
 513 .Pq either by being compiled in or available as a module .
 514 .It Cm mini-memstick
 515 Similar to
 516 .Cm memstick ,
 517 with the exception that the installation distribution sets
 518 are not included.
 519 .It Cm ftp
 520 Creates a directory named
 521 .Pa ftp
 522 containing the distribution files used in network installations
 523 and suitable for upload to an FTP mirror.
 524 .It Cm vm-image
 525 Creates virtual machine disk images in various formats.
 526 The
 527 .Cm vm-image
 528 target requires the
 529 .Va WITH_VMIMAGES
 530 .Xr make 1
 531 environment variable to be set to a non-null value.
 532 .It Cm vm-cloudware
 533 Builds
 534 .Fx
 535 virtual machine images for various cloud hosting providers.
 536 See
 537 .Qq CLOUD HOSTING MACHINE IMAGES
 538 for implementation details.
 539 .It Cm list-cloudware
 540 Displays the list of valid
 541 .Va CLOUDWARE
 542 values.
 543 .It Cm list-vmtargets
 544 Displays the list of valid
 545 .Va VMFORMAT
 546 and
 547 .Va CLOUDWARE
 548 values.
 549 .El
 550 .Pp
 551 Major subtargets called by targets above:
 552 .Bl -tag -width ".Cm packagesystem"
 553 .It Cm packagesystem
 554 Generates all the distribution archives
 555 .Pq base, kernel, ports, doc
 556 applicable on this platform.
 557 .It Cm disc1
 558 Builds a bootable installation system containing all the distribution files
 559 packaged by the
 560 .Cm packagesystem
 561 target, and suitable for imaging by the
 562 .Cm cdrom ,
 563 .Cm dvdrom
 564 and
 565 .Cm memstick
 566 targets.
 567 .It Cm reldoc
 568 Builds the release documentation.
 569 This includes the release notes,
 570 hardware guide, and installation instructions.
 571 Other documentation, such as the Handbook,
 572 is built during the
 573 .Cm base.txz
 574 target invoked by
 575 .Cm packagesystem .
 576 .El
 577 .Sh ENVIRONMENT
 578 Optional variables:
 579 .Bl -tag -width ".Ev TARGET_ARCH"
 580 .It Ev OSRELEASE
 581 Optional base name for generated media images
 582 .Pq e.g., FreeBSD-9.0-RC2-amd64 .
 583 Defaults to the output of
 584 .Ic `uname -s`-`uname -r`-`uname -p`
 585 within the chroot.
 586 .It Ev WORLDDIR
 587 Location of a directory containing the src tree.
 588 By default, the directory
 589 above the one containing the makefile
 590 .Pq Pa src .
 591 .It Ev PORTSDIR
 592 Location of a directory containing the ports tree.
 593 By default,
 594 .Pa /usr/ports .
 595 If it is unset or cannot be found, ports will not be included in the release.
 596 .It Ev DOCDIR
 597 Location of a directory containing the doc tree.
 598 By default,
 599 .Pa /usr/doc .
 600 If it is unset or cannot be found, most documentation will not be included in
 601 the release; see
 602 .Ev NODOC
 603 below.
 604 .It Ev NOPORTS
 605 If defined, the Ports Collection will be omitted from the release.
 606 .It Ev NOSRC
 607 If set, do not include system source code in the release.
 608 .It Ev NODOC
 609 If defined, the XML-based documentation from the
 610 .Fx
 611 Documentation Project will not be built.
 612 However, the
 613 .Dq doc
 614 distribution will still be created with the minimal documentation set
 615 provided in
 616 .Pa src/share/doc .
 617 .It Ev TARGET
 618 The target hardware platform.
 619 This is analogous to the
 620 .Dq Nm uname Fl m
 621 output.
 622 This is necessary to cross-build some target architectures.
 623 For example, cross-building for ARM64 machines requires
 624 .Ev TARGET_ARCH Ns = Ns Li aarch64
 625 and
 626 .Ev TARGET Ns = Ns Li arm64 .
 627 If not set,
 628 .Ev TARGET
 629 defaults to the current hardware platform.
 630 .It Ev TARGET_ARCH
 631 The target machine processor architecture.
 632 This is analogous to the
 633 .Dq Nm uname Fl p
 634 output.
 635 Set this to cross-build for a different architecture.
 636 If not set,
 637 .Ev TARGET_ARCH
 638 defaults to the current machine architecture, unless
 639 .Ev TARGET
 640 is also set, in which case it defaults to the appropriate
 641 value for that platform.
 642 Typically, one only needs to set
 643 .Ev TARGET .
 644 .El
 645 .Sh FILES
 646 .Bl -tag -compact -width Pa
 647 .It Pa /usr/doc/Makefile
 648 .It Pa /usr/doc/share/mk/doc.project.mk
 649 .It Pa /usr/ports/Mk/bsd.port.mk
 650 .It Pa /usr/ports/Mk/bsd.sites.mk
 651 .It Pa /usr/share/examples/etc/make.conf
 652 .It Pa /usr/src/Makefile
 653 .It Pa /usr/src/Makefile.inc1
 654 .It Pa /usr/src/release/Makefile
 655 .It Pa /usr/src/release/Makefile.vm
 656 .It Pa /usr/src/release/release.sh
 657 .It Pa /usr/src/release/release.conf.sample
 658 .It Pa /usr/src/release/tools/*.conf
 659 .It Pa /usr/src/release/tools/vmimage.subr
 660 .El
 661 .Sh EXAMPLES
 662 The following sequence of commands can be used to build a
 663 .Dq "-CURRENT snapshot":
 664 .Bd -literal -offset indent
 665 cd /usr
 666 svn co svn://svn.freebsd.org/base/head src
 667 cd src
 668 make buildworld buildkernel
 669 cd release
 670 make release
 671 make install DESTDIR=/var/freebsd-snapshot
 672 .Ed
 673 .Pp
 674 After running these commands, all produced distribution files (tarballs
 675 for FTP, CD-ROM images, etc.) are available in the
 676 .Pa /var/freebsd-snapshot
 677 directory.
 678 .Pp
 679 The following sequence of commands can be used to build a
 680 .Dq "-CURRENT snapshot"
 681 in a clean environment, including ports and documentation:
 682 .Bd -literal -offset indent
 683 cd /usr/src/release
 684 sh release.sh
 685 .Ed
 686 .Pp
 687 Optionally, a configuration file can be used customize the release build,
 688 such as the subversion revision to use, the branch of the subversion tree for
 689 .Li src/ ,
 690 .Li ports/ ,
 691 and
 692 .Li doc/ .
 693 .Bd -literal -offset indent
 694 cd /usr/src/release
 695 sh release.sh -c $HOME/release.conf
 696 .Ed
 697 .Pp
 698 After running these commands, all prepared release files are available in the
 699 .Pa /scratch
 700 directory.
 701 The target directory can be changed by specifying the
 702 .Va CHROOTDIR
 703 variable in
 704 .Li release.conf .
 705 .Sh SEE ALSO
 706 .Xr cc 1 ,
 707 .Xr install 1 ,
 708 .Xr make 1 ,
 709 .Xr svn 1 Pq Pa ports/devel/subversion ,
 710 .Xr uname 1 ,
 711 .Xr md 4 ,
 712 .Xr make.conf 5 ,
 713 .Xr build 7 ,
 714 .Xr ports 7 ,
 715 .Xr chroot 8 ,
 716 .Xr mtree 8 ,
 717 .Xr sysctl 8
 718 .Rs
 719 .%T "FreeBSD Release Engineering"
 720 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/articles/releng/
 721 .Re
 722 .Rs
 723 .%T "FreeBSD Developers' Handbook"
 724 .%U http://www.FreeBSD.org/doc/en_US.ISO8859-1/books/developers-handbook/
 725 .Re
 726 .Sh HISTORY
 727 .Fx
 728 1.x
 729 used a manual checklist, compiled by
 730 .An Rod Grimes ,
 731 to produce a release.
 732 Apart from being incomplete, the list put a lot of specific demands on
 733 available file systems and was quite torturous to execute.
 734 .Pp
 735 As part of the
 736 .Fx 2.0
 737 release engineering effort, significant
 738 effort was spent getting
 739 .Pa src/release/Makefile
 740 into a shape where it could at least automate most of the tediousness
 741 of building a release in a sterile environment.
 742 .Pp
 743 For the
 744 .Fx 9.0
 745 release,
 746 .Pa src/release/Makefile
 747 was overhauled and the wrapper script
 748 .Pa src/release/generate-release.sh
 749 introduced to support the introduction of a new installer.
 750 .Pp
 751 For the
 752 .Fx 9.2
 753 release,
 754 .Pa src/release/release.sh
 755 was introduced to support per-build configuration files.
 756 .Pa src/release/release.sh
 757 is heavily based on the
 758 .Pa src/release/generate-release.sh
 759 script.
 760 .Pp
 761 At near 1000 revisions spread over multiple branches, the
 762 .Xr svn 1
 763 log of
 764 .Pa src/release/Makefile
 765 contains a vivid historical record of some
 766 of the hardships release engineers go through.
 767 .Sh AUTHORS
 768 .Pa src/release/Makefile
 769 was originally written by
 770 .An -nosplit
 771 .An Rod Grimes ,
 772 .An Jordan Hubbard ,
 773 and
 774 .An Poul-Henning Kamp .
 775 .Pp
 776 This manual page was originally written by
 777 .An Murray Stokely Aq Mt murray@FreeBSD.org .
 778 .Pp
 779 It was updated by
 780 .An Nathan Whitehorn Aq Mt nwhitehorn@FreeBSD.org
 781 to include the
 782 .Fa generate-release.sh
 783 script used for the
 784 .Fx 9.0
 785 release cycle.
 786 .Pp
 787 It was later updated by
 788 .An Glen Barber Aq Mt gjb@FreeBSD.org
 789 to include the
 790 .Fa release.sh
 791 script used for the
 792 .Fx 9.2
 793 release cycle.