Skip to content

Commit

Permalink
Bump to version 2.1.0
Browse files Browse the repository at this point in the history
  • Loading branch information
ahesford committed Dec 20, 2022
1 parent e05f88a commit cdd4163
Show file tree
Hide file tree
Showing 9 changed files with 44 additions and 49 deletions.
2 changes: 1 addition & 1 deletion bin/generate-zbm
Original file line number Diff line number Diff line change
Expand Up @@ -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);
Expand Down
6 changes: 3 additions & 3 deletions docs/man/generate-zbm.5
Original file line number Diff line number Diff line change
@@ -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:
.\" ========================================================================
Expand Down Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand Down
14 changes: 10 additions & 4 deletions docs/man/generate-zbm.8
Original file line number Diff line number Diff line change
@@ -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:
.\" ========================================================================
Expand Down Expand Up @@ -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
Expand All @@ -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
Expand All @@ -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
Expand Down Expand Up @@ -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)
Expand Down
4 changes: 2 additions & 2 deletions docs/man/zbm-efi-kcl.8
Original file line number Diff line number Diff line change
@@ -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:
.\" ========================================================================
Expand Down Expand Up @@ -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
Expand Down
4 changes: 2 additions & 2 deletions docs/man/zbm-kcl.8
Original file line number Diff line number Diff line change
@@ -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:
.\" ========================================================================
Expand Down Expand Up @@ -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
Expand Down
8 changes: 3 additions & 5 deletions docs/man/zfsbootmenu.7
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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.
Expand All @@ -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
Expand Down
14 changes: 6 additions & 8 deletions zfsbootmenu/help-files/132/zfsbootmenu.7.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
22 changes: 9 additions & 13 deletions zfsbootmenu/help-files/52/zfsbootmenu.7.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down
19 changes: 8 additions & 11 deletions zfsbootmenu/help-files/92/zfsbootmenu.7.pod
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand All @@ -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
Expand Down

0 comments on commit cdd4163

Please sign in to comment.