From c214ce7d1b848e03c4c53c29c8295acedf6b7f24 Mon Sep 17 00:00:00 2001 From: "Andrew J. Hesford" Date: Thu, 9 Jul 2020 01:23:55 -0400 Subject: [PATCH] Clarify root-prefix text in README.md --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index eb564ab12..e2ddc11bb 100644 --- a/README.md +++ b/README.md @@ -34,7 +34,7 @@ Binary releases for x86_64 and ppc64le are built on Void Linux hosts. ZFSBootMen # System prereqs -To ensure the boot menu can find your kernels, you'll need to ensure `/boot` resides on your ZFS file system. An example filesystem layout is as follows: +To ensure the boot menu can find your kernels, you'll need to ensure `/boot` resides on your ZFS filesystem. An example filesystem layout is as follows: ``` NAME USED AVAIL REFER MOUNTPOINT @@ -166,8 +166,8 @@ The following properties can be set at whatever level of the pool you'd prefer t * `org.zfsbootmenu:commandline` set the list of kernel commandline options to be passed to the final OS. Do not set `root=`, this is set for you. * `org.zfsbootmenu:active` controls whether boot environments appear in or are hidden from ZFS Boot Menu: - If a boot environment has the property `mountpoint=/`, set `org.zfsbootmenu:active=off` to *hide* the environment. For any other value, including not set, the boot environment will be shown. - - If a boot environment has the property `mountpoint=legacy`, set `org.zfsbootmenu:active=on` to *show* the environment. For any other value, including not set, the boot environment will be hidden. **Note**: Not all Linux distributions support booting from datasets with `mountpoint=legacy`. -* `org.zfsbootmenu:rootprefix` controls the prefix added to the name of the ZFS dataset provided as the root filesystem to kernels booted by ZFSBootMenu. For example, a command-line argument of "root=zfs:zpool/ROOT/OS" has a root prefix of `root=zfs:`, which is the default value unless the boot environment appears to be Arch Linux; for Arch, the default root prefix is `zfs=`. Set `org.zfsbootmenu:rootprefix` on any boot environment or its parent to override this default. Remember to include any necessary delimiters, like `:` or `=`. + - If a boot environment has the property `mountpoint=legacy`, set `org.zfsbootmenu:active=on` to *show* the environment. For any other value, including not set, the boot environment will be hidden. **Note**: Not all Linux distributions support booting from filesystems with `mountpoint=legacy`. +* `org.zfsbootmenu:rootprefix` controls the prefix added to the ZFS filesystem provided as the root to kernels booted by ZFSBootMenu. For example, the command-line argument `root=zfs:zroot/ROOT/void` has the root prefix `root=zfs:`, which is the default value unless the boot environment appears to be Arch Linux; for Arch, the default root prefix is `zfs=`. Set `org.zfsbootmenu:rootprefix` on any boot environment or its parent to override this default. Remember to include the `root=` component if necessary and any delimiters like `:` or `=` that separate the prefix from the root filesystem. # initramfs creation