Skip to content

Commit

Permalink
Fix several errors in docs
Browse files Browse the repository at this point in the history
  • Loading branch information
johnramsden committed May 30, 2018
1 parent 5e9f610 commit 415397b
Show file tree
Hide file tree
Showing 2 changed files with 13 additions and 15 deletions.
6 changes: 3 additions & 3 deletions doc/source/plugins.rst
Original file line number Diff line number Diff line change
Expand Up @@ -113,9 +113,9 @@ So the 'default' boot environment config, located at
options zfs=zpool/ROOT/default rw
To make the system happy when it looks for kernels at ``/boot``, this directory
should be bindmounted to ``/boot``. To do bindmount
``/mnt/efi/env/zedenv-default`` to ``/boot`` in ``/etc/fstab``.
should be bindmounted to ``/boot``.

Bindmount ``/mnt/efi/env/zedenv-default`` to ``/boot`` in ``/etc/fstab``.

.. code-block:: none
Expand All @@ -125,7 +125,7 @@ If this directory is not here, the kernels will not be updated when the system
rebuilds the kernel.

Once our system is set up in the proper configuration, ``zedenv`` will update
your bootloader, and fstab - if requested - when a new boot environment is
the bootloader, and fstab - if requested - when a new boot environment is
activated.

It will also update the configuration described above, asking you if the
Expand Down
22 changes: 10 additions & 12 deletions doc/source/setup.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@ System Setup
In order to use boot environments your system needs to be set up in a certain
manner.

The main data set that is used for your root file system, can also be thought
of as your boot environment. Anything in this data set, or in a dataset under
The main dataset that is used for your root file system, can also be thought
of as your boot environment. Anything in this dataset, or in a dataset under
it, is what constitutes a boot environment.

Dataset Configuration
Expand All @@ -17,19 +17,19 @@ To put your system in a compatible configuration, your boot environments for
your system should be kept in a 'Boot Environment root'. In most configurations
this would be ``<pool>/ROOT``. However its location is not important, and it
can be located anywhere within a pool. What's important is that it does not
have any child data sets that are not in a boot environment.
have any child datasets that are not in a boot environment.

The common practice is to start with a 'default' boot environment. This would
be the dataset ``<pool>/ROOT/default``. If a system is in this
be the dataset ``<pool>/ROOT/default``. If a system is setup in this
manner, it would be the most basic boot environment compatible system.

This 'default' dataset could have the entire system installed into it. Upon
creating new boot environments it would be cloned and the entire system would
creating new boot environments, it would be cloned and the entire system would
be in the new boot environment. A better practice would be to keep some
datasets separate from the boot environment, parts of the system that
would be shared between boot environments, would be located in these datasets.
For example, one might want to keep their logs separate, or their home
directories separate.
datasets separate from the boot environment. Putting parts of the system that
can be shared between boot environments, in these separate datasets is good
practice. For example, one might want to keep their log, or home directories
separate.

Examples
--------
Expand All @@ -43,7 +43,7 @@ The default FreeBSD configuration is a great example of a hierarchy that is
setup to use boot environments by default. After a root on ZFS install, the
system has a new boot environment, that is usable by default.

Any data set that is set to ``canmount=off``, means it will not be mounted and
Any dataset that is set to ``canmount=off``, means it will not be mounted and
its data will be stored in the boot environment.

In the default setup this means the data of ``/usr``, and ``/var`` will change
Expand Down Expand Up @@ -83,13 +83,11 @@ Here is an Arch Linux system, with an extensive dataset setup.
vault/usr off /usr
vault/usr/local on legacy
vault/var off /var
vault/var/abs on legacy
vault/var/cache on legacy
vault/var/cache/pacman on legacy
vault/var/lib off /var/lib
vault/var/lib/docker on legacy
vault/var/lib/libvirt on legacy
vault/var/lib/machines on legacy
vault/var/lib/systemd off /var/lib/systemd
vault/var/lib/systemd/coredump on legacy
vault/var/log on legacy
Expand Down

0 comments on commit 415397b

Please sign in to comment.