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 2E97970C60 for ; Mon, 16 May 2022 18:27:54 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id EC849200E0 for ; Mon, 16 May 2022 18:27:53 +0200 (CEST) Received: from proxmox-new.maurer-it.com (proxmox-new.maurer-it.com [94.136.29.106]) (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 676D92009F for ; Mon, 16 May 2022 18:27:52 +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 3EA6343617 for ; Mon, 16 May 2022 18:27:52 +0200 (CEST) From: Stoiko Ivanov To: pbs-devel@lists.proxmox.com Date: Mon, 16 May 2022 16:27:30 +0000 Message-Id: <20220516162733.62060-4-s.ivanov@proxmox.com> X-Mailer: git-send-email 2.30.2 In-Reply-To: <20220516162733.62060-1-s.ivanov@proxmox.com> References: <20220516162733.62060-1-s.ivanov@proxmox.com> MIME-Version: 1.0 Content-Transfer-Encoding: 8bit X-SPAM-LEVEL: Spam detection results: 0 AWL 0.197 Adjusted score from AWL reputation of From: address BAYES_00 -1.9 Bayes spam probability is 0 to 1% 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 T_SCC_BODY_TEXT_LINE -0.01 - Subject: [pbs-devel] [PATCH proxmox-backup 3/6] docs: use case-matching keys for glossary 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: Mon, 16 May 2022 16:27:54 -0000 this silences warnings a la: ``` WARNING: term container not found in case sensitive match.made a reference to Container instead ``` the issue is purely cosmetic during build, and should vanish in a newer version of sphinx-doc [0]. [0] https://github.com/sphinx-doc/sphinx/issues/7636 Signed-off-by: Stoiko Ivanov --- docs/introduction.rst | 21 +++++++++++---------- docs/terminology.rst | 11 ++++++----- 2 files changed, 17 insertions(+), 15 deletions(-) diff --git a/docs/introduction.rst b/docs/introduction.rst index ed1816d3..47b5d606 100644 --- a/docs/introduction.rst +++ b/docs/introduction.rst @@ -5,10 +5,11 @@ What is Proxmox Backup Server? ------------------------------ Proxmox Backup Server is an enterprise-class, client-server backup solution that -is capable of backing up :term:`virtual machine`\ s, :term:`container`\ s, and -physical hosts. It is specially optimized for the `Proxmox Virtual Environment`_ -platform and allows you to back up your data securely, even between remote -sites, providing easy management through a web-based user interface. +is capable of backing up :term:`virtual machine`\ s, +:term:`container`\ s, and physical hosts. It is specially optimized +for the `Proxmox Virtual Environment`_ platform and allows you to back up your +data securely, even between remote sites, providing easy management through a +web-based user interface. It supports deduplication, compression, and authenticated encryption (AE_). Using :term:`Rust` as the implementation language guarantees @@ -34,18 +35,18 @@ For QEMU_ and LXC_ within `Proxmox Virtual Environment`_, we deliver an integrated client. A single backup is allowed to contain several archives. For example, when you -backup a :term:`virtual machine`, each disk is stored as a separate archive -inside that backup. The VM configuration itself is stored as an extra file. -This way, it's easy to access and restore only the important parts of the -backup, without the need to scan the whole backup. +backup a :term:`virtual machine`, each disk is stored as a +separate archive inside that backup. The VM configuration itself is stored as +an extra file. This way, it's easy to access and restore only the important +parts of the backup, without the need to scan the whole backup. Main Features ------------- :Support for Proxmox VE: The `Proxmox Virtual Environment`_ is fully - supported, and you can easily backup :term:`virtual machine`\ s and - :term:`container`\ s. + supported, and you can easily backup :term:`virtual machine`\ s and + :term:`container`\ s. :Performance: The whole software stack is written in :term:`Rust`, in order to provide high speed and memory efficiency. diff --git a/docs/terminology.rst b/docs/terminology.rst index c5551818..1e12f9c1 100644 --- a/docs/terminology.rst +++ b/docs/terminology.rst @@ -68,13 +68,14 @@ Backup Type The backup server groups backups by *type*, where *type* is one of: ``vm`` - This type is used for :term:`virtual machine`\ s. It typically - consists of the virtual machine's configuration file and an image archive - for each disk. + This type is used for :term:`virtual machine`\ s. It + typically consists of the virtual machine's configuration file and an image + archive for each disk. ``ct`` - This type is used for :term:`container`\ s. It consists of the container's - configuration and a single file archive for the filesystem's contents. + This type is used for :term:`container`\ s. It consists of the + container's configuration and a single file archive for the filesystem's + contents. ``host`` This type is used for file/directory backups created from within a machine. -- 2.30.2