From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: from firstgate.proxmox.com (firstgate.proxmox.com [212.224.123.68]) by lore.proxmox.com (Postfix) with ESMTPS id 23F7D1FF15F for ; Mon, 18 Nov 2024 10:24:46 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id B258FB2F4; Mon, 18 Nov 2024 10:24:51 +0100 (CET) From: Christian Ebner To: pbs-devel@lists.proxmox.com Date: Mon, 18 Nov 2024 10:24:35 +0100 Message-Id: <20241118092435.81880-4-c.ebner@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241118092435.81880-1-c.ebner@proxmox.com> References: <20241118092435.81880-1-c.ebner@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.031 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% DMARC_MISSING 0.1 Missing DMARC policy KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment 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 docs 3/3] docs: client: fix formatting by using double ticks 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: , Reply-To: Proxmox Backup Server development discussion Content-Type: text/plain; charset="us-ascii" Content-Transfer-Encoding: 7bit Errors-To: pbs-devel-bounces@lists.proxmox.com Sender: "pbs-devel" With single ticks the containing modes and archive formats are displayed cursive, to be consistent with other sections of the documentation use inline blocks. Adapted line wrappings to the additional line length. Signed-off-by: Christian Ebner --- docs/backup-client.rst | 25 +++++++++++++------------ 1 file changed, 13 insertions(+), 12 deletions(-) diff --git a/docs/backup-client.rst b/docs/backup-client.rst index 78e856979..45df440c9 100644 --- a/docs/backup-client.rst +++ b/docs/backup-client.rst @@ -295,19 +295,20 @@ therefore deduplicated). If the backed up files are largely unchanged, re-reading and then detecting the corresponding chunks don't need to be uploaded after all is time consuming and undesired. -The backup client's `change-detection-mode` can be switched from default to -`metadata` based detection to reduce limitations as described above, instructing -the client to avoid re-reading files with unchanged metadata whenever possible. +The backup client's ``change-detection-mode`` can be switched from default to +``metadata`` based detection to reduce limitations as described above, +instructing the client to avoid re-reading files with unchanged metadata +whenever possible. When using this mode, instead of the regular pxar archive, the backup snapshot -is stored into two separate files: the `mpxar` containing the archive's metadata -and the `ppxar` containing a concatenation of the file contents. This splitting -allows for efficient metadata lookups. When creating the backup archives, the -current file metadata is compared to the one looked up in the previous `mpxar` -archive. The operational details are explained more in depth in the -:ref:`technical documentation `. - -Using the `change-detection-mode` set to `data` allows to create the same split -archive as when using the `metadata` mode, but without using a previous +is stored into two separate files: the ``mpxar`` containing the archive's +metadata and the ``ppxar`` containing a concatenation of the file contents. This +splitting allows for efficient metadata lookups. When creating the backup +archives, the current file metadata is compared to the one looked up in the +previous ``mpxar`` archive. The operational details are explained more in depth +in the :ref:`technical documentation `. + +Using the ``change-detection-mode`` set to ``data`` allows to create the same +split archive as when using the ``metadata`` mode, but without using a previous reference and therefore reencoding all file payloads. For details of this mode please see the :ref:`technical documentation `. -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel