proxmox-mirrors/proxmox-backup
1
0
Fork 1
mirror of https://git.proxmox.com/git/proxmox-backup synced 2025-10-04 11:22:56 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

docs: client: fix formatting by using double ticks

Browse Source 
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 <c.ebner@proxmox.com>
Reviewed-by: Shannon Sterz <s.sterz@proxmox.com>
This commit is contained in:
Christian Ebner 2024-11-18 10:24:35 +01:00 committed by Thomas Lamprecht
parent 98ac310845
commit ec4ffa924a
1 changed files with 12 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

23
docs/backup-client.rst
View File

@ -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 re-reading and then detecting the corresponding chunks don't need to be uploaded
after all is time consuming and undesired. after all is time consuming and undesired.
The backup client's `change-detection-mode` can be switched from default to The backup client's ``change-detection-mode`` can be switched from default to
`metadata` based detection to reduce limitations as described above, instructing ``metadata`` based detection to reduce limitations as described above,
the client to avoid re-reading files with unchanged metadata whenever possible. 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 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 is stored into two separate files: the ``mpxar`` containing the archive's
and the `ppxar` containing a concatenation of the file contents. This splitting metadata and the ``ppxar`` containing a concatenation of the file contents. This
allows for efficient metadata lookups. When creating the backup archives, the splitting allows for efficient metadata lookups. When creating the backup
current file metadata is compared to the one looked up in the previous `mpxar` archives, the current file metadata is compared to the one looked up in the
archive. The operational details are explained more in depth in the previous ``mpxar`` archive. The operational details are explained more in depth
:ref:`technical documentation <change-detection-mode-metadata>`. in the :ref:`technical documentation <change-detection-mode-metadata>`.
Using the `change-detection-mode` set to `data` allows to create the same split Using the ``change-detection-mode`` set to ``data`` allows to create the same
archive as when using the `metadata` mode, but without using a previous 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 reference and therefore reencoding all file payloads. For details of this mode
please see the :ref:`technical documentation <change-detection-mode-data>`. please see the :ref:`technical documentation <change-detection-mode-data>`.