You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/CHANGELOG.md
+18-18Lines changed: 18 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -308,13 +308,13 @@ Please refer to [Command-Line Parameters](https://github.com/zbm-dev/zfsbootmenu
308
308
* Support `console=` kernel parameters with a `,speed` suffix. This is normally used when setting a serial port as the machine console.
309
309
* Add a shortcut key to remove the pinned kernel value for a boot environment.
310
310
311
-
####Allow references to parent properties in org.zfsbootmenu:commandline
311
+
### Allow references to parent properties in org.zfsbootmenu:commandline
312
312
313
313
Any reference to `%{parent}` in `org.zfsbootmenu:commandline` will be replaced with the value of the same property on the parent filesystem (with parent references above recursively expanded), allowing easy specification of common options at a mutual parent of two BEs and overrides or additions of individual options per-BE. The value of `%{parent}` is always an empty string on a root filesystem.
314
314
315
315
This is not intended to be sophisticated, and `%{parent}` appearing within other words will be replaced regardless. The assumption is that `%{parent}` is unique enough and will not conflict with real KCL options, so dumb global replacement is sufficient.
316
316
317
-
####zpool import process improvements
317
+
### zpool import process improvements
318
318
319
319
The existing `zbm.prefer` option has been extended to support defining a mandatory pool. Append `!` to the pool name to indicate that the specific pool MUST be imported before any other pool imports will be attempted.
320
320
@@ -362,7 +362,7 @@ This release is dedicated to the late Jürgen Buchmüller (@pullmoll), a major c
362
362
363
363
### Major New features
364
364
365
-
####`hostid` configuration assistance
365
+
### `hostid` configuration assistance
366
366
A pair of new features have been developed to combat the delicate dance sometimes required to synchronize `hostid` in the boot environment (BE), the initramfs for the BE, and the initramfs for ZFSBootMenu. Both of these are controlled by ZFSBootMenu kernel command line options.
367
367
368
368
Set `zbm.import_policy=hostid` to allow run-time reconfiguration of the SPL hostid. If a pool is preferred via `zbm.prefer` 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.
@@ -371,22 +371,22 @@ Setting `zbm.set_hostid` will cause ZFSBootMenu to set the `spl.spl_hostid` comm
371
371
372
372
### Minor new features
373
373
374
-
####Boot environment / snapshot sorting
374
+
### Boot environment / snapshot sorting
375
375
The main boot environment screen and snapshot list screen can now be sorted by multiple criteria. By default, these listings are sorted by name. One of `zbm.sort_key=name`, `zbm.sort_key=creation`, or `zbm.sort_key=used` can be set on the command line to change the default used. `MOD+O` can be pressed at run time to change the sort order to the next in the list.
376
376
377
-
####Helper functions in the recovery shell
377
+
### Helper functions in the recovery shell
378
378
379
379
The internal `zfsbootmenu-lib.sh` library is now sourced by default in the recovery shell. This makes a number of helper functions available for general use.
380
380
381
-
####Combined command line printer
381
+
### Combined command line printer
382
382
383
383
Since `Dracut` can find command line options from multiple places, it can be difficult to determine which option was used to control bootloader behavior. The command `zbmcmdline` will show the command line as seen by Dracut.
384
384
385
-
####Shorcut key layout improvements
385
+
### Shorcut key layout improvements
386
386
387
387
Instead of flowing the helper key text to the width of the screen, shortcut key text is now arranged in one or more columns. Low resolution screens or terminals with small dimensions will use a single column to show the text. As the terminal dimensions increase, text will be laid out in up to a maximum of three left-aligned columns.
388
388
389
-
####Logging system
389
+
### Logging system
390
390
391
391
ZFSBootMenu has an internal logging system backed by `/dev/kmsg` and `dmesg`. Logging is now enabled throughout the entire system, tracking both `debug` level messages as well as `warnings` and `errors`. When a warning or error condition has occurred, a yellow `[!]` or red `[!]` notification will appear in the upper left of the screen. Pressing `MOD+L` will access this logging system, allowing you to easily see these messages.
392
392
@@ -691,7 +691,7 @@ The new features and fixes in this release are fully described in the final v1.3
691
691
692
692
This release features substantial code and idea contributions from @ahesford . Thank you for all of your help writing features, debugging code and improving documentation.
693
693
694
-
####Snapshot overhaul
694
+
### Snapshot overhaul
695
695
696
696
Previously, snapshots could be cloned to a boot environment with a pre-generated, and often long, BE name. Substantial quality of life improvements were made here, including:
697
697
@@ -700,23 +700,23 @@ Previously, snapshots could be cloned to a boot environment with a pre-generated
700
700
* When cloning a snapshot, local ZFS properties of the parent filesystem are now transferred to the clone.
701
701
* For all snapshot operations, you can now directly enter a boot environment name. This name is checked for character validity, and to confirm that it is not already taken.
702
702
703
-
####Always up-to-date menu system
703
+
### Always up-to-date menu system
704
704
705
705
Any time you transition from one menu to another (Snapshots, Kernels, recovery shell), the list of boot environments and kernels is completely regenerated. This helps remove potential disconnects between the state of your pool and boot environments and the ZFSBootMenu interface.
706
706
707
-
####UEFI bundle improvements
707
+
### UEFI bundle improvements
708
708
709
709
If you create unversioned UEFI bundles for static boot entries, `generate-zbm` will now create a `-backup` file for you on upgrade. This will allow you a recovery option if the active UEFI bundle has a problem.
710
710
711
-
####Protect against missing kernel modules
711
+
### Protect against missing kernel modules
712
712
713
713
When creating a new initramfs, the `zfsbootmenu` Dracut module needs to install a number of ZFS-related kernel modules. Previously, the modules were installed through a Dracut helper function that did not verify if the copy succeeded. This process has been reworked to ensure that all of the required kernel modules are installed in the initramfs, or the creation of the image is marked as a failure. If it is marked as a failure, existing/current images are not deleted or otherwise replaced.
714
714
715
-
####Set default kernel
715
+
### Set default kernel
716
716
717
717
Much like setting a default boot environment, you can now set a default kernel for a specific boot environment. You no longer need to manually set a kernel version in your booted OS, you can simply do it from the menu!
718
718
719
-
####Shellcheck
719
+
### Shellcheck
720
720
721
721
On commit, the shell scripts that power the boot menu and Dracut setup are run through a validator to check for common errors and pitfalls. This can help reduce some classes of bugs.
722
722
@@ -725,12 +725,12 @@ On commit, the shell scripts that power the boot menu and Dracut setup are run t
725
725
726
726
This release includes a number of small fixes and improvements.
727
727
728
-
## Fixes
728
+
###Fixes
729
729
* Correctly handle exiting the recovery shell, fixing an infinite loop. A reboot is no longer required to recover from the recovery shell. Thanks, @ahesford.
730
730
* Check that the EFI stub file is present on disk at the specified location. If the file is missing and an EFI bundle is requested, exit with an error.
731
731
* Minor documentation fixes.
732
732
733
-
## Features
733
+
###Features
734
734
* Handle console fonts defined on the kernel command line. This is useful for systems with a 4k display. You should now be able to read the screen without a magnifying glass. Thanks to @ahesford for the significant time spent on tracking this down.
735
735
* Instead of calling `objcopy` directly, `dracut` is now used to generate a bundled EFI file. This means that the bundled EFI file can now be signed by Secure Boot keys! Thanks to @ericonr for this feature - and learning a bit of Perl to do it!
736
736
@@ -741,15 +741,15 @@ No configuration file changes are needed to use this release. Enjoy!
741
741
742
742
We're jumping straight up to v1.0!
743
743
744
-
## Small changes
744
+
###Small changes
745
745
* Set the kernel log level to 0 when in the menu system, then restore it to the original value on boot
746
746
* Reverse sort the kernel list, so the most recent is always first
747
747
* Add an initial chroot helper script, `zfs-chroot` for the recovery shell. It can be invoked as `zfs-chroot pool/ROOT/BE`.
748
748
* Set the default config path in `generate-zbm` to `/etc/zfsbootmenu/conf.d`
749
749
* Allow the EFI stub file to be defined in config.ini
750
750
* Optionally read the kernel command line from `/etc/default/zfsbootmenu`
751
751
752
-
## Large changes
752
+
###Large changes
753
753
* Clean up or whitelist all issues in `zfsbootmenu-lib.sh`, `zfsbootmenu-preview.sh` and `zfsbootmenu.sh` noted by shellcheck.
754
754
* Support entering a custom kernel command line via `alt-c` on the main menu. The input line is pre-filled with the command line that would have been used on the next boot, for that environment. This command line is NOT persisted between reboots, it's simply here to let you recover an unbootable system.
755
755
* Add support for reading the kernel commandline from the ZFS property `org.zfsbootmenu:commandline`. This property is now considered the default/primary source of truth for the kernel command line - it takes precedence over `/etc/default/zfsbootmenu` and `/etc/default/grub`.
0 commit comments