Skip to content

Commit

Permalink
Clarify root-prefix text in README.md
Browse files Browse the repository at this point in the history
  • Loading branch information
ahesford committed Jul 9, 2020
1 parent f50f8e4 commit c214ce7
Showing 1 changed file with 3 additions and 3 deletions.
6 changes: 3 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
Expand Down Expand Up @@ -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
Expand Down

0 comments on commit c214ce7

Please sign in to comment.