From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id 29871656BD for ; Thu, 23 Jul 2020 12:17:50 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 1B86928069 for ; Thu, 23 Jul 2020 12:17:20 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [212.186.127.180]) (using TLSv1.3 with cipher TLS_AES_256_GCM_SHA384 (256/256 bits) key-exchange X25519 server-signature RSA-PSS (2048 bits)) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id 5794128061 for ; Thu, 23 Jul 2020 12:17:19 +0200 (CEST) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 207EB43325 for ; Thu, 23 Jul 2020 12:17:19 +0200 (CEST) From: Dylan Whyte To: pbs-devel@lists.proxmox.com Date: Thu, 23 Jul 2020 12:17:12 +0200 Message-Id: <20200723101712.23358-1-d.whyte@proxmox.com> X-Mailer: git-send-email 2.20.1 MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RCVD_IN_DNSWL_MED -2.3 Sender listed at https://www.dnswl.org/, medium trust SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record Subject: [pbs-devel] [PATCH pbs-docs] docs: fix formatting; improve grammar and wording X-BeenThere: pbs-devel@lists.proxmox.com X-Mailman-Version: 2.1.29 Precedence: list List-Id: Proxmox Backup Server development discussion List-Unsubscribe: , List-Archive: List-Post: List-Help: List-Subscribe: , X-List-Received-Date: Thu, 23 Jul 2020 10:17:50 -0000 Formatting: local-zfs.rst: Add all paragraphs with "IMPORTANT:" prefix to highlighted block. Replace {pve} with Proxmox VE. Fix minor grammatical errors. Reword one sentence for improved readability. Signed-off-by: Dylan Whyte --- docs/local-zfs.rst | 20 ++++++++++---------- docs/pxar/description.rst | 2 +- docs/sysadmin.rst | 2 +- 3 files changed, 12 insertions(+), 12 deletions(-) diff --git a/docs/local-zfs.rst b/docs/local-zfs.rst index eeb98f7b..d3f0fe88 100644 --- a/docs/local-zfs.rst +++ b/docs/local-zfs.rst @@ -40,10 +40,9 @@ If you use a dedicated cache and/or log disk, you should use an enterprise class SSD (e.g. Intel SSD DC S3700 Series). This can increase the overall performance significantly. -IMPORTANT: Do not use ZFS on top of hardware controller which has its -own cache management. ZFS needs to directly communicate with disks. An -HBA adapter is the way to go, or something like LSI controller flashed -in ``IT`` mode. +.. IMPORTANT:: Do not use ZFS on top of a hardware controller which has its own + cache management. ZFS needs to communicate directly with disks. An HBA adapter + or an LSI controller flashed in ``IT`` mode are better options. ZFS Administration @@ -144,8 +143,8 @@ As `` it is possible to use more devices, like it's shown in Add cache and log to an existing pool ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -If you have a pool without cache and log. First partition the SSD in -2 partition with `parted` or `gdisk` +If you have a pool without cache and log. First partition the SSD into +2 partitions with `parted` or `gdisk` .. important:: Always use GPT partition tables. @@ -192,7 +191,7 @@ With `systemd-boot`: # pve-efiboot-tool init .. NOTE:: `ESP` stands for EFI System Partition, which is setup as partition #2 on - bootable disks setup by the {pve} installer since version 5.4. For details, see + bootable disks setup by the Proxmox VE installer since version 5.4. For details, see xref:sysboot_systemd_boot_setup[Setting up a new partition for use as synced ESP]. With `grub`: @@ -227,8 +226,8 @@ favourite editor, and uncomment the `ZED_EMAIL_ADDR` setting: Please note Proxmox Backup forwards mails to `root` to the email address configured for the root user. -IMPORTANT: The only setting that is required is `ZED_EMAIL_ADDR`. All -other settings are optional. +.. IMPORTANT:: The only setting that is required is `ZED_EMAIL_ADDR`. All other + settings are optional. Limit ZFS Memory Usage ^^^^^^^^^^^^^^^^^^^^^^ @@ -244,7 +243,8 @@ host. Use your preferred editor to change the configuration in This example setting limits the usage to 8GB. -.. IMPORTANT:: If your root file system is ZFS you must update your initramfs every time this value changes: +.. IMPORTANT:: If your root file system is ZFS, you must update your initramfs + every time this value changes: .. code-block:: console diff --git a/docs/pxar/description.rst b/docs/pxar/description.rst index ad8bd400..82b15fd9 100644 --- a/docs/pxar/description.rst +++ b/docs/pxar/description.rst @@ -9,7 +9,7 @@ which caters to a similar use-case. The ``.pxar`` format is adapted to fulfill the specific needs of the Proxmox Backup Server, for example, efficient storage of hardlinks. The format is designed to reduce storage space needed on the server by achieving -a high level of de-duplication. +a high level of deduplication. Creating an Archive ^^^^^^^^^^^^^^^^^^^ diff --git a/docs/sysadmin.rst b/docs/sysadmin.rst index 9c564f03..c6ebe47a 100644 --- a/docs/sysadmin.rst +++ b/docs/sysadmin.rst @@ -14,7 +14,7 @@ repository to roll out all Proxmox related packages. This includes updates to some Debian packages when necessary. We also deliver a specially optimized Linux kernel, where we enable -all required virtualization and container features. That kernel +all required virtualization and container features. This kernel includes drivers for ZFS_, and several hardware drivers. For example, we ship Intel network card drivers to support their newest hardware. -- 2.20.1