Bump to version 1.8.1

Author: ahesford

CHANGELOG.md

@@ -1,3 +1,28 @@
+# ZFSBootMenu v1.8.1 (2021-01-12)
+
+Happy New Year! ZFSBootMenu 1.8.1 provides a few minor enhancements and bug fixes.
+
+## Fixes
+* Properly handle encryption keys as raw devices rather than normal files. (#127)
+* Improve detection of latest kernels when `/boot` contains some unversioned kernel files. (#128)
+* Accept `Ctrl` and `Ctrl-Alt` as hotkey modifiers in addition to `Alt` to fix issues with some non-US keymaps. (#124)
+* Everywhere a chroot hotkey is offered, use the same hotkey.
+
+## New features
+* Add hard wraps to the hotkey menus to improve clarity; ignored for small screens.
+* In the snapshot list, add an option to jump into a read-only chroot for that snapshot.
+* The `force_import` and `timeout` kernel command-line options are now expected to be `zbm.force_import` and `zbm.timeout`; the old forms are deprecated but will continue to work for the forseeable future.
+* New `zbm.show` and `zbm.skip` command-line options force the menu to appear or be skipped if `zbm.timeout` is not also set.
+
+## Significant commits in this release
+* ab95346 - Expect names of the form <prefix>-<version> when finding latest kernel (Andrew J. Hesford)
+* 798fce8 - Normalize tests for paths. (Andrew J. Hesford)
+* d02865e - Change chroot keys, add help text (#126) (Zach Dykstra)
+* 83c58b2 - Support Ctrl and Ctrl-Alt in addition to Alt as keybind modifiers (Andrew J. Hesford)
+* 70c3d70 - Namespace our KCL args, organize parsing (#120) (Zach Dykstra)
+* c1d6ce5 - Support chroot'ing into a snapshot (Zach Dykstra)
+* 7a63beb - Support for hard wrap points in header_wrap (Andrew J. Hesford)
+
 # ZFSBootMenu v1.8.0 (2020-12-15)
 
 ZFSBootMenu 1.8.0 offers a significant list of new features, fixes and general improvements.
@@ -434,3 +459,4 @@ Booting from a snapshot has been fixed - the snapshot is now correctly unmounted
 Initial release!
 
 The dracut module has been built into an initramfs for both x86_64 and ppc64le (POWER8+) - with Linux 5.3.7. A sample grub.cfg is provided, demonstrating how to enter the boot menu. Update your pool name, and set spl_hostid based on the output of 'hostid' on your machine.
+

bin/generate-zbm

@@ -4,7 +4,7 @@
 use strict;
 use warnings;
 
-our $VERSION = '1.8.0';
+our $VERSION = '1.8.1';
 
 use Getopt::Long qw(:config no_ignore_case auto_version);
 use Pod::Usage qw(pod2usage);

man/generate-zbm.5

@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "generate-zbm 5"
-.TH generate-zbm 5 "2020-09-30" "1.8.0" "config.yaml"
+.TH generate-zbm 5 "2020-09-30" "1.8.1" "config.yaml"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l

man/generate-zbm.8

@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "generate-zbm 8"
-.TH generate-zbm 8 "2020-12-15" "1.8.0" "generate-zbm"
+.TH generate-zbm 8 "2021-01-06" "1.8.1" "generate-zbm"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l

man/zfsbootmenu.7

@@ -133,7 +133,7 @@
 .\" ========================================================================
 .\"
 .IX Title "zfsbootmenu 7"
-.TH zfsbootmenu 7 "2020-12-10" "1.8.0" "ZFSBootMenu"
+.TH zfsbootmenu 7 "2020-12-21" "1.8.1" "ZFSBootMenu"
 .\" For nroff, turn off justification.  Always turn off hyphenation; it makes
 .\" way too many mistakes in technical documents.
 .if n .ad l
@@ -146,36 +146,42 @@ ZFSBootMenu behavior is controlled through \s-1ZFS\s0 filesystem properties and
 .SH "Command-Line Parameters"
 .IX Header "Command-Line Parameters"
 These options are set on the kernel command line when booting the initramfs or \s-1UEFI\s0 bundle. Default options were chosen to allow general systems to boot without setting any values.
+.IP "\fBroot=zfsbootmenu:POOL=<pool>\fR" 4
+.IX Item "root=zfsbootmenu:POOL=<pool>"
+By default, ZFSBootMenu will look for the \fIbootfs\fR property on the first pool it imports to select the default boot environment. If you have multiple pools, substitute the name of your preferred pool for \fB<pool>\fR in the argument \fBroot=zfsbootmenu:POOL=<pool>\fR.
 .IP "\fBspl_hostid=<hostid>\fR" 4
 .IX Item "spl_hostid=<hostid>"
 When creating an initramfs or \s-1UEFI\s0 bundle, the \fIhostid\fR from the system is copied into the target. If this image will be used on another system with a different \fIhostid\fR, it can be overridden with this option.
 .Sp
 Replace \fB<hostid>\fR with an eight-digit hexadecimal number.
-.IP "\fBforce_import=1\fR" 4
-.IX Item "force_import=1"
+.IP "\fBzbm.force_import=1\fR" 4
+.IX Item "zbm.force_import=1"
 Set this option to attempt to force pool imports. When set, this invokes \fIzpool import \-f\fR in place of the regular \fIzpool import\fR command, which will attempt to import a pool that's potentially in use on another system. Use this option with caution!
 .Sp
-Omit this option or explicitly specify \fBforce_import=0\fR to disable forced imports.
-.IP "\fBtimeout\fR" 4
-.IX Item "timeout"
+Omit this option or explicitly specify \fBzbm.force_import=0\fR to disable forced imports.
+.IP "\fBforce_import=1\fR" 4
+.IX Item "force_import=1"
+Deprecated; use \fBzbm.force_import\fR.
+.IP "\fBzbm.timeout\fR" 4
+.IX Item "zbm.timeout"
 This option accepts numeric values that control whether and when the
 boot-environment menu should be displayed.
 .RS 4
-.IP "\fBtimeout=0\fR" 2
-.IX Item "timeout=0"
+.IP "\fBzbm.timeout=0\fR | \fBzbm.skip\fR" 2
+.IX Item "zbm.timeout=0 | zbm.skip"
 When possible, bypass the menu and immediately boot a configured \fIbootfs\fR pool property.
-.IP "\fBtimeout=\-1\fR" 2
-.IX Item "timeout=-1"
+.IP "\fBzbm.timeout=\-1\fR | \fBzbm.show\fR" 2
+.IX Item "zbm.timeout=-1 | zbm.show"
 Rather than present a countdown timer for automatic selection, immediately display the boot-environment menu.
-.IP "\fBtimeout=<positive integer>\fR" 2
-.IX Item "timeout=<positive integer>"
+.IP "\fBzbm.timeout=<positive integer>\fR" 2
+.IX Item "zbm.timeout=<positive integer>"
 Display a countdown timer for the specified number of seconds before booting the configured \fIbootfs\fR boot environment.
 .RE
 .RS 4
 .RE
-.IP "\fBroot=zfsbootmenu:POOL=<pool>\fR" 4
-.IX Item "root=zfsbootmenu:POOL=<pool>"
-By default, ZFSBootMenu will look for the \fIbootfs\fR property on the first pool it imports to select the default boot environment. If you have multiple pools, substitute the name of your preferred pool for \fB<pool>\fR in the argument \fBroot=zfsbootmenu:POOL=<pool>\fR.
+.IP "\fBtimeout\fR" 4
+.IX Item "timeout"
+Deprecated; use \fBzbm.timeout\fR.
 .IP "\fBzbm.tmux\fR" 4
 .IX Item "zbm.tmux"
 Indicate that ZFSBootMenu should be run under \fBtmux\fR in the initramfs. With this enabled, debug-level logging for the ZFSBootMenu scripts can be easily viewed. The tooling must also be installed with an additional dracut configuration option listed below.