[pdm-devel] [PATCH datacenter-manager 1/3] docs: fix formatting of local-zfs documentation.

[Manuel Federanko <m.federanko@proxmox.com>]

Signed-off-by: Manuel Federanko <m.federanko@proxmox.com>
---
 docs/local-zfs.rst | 43 ++++++++++++++++++++++++-------------------
 1 file changed, 24 insertions(+), 19 deletions(-)

diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst
index 37682f9..38abc4e 100644
--- a/docs/local-zfs.rst
+++ b/docs/local-zfs.rst
@@ -146,19 +146,21 @@ or `gdisk`
 The maximum size of a log device should be about half the size of physical memory, so this is
 usually quite small. The rest of the SSD can be used as cache.

-   .. code-block:: console
+.. code-block:: console

-# zpool add -f <pool> log <device-part1> cache <device-part2>
+  # zpool add -f <pool> log <device-part1> cache <device-part2>


-Changing a failed device ^^^^^^^^^^^^^^^^^^^^^^^^
+Changing a failed device
+^^^^^^^^^^^^^^^^^^^^^^^^

-   .. code-block:: console
+.. code-block:: console

-# zpool replace -f <pool> <old device> <new device>
+  # zpool replace -f <pool> <old device> <new device>


-Changing a failed bootable device ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Changing a failed bootable device
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 Depending on how `Proxmox Datacenter Manager`_ was installed, it is either using `grub` or
 `systemd-boot` as a bootloader.
@@ -167,21 +169,22 @@ In either case, the first steps of copying the partition table, reissuing GUIDs
 ZFS partition are the same. To make the system bootable from the new disk, different steps are
 needed which depend on the bootloader in use.

-   .. code-block:: console
+.. code-block:: console

-# sgdisk <healthy bootable device> -R <new device> # sgdisk -G <new device> # zpool replace -f
-<pool> <old zfs partition> <new zfs partition>
+  # sgdisk <healthy bootable device> -R <new device>
+  # sgdisk -G <new device>
+  # zpool replace -f <pool> <old zfs partition> <new zfs partition>

-   .. NOTE:: Use the `zpool status -v` command to monitor how far the resilvering process of the new
+.. NOTE:: Use the `zpool status -v` command to monitor how far the resilvering process of the new
    disk has progressed.

 With `systemd-boot`:

-   .. code-block:: console
+.. code-block:: console

-# proxmox-boot-tool format <new ESP> # proxmox-boot-tool init <new ESP>
+  # proxmox-boot-tool format <new ESP> # proxmox-boot-tool init <new ESP>

-   .. NOTE:: `ESP` stands for EFI System Partition, which is setup as partition #2 on bootable disks
+.. NOTE:: `ESP` stands for EFI System Partition, which is setup as partition #2 on bootable disks
    setup by the Proxmox Datacenter Manager installer. For details, see :ref:`Setting up a new partition for use
    as synced ESP <systembooting-proxmox-boot-setup>`.

@@ -189,12 +192,13 @@ With `grub`:

 Usually `grub.cfg` is located in `/boot/grub/grub.cfg`

-   .. code-block:: console
+.. code-block:: console

-# grub-install <new disk> # grub-mkconfig -o /path/to/grub.cfg
+  # grub-install <new disk> # grub-mkconfig -o /path/to/grub.cfg


-Activate e-mail notification ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
+Activate e-mail notification
+^^^^^^^^^^^^^^^^^^^^^^^^^^^^

 ZFS comes with an event daemon, ``ZED``, which monitors events generated by the ZFS kernel module.
 The daemon can also send emails upon ZFS events, such as pool errors. Newer ZFS packages ship the
@@ -205,15 +209,16 @@ You can configure the daemon via the file ``/etc/zfs/zed.d/zed.rc``, using your
 The required setting for email notification is ``ZED_EMAIL_ADDR``, which is set to ``root`` by
 default.

-   .. code-block:: console
+.. code-block:: console

-ZED_EMAIL_ADDR="root"
+  ZED_EMAIL_ADDR="root"

 Please note that Proxmox Datacenter Manager forwards mails to `root` to the email address configured
 for the root user.


-Limit ZFS memory usage ^^^^^^^^^^^^^^^^^^^^^^
+Limit ZFS memory usage
+^^^^^^^^^^^^^^^^^^^^^^

 It is good to use at most 50 percent (which is the default) of the system memory for ZFS ARC, to
 prevent performance degradation of the host. Use your preferred editor to change the configuration
--
2.47.3


_______________________________________________
pdm-devel mailing list
pdm-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pdm-devel