docs: binary releases helper/documentation

Co-authored-by: Zach Dykstra <[email protected]>
Co-authored-by: Andrew J. Hesford <[email protected]>

docs/guides/_include/recovery.rst

@@ -0,0 +1,17 @@
+* /zbm/bin/zbm-kcl
+* /etc/zbm-commit-hash
+* /bin/gdisk
+* /bin/parted
+* /bin/wipefs
+* /bin/kpartx
+* /bin/sgdisk
+* /bin/mkfs.vfat
+* /bin/mkfs.ext4
+* /bin/efibootmgr
+* /bin/cryptsetup
+* /bin/ip
+* /bin/curl
+* /bin/dhclient
+* /sbin/dhclient-script
+* /bin/ssh
+* /etc/ssl/certs/ca-certificates.crt

docs/guides/_include/release.rst

@@ -0,0 +1,2 @@
+* /zbm/bin/zbm-kcl
+* /etc/zbm-commit-hash

docs/guides/binary-releases.rst

@@ -0,0 +1,33 @@
+Binary Releases
+===============
+
+ZFSBootMenu releases include pre-built ``release`` and ``recovery`` images, each distributed as an EFI executable or a
+"component" archive consisting of a separate kernel and initramfs image. The EFI executables should be directly bootable
+by most UEFI firmware implementations or boot managers including rEFInd, gummiboot and systemd-boot. The separate kernel
+and initramfs components may also be used on UEFI systems; the kernels used for ZFSBootMenu binary releases always
+include the built-in EFI stub and may be directly bootable (provided the UEFI implementation can pass command-line
+arguments, including the path to the associated initramfs image, to the kernel) or loaded by a boot manager. In
+addition, the separate components may be booted by any standard BIOS boot loader (*e.g.*, syslinux) on legacy hardware.
+
+Release images
+~~~~~~~~~~~~~~
+
+Release images include all user-space tools necessary for full functionality within ZFSBootMenu, and include a minimal
+selection of additional tools that might be helpful in a pre-boot environment. In general, release images are
+recommended for normal system operation.
+
+The extra tooling includes:
+
+.. include:: _include/release.rst
+
+Recovery images
+~~~~~~~~~~~~~~~
+
+The tools available in recovery images are a super-set of the tools included in release images. Recovery images may be
+useful for rebuilding unbootable systems from within the ZFSBootMenu emergency shell, and includes basic components for
+network access as well as utilities to manipulate disks and file systems. It may be desirable to keep a recovery image
+installed alongside the standard release image, and configure a backup boot option pointing to this recovery image.
+
+The extra tooling includes:
+
+.. include:: _include/recovery.rst

docs/index.rst

@@ -55,6 +55,7 @@
   guides/fedora
   guides/opensuse
   guides/third-party
+  guides/binary-releases
 
 .. toctree::
   :caption: Runtime Help

releng/tag-release.sh

@@ -76,6 +76,10 @@ if ! out="$( releng/rst2help.sh )" ; then
   error "ERROR: ${out}"
 fi
 
+if ! out="$( releng/update-includes.sh )" ; then
+  error "ERROR: ${out}"
+fi
+
 if ! out="$( cd docs && make gen-man SPHINXOPTS='-t manpages' )" ; then
   error "ERROR: ${out}"
 fi

releng/update-includes.sh

@@ -0,0 +1,17 @@
+#!/bin/bash
+# vim: softtabstop=2 shiftwidth=2 expandtab
+
+for style in release recovery; do
+  (
+    for include in "etc/zfsbootmenu/${style}.conf.d"/*; do
+      # shellcheck disable=SC1090
+      source "${include}"
+    done
+
+    # shellcheck disable=SC2154
+    read -ra installs <<< "${install_optional_items}"
+    for item in "${installs[@]}"; do
+      echo "* ``$item``"
+    done
+  ) > docs/guides/_include/${style}.rst
+done