From cdd41637c0fff1bfa00e3c4d4015e986d5bf7561 Mon Sep 17 00:00:00 2001 From: "Andrew J. Hesford" Date: Mon, 19 Dec 2022 21:16:47 -0500 Subject: [PATCH] Bump to version 2.1.0 --- bin/generate-zbm | 2 +- docs/man/generate-zbm.5 | 6 +++--- docs/man/generate-zbm.8 | 14 +++++++++---- docs/man/zbm-efi-kcl.8 | 4 ++-- docs/man/zbm-kcl.8 | 4 ++-- docs/man/zfsbootmenu.7 | 8 +++---- zfsbootmenu/help-files/132/zfsbootmenu.7.pod | 14 ++++++------- zfsbootmenu/help-files/52/zfsbootmenu.7.pod | 22 ++++++++------------ zfsbootmenu/help-files/92/zfsbootmenu.7.pod | 19 +++++++---------- 9 files changed, 44 insertions(+), 49 deletions(-) diff --git a/bin/generate-zbm b/bin/generate-zbm index 405598ebb..0186b4951 100755 --- a/bin/generate-zbm +++ b/bin/generate-zbm @@ -4,7 +4,7 @@ use strict; use warnings; -our $VERSION = '2.0.0'; +our $VERSION = '2.1.0'; use Getopt::Long qw(:config no_ignore_case auto_version); use Pod::Usage qw(pod2usage); diff --git a/docs/man/generate-zbm.5 b/docs/man/generate-zbm.5 index 19d1e1291..930b68365 100644 --- a/docs/man/generate-zbm.5 +++ b/docs/man/generate-zbm.5 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "generate-zbm 5" -.TH generate-zbm 5 "2022-06-24" "2.0.0" "config.yaml" +.TH generate-zbm 5 "2022-12-19" "2.1.0" "config.yaml" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -171,7 +171,7 @@ A single path or an array of paths to \fBmkinitcpio\fR hook directories. When sp In general, this should be the location of your \s-1EFI\s0 System Partition. \fBgenerate-zbm\fR will ensure that this is mounted when images are created and, if \fBgenerate-zbm\fR does the mounting, will unmount this filesystem on exit. When this parameter is not specified, \fBgenerate-zbm\fR will not verify or attempt to mount any filesystems. .IP "\fBVersion\fR" 4 .IX Item "Version" -A specific ZFSBootMenu version string to use in producing images. In the string, the value \fI%{current}\fR will be replaced with the release version of ZFSBootMenu. The default value is simply \fI%{current}\fR. +A specific ZFSBootMenu version string to use in versioned output images. In the string, the value \fI%{current}\fR will be replaced with the release version of ZFSBootMenu. The default value is simply \fI%{current}\fR. .IP "\fBDracutFlags\fR" 4 .IX Item "DracutFlags" An array of additional arguments that will be passed to \fBdracut\fR when generating an initramfs. This option is ignored when \fIGlobal.InitCPIO\fR is \fItrue\fR. diff --git a/docs/man/generate-zbm.8 b/docs/man/generate-zbm.8 index d060b0c43..465f5a168 100644 --- a/docs/man/generate-zbm.8 +++ b/docs/man/generate-zbm.8 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "generate-zbm 8" -.TH generate-zbm 8 "2022-06-28" "2.0.0" "generate-zbm" +.TH generate-zbm 8 "2022-12-20" "2.1.0" "generate-zbm" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -148,7 +148,7 @@ generate\-zbm \- ZFSBootMenu initramfs generator Where noted, command-line options supersede options in the \fBgenerate-zbm\fR(5) configuration file. .IP "\fB\-\-version|\-v\fR \fIzbm-version\fR" 4 .IX Item "--version|-v zbm-version" -Override the ZFSBootMenu version; supersedes \fIGlobal.Version\fR +Override the ZFSBootMenu version in output files; supersedes \fIGlobal.Version\fR .IP "\fB\-\-kernel|\-k\fR \fIkernel-path\fR" 4 .IX Item "--kernel|-k kernel-path" Manually specify a specific kernel; supersedes \fIKernel.Path\fR @@ -160,7 +160,10 @@ Manually specify a specific kernel version; supersedes \fIKernel.Version\fR Manually specify the output image prefix; supersedes \fIKernel.Prefix\fR .IP "\fB\-\-initcpio|\-i\fR" 4 .IX Item "--initcpio|-i" -Use mkinitcpio instead of dracut. +Force the use of mkinitcpio instead of dracut. +.IP "\fB\-\-no\-initcpio|\-i\fR" 4 +.IX Item "--no-initcpio|-i" +Force the use of dracut instead of mkinitcpio. .IP "\fB\-\-confd|\-C\fR \fIconfig-path\fR" 4 .IX Item "--confd|-C config-path" Specify initramfs configuration path @@ -197,6 +200,9 @@ Set the \fIGlobal.ManageImages\fR option to false, disabling image generation. .IP "\fB\-\-debug|d\fR" 4 .IX Item "--debug|d" Enable debug output +.IP "\fB\-\-showver|V\fR" 4 +.IX Item "--showver|V" +Print ZFSBootMenu version and quit. .SH "SEE ALSO" .IX Header "SEE ALSO" \&\fBgenerate-zbm\fR(5) \fBzfsbootmenu\fR(7) diff --git a/docs/man/zbm-efi-kcl.8 b/docs/man/zbm-efi-kcl.8 index fc6db8835..98d8b7259 100644 --- a/docs/man/zbm-efi-kcl.8 +++ b/docs/man/zbm-efi-kcl.8 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "zbm-efi-kcl 8" -.TH zbm-efi-kcl 8 "2022-06-27" "2.0.0" "zbm-efi-kcl" +.TH zbm-efi-kcl 8 "2022-07-11" "2.1.0" "zbm-efi-kcl" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/docs/man/zbm-kcl.8 b/docs/man/zbm-kcl.8 index 57cf68eec..8993f6a0b 100644 --- a/docs/man/zbm-kcl.8 +++ b/docs/man/zbm-kcl.8 @@ -1,4 +1,4 @@ -.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.42) +.\" Automatically generated by Pod::Man 4.14 (Pod::Simple 3.43) .\" .\" Standard preamble: .\" ======================================================================== @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "zbm-kcl 8" -.TH zbm-kcl 8 "2022-06-24" "2.0.0" "zbm-kcl" +.TH zbm-kcl 8 "2022-07-11" "2.1.0" "zbm-kcl" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l diff --git a/docs/man/zfsbootmenu.7 b/docs/man/zfsbootmenu.7 index 25e6f4180..853e4d63f 100644 --- a/docs/man/zfsbootmenu.7 +++ b/docs/man/zfsbootmenu.7 @@ -133,7 +133,7 @@ .\" ======================================================================== .\" .IX Title "zfsbootmenu 7" -.TH zfsbootmenu 7 "2022-10-28" "2.0.0" "ZFSBootMenu" +.TH zfsbootmenu 7 "2022-12-19" "2.1.0" "ZFSBootMenu" .\" For nroff, turn off justification. Always turn off hyphenation; it makes .\" way too many mistakes in technical documents. .if n .ad l @@ -174,7 +174,7 @@ This option controls how the pool import process should take place. .RS 4 .IP "\fBzbm.import_policy=hostid\fR" 2 .IX Item "zbm.import_policy=hostid" -Set this option to allow run-time reconfiguration of the \s-1SPL\s0 hostid. If a pool is preferred via \fBzbm.prefer\fR and the pool can not be imported with a preconfigured hostid, the system will attempt to adopt the hostid of the system that last imported the pool. If a preferred pool is not set and no pools can be imported using a preconfigured hostid, the system will adopt the hostid of the first otherwise-importable pool. After adopting a detected hostid, ZFSBootMenu will subsequently attempt to import as many pools as possible. This option is forbidden on big-endian systems. This is the default import policy. +Set this option to allow run-time reconfiguration of the \s-1SPL\s0 hostid. If a pool is preferred via \fBzbm.prefer\fR and the pool can not be imported with a preconfigured hostid, the system will attempt to adopt the hostid of the system that last imported the pool. If a preferred pool is not set and no pools can be imported using a preconfigured hostid, the system will adopt the hostid of the first otherwise-importable pool. After adopting a detected hostid, ZFSBootMenu will subsequently attempt to import as many pools as possible. This is the default import policy. .IP "\fBzbm.import_policy=strict\fR" 2 .IX Item "zbm.import_policy=strict" Set this option to only import pools that match the \s-1SPL\s0 hostid configured in ZFSBootMenu. If none can be imported, an emergency shell will be invoked. The \fIstrict\fR policy is consistent with the behavior of earlier versions of ZFSBootMenu. @@ -186,9 +186,7 @@ Set this option to attempt to force pool imports. When set, this invokes \fIzpoo .RE .IP "\fBzbm.set_hostid\fR" 4 .IX Item "zbm.set_hostid" -On little-endian systems, setting this option will cause ZFSBootMenu to set the \fIspl.spl_hostid\fR command-line parameter for the selected boot environment to the hostid used to import its pool. The \s-1SPL\s0 kernel module will use this value as the hostid of the booted environment regardless of the contents of \fI/etc/hostid\fR. As a special case, if the hostid to be set is zero, ZFSBootMenu will instead set \fIspl_hostid=00000000\fR, which should be used by dracut-based initramfs images to write an all-zero \fI/etc/hostid\fR in the initramfs prior to importing the boot pool. This option is on by default. -.Sp -This option has no effect on big-endian systems. +Setting this option will cause ZFSBootMenu to set the \fIspl.spl_hostid\fR command-line parameter for the selected boot environment to the hostid used to import its pool. The \s-1SPL\s0 kernel module will use this value as the hostid of the booted environment regardless of the contents of \fI/etc/hostid\fR. As a special case, if the hostid to be set is zero, ZFSBootMenu will instead set \fIspl_hostid=00000000\fR, which should be used by dracut-based initramfs images to write an all-zero \fI/etc/hostid\fR in the initramfs prior to importing the boot pool. This option is on by default. .Sp \&\fBNote:\fR Setting \fIspl.spl_hostid\fR to a non-zero value on the kernel commandline will make the \s-1ZFS\s0 kernel modules \fBignore\fR any value set in \fI/etc/hostid\fR. To restore standard \s-1ZFS\s0 behavior on a running system, execute .Sp diff --git a/zfsbootmenu/help-files/132/zfsbootmenu.7.pod b/zfsbootmenu/help-files/132/zfsbootmenu.7.pod index 7787372f0..92418eead 100644 --- a/zfsbootmenu/help-files/132/zfsbootmenu.7.pod +++ b/zfsbootmenu/help-files/132/zfsbootmenu.7.pod @@ -46,7 +46,7 @@ general systems to boot without setting any values. not be imported with a preconfigured hostid, the system will attempt to adopt the hostid of the system that last imported the pool. If a preferred pool is not set and no pools can be imported using a preconfigured hostid, the system will adopt the hostid of the first otherwise-importable pool. After adopting a detected hostid, ZFSBootMenu will subsequently attempt to - import as many pools as possible. This option is forbidden on big-endian systems. This is the default import policy. + import as many pools as possible. This is the default import policy. zbm.import_policy=strict Set this option to only import pools that match the SPL hostid configured in ZFSBootMenu. If none can be imported, an @@ -57,13 +57,11 @@ general systems to boot without setting any values. command, which will attempt to import a pool that's potentially in use on another system. Use this option with caution! zbm.set_hostid - On little-endian systems, setting this option will cause ZFSBootMenu to set the spl.spl_hostid command-line parameter for the - selected boot environment to the hostid used to import its pool. The SPL kernel module will use this value as the hostid of the - booted environment regardless of the contents of /etc/hostid. As a special case, if the hostid to be set is zero, ZFSBootMenu - will instead set spl_hostid=00000000, which should be used by dracut-based initramfs images to write an all-zero /etc/hostid in - the initramfs prior to importing the boot pool. This option is on by default. - - This option has no effect on big-endian systems. + Setting this option will cause ZFSBootMenu to set the spl.spl_hostid command-line parameter for the selected boot environment to + the hostid used to import its pool. The SPL kernel module will use this value as the hostid of the booted environment regardless + of the contents of /etc/hostid. As a special case, if the hostid to be set is zero, ZFSBootMenu will instead set + spl_hostid=00000000, which should be used by dracut-based initramfs images to write an all-zero /etc/hostid in the initramfs + prior to importing the boot pool. This option is on by default. Note: Setting spl.spl_hostid to a non-zero value on the kernel commandline will make the ZFS kernel modules ignore any value set in /etc/hostid. To restore standard ZFS behavior on a running system, execute diff --git a/zfsbootmenu/help-files/52/zfsbootmenu.7.pod b/zfsbootmenu/help-files/52/zfsbootmenu.7.pod index 1513c1ff4..364fa7f26 100644 --- a/zfsbootmenu/help-files/52/zfsbootmenu.7.pod +++ b/zfsbootmenu/help-files/52/zfsbootmenu.7.pod @@ -77,8 +77,7 @@ without setting any values. otherwise-importable pool. After adopting a detected hostid, ZFSBootMenu will subsequently attempt to import as many pools as possible. - This option is forbidden on big-endian - systems. This is the default import policy. + This is the default import policy. zbm.import_policy=strict Set this option to only import pools that @@ -97,23 +96,20 @@ without setting any values. Use this option with caution! zbm.set_hostid - On little-endian systems, setting this option - will cause ZFSBootMenu to set the spl.spl_hostid - command-line parameter for the selected boot - environment to the hostid used to import its - pool. The SPL kernel module will use this value - as the hostid of the booted environment - regardless of the contents of /etc/hostid. As a - special case, if the hostid to be set is zero, - ZFSBootMenu will instead set + Setting this option will cause ZFSBootMenu to + set the spl.spl_hostid command-line parameter + for the selected boot environment to the hostid + used to import its pool. The SPL kernel module + will use this value as the hostid of the booted + environment regardless of the contents of + /etc/hostid. As a special case, if the hostid to + be set is zero, ZFSBootMenu will instead set spl_hostid=00000000, which should be used by dracut-based initramfs images to write an all-zero /etc/hostid in the initramfs prior to importing the boot pool. This option is on by default. - This option has no effect on big-endian systems. - Note: Setting spl.spl_hostid to a non-zero value on the kernel commandline will make the ZFS kernel modules ignore any value set in diff --git a/zfsbootmenu/help-files/92/zfsbootmenu.7.pod b/zfsbootmenu/help-files/92/zfsbootmenu.7.pod index c2a9a263c..c4b8f9a26 100644 --- a/zfsbootmenu/help-files/92/zfsbootmenu.7.pod +++ b/zfsbootmenu/help-files/92/zfsbootmenu.7.pod @@ -53,8 +53,7 @@ Default options were chosen to allow general systems to boot without setting any If a preferred pool is not set and no pools can be imported using a preconfigured hostid, the system will adopt the hostid of the first otherwise-importable pool. After adopting a detected hostid, ZFSBootMenu will subsequently attempt to import as many - pools as possible. This option is forbidden on big-endian systems. This is the default - import policy. + pools as possible. This is the default import policy. zbm.import_policy=strict Set this option to only import pools that match the SPL hostid configured in @@ -67,15 +66,13 @@ Default options were chosen to allow general systems to boot without setting any that's potentially in use on another system. Use this option with caution! zbm.set_hostid - On little-endian systems, setting this option will cause ZFSBootMenu to set the - spl.spl_hostid command-line parameter for the selected boot environment to the hostid - used to import its pool. The SPL kernel module will use this value as the hostid of the - booted environment regardless of the contents of /etc/hostid. As a special case, if the - hostid to be set is zero, ZFSBootMenu will instead set spl_hostid=00000000, which should - be used by dracut-based initramfs images to write an all-zero /etc/hostid in the - initramfs prior to importing the boot pool. This option is on by default. - - This option has no effect on big-endian systems. + Setting this option will cause ZFSBootMenu to set the spl.spl_hostid command-line + parameter for the selected boot environment to the hostid used to import its pool. The + SPL kernel module will use this value as the hostid of the booted environment regardless + of the contents of /etc/hostid. As a special case, if the hostid to be set is zero, + ZFSBootMenu will instead set spl_hostid=00000000, which should be used by dracut-based + initramfs images to write an all-zero /etc/hostid in the initramfs prior to importing + the boot pool. This option is on by default. Note: Setting spl.spl_hostid to a non-zero value on the kernel commandline will make the ZFS kernel modules ignore any value set in /etc/hostid. To restore standard ZFS behavior