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 816E96D146 for ; Thu, 4 Feb 2021 12:34:53 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 735342375A for ; Thu, 4 Feb 2021 12:34:53 +0100 (CET) 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) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS id C3EE82374C for ; Thu, 4 Feb 2021 12:34:52 +0100 (CET) Received: from proxmox-new.maurer-it.com (localhost.localdomain [127.0.0.1]) by proxmox-new.maurer-it.com (Proxmox) with ESMTP id 8F465461CF for ; Thu, 4 Feb 2021 12:34:52 +0100 (CET) Message-ID: Date: Thu, 4 Feb 2021 12:34:51 +0100 MIME-Version: 1.0 User-Agent: Mozilla/5.0 (X11; Linux x86_64; rv:86.0) Gecko/20100101 Thunderbird/86.0 Content-Language: en-US To: Proxmox Backup Server development discussion , Dominik Csapak References: <20201211121709.6364-1-d.csapak@proxmox.com> From: Thomas Lamprecht In-Reply-To: <20201211121709.6364-1-d.csapak@proxmox.com> Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 7bit X-SPAM-LEVEL: Spam detection results: 0 AWL -0.063 Adjusted score from AWL reputation of From: address 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] applied: [PATCH proxmox-backup v3] docs: explain some technical details about datastores/chunks 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, 04 Feb 2021 11:34:53 -0000 On 11.12.20 13:17, Dominik Csapak wrote: > adds explanations for: > * what datastores are > * their relation with snapshots/chunks > * basic information about chunk directory structures > * fixed-/dynamically-sized chunks > * special handling of encrypted chunks > * hash collision probability > * limitation of file-based backups > > Signed-off-by: Dominik Csapak > --- > changes from v2: > * incoporate @F.Ebners and @D.Whytes suggestions, thanks :) > > docs/index.rst | 1 + > docs/technical-overview.rst | 166 ++++++++++++++++++++++++++++++++++++ > docs/terminology.rst | 3 + > 3 files changed, 170 insertions(+) > create mode 100644 docs/technical-overview.rst > > applied, thanks! FYI, I made two followups: * fixing up the line length (seemed a bit arbitrary, maybe let this get enforced by your editor for .rst/.adoc files) * a few style nits to better comply with our technical writing guide, mostly dropping the usage of "we" (we who?). see our guide in the intranet (Avoid first person (plural)) for details. Threw in also some additions in that comment, was to much work to separate those two from each other..