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) server-digest SHA256) (No client certificate requested) by lists.proxmox.com (Postfix) with ESMTPS id AD5F29229B for ; Fri, 5 Apr 2024 12:27:49 +0200 (CEST) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id 9B4721170A for ; Fri, 5 Apr 2024 12:27:19 +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) server-digest SHA256) (No client certificate requested) by firstgate.proxmox.com (Proxmox) with ESMTPS for ; Fri, 5 Apr 2024 12:27:18 +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 8210E46423 for ; Fri, 5 Apr 2024 12:27:18 +0200 (CEST) Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: quoted-printable In-Reply-To: <20240328123707.336951-56-c.ebner@proxmox.com> References: <20240328123707.336951-1-c.ebner@proxmox.com> <20240328123707.336951-56-c.ebner@proxmox.com> From: Fabian =?utf-8?q?Gr=C3=BCnbichler?= To: Christian Ebner , pbs-devel@lists.proxmox.com Date: Fri, 05 Apr 2024 12:26:59 +0200 Message-ID: <171231281983.1926770.7084972109083465297@yuna.proxmox.com> User-Agent: alot/0.10 X-SPAM-LEVEL: Spam detection results: 0 AWL -0.342 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_ASCII_DIVIDERS 0.8 Email that uses ascii formatting dividers and possible spam tricks 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 URIBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to URIBL was blocked. See http://wiki.apache.org/spamassassin/DnsBlocklists#dnsbl-block for more information. [pxar-format-overview.dot, meta-format-overview.dot] Subject: Re: [pbs-devel] [PATCH v3 proxmox-backup 55/58] docs: describe file format for split payload files 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: Fri, 05 Apr 2024 10:27:49 -0000 Quoting Christian Ebner (2024-03-28 13:37:04) > Signed-off-by: Christian Ebner > --- > changes since version 2: > - not present in previous version >=20 > docs/file-formats.rst | 32 ++++++++++++++++++++++ > docs/meta-format-overview.dot | 50 +++++++++++++++++++++++++++++++++++ > 2 files changed, 82 insertions(+) > create mode 100644 docs/meta-format-overview.dot >=20 > diff --git a/docs/file-formats.rst b/docs/file-formats.rst > index 43ecfefce..292660579 100644 > --- a/docs/file-formats.rst > +++ b/docs/file-formats.rst > @@ -8,6 +8,38 @@ Proxmox File Archive Format (``.pxar``) > =20 > .. graphviz:: pxar-format-overview.dot > =20 > +.. _pxar-meta-format: > + > +Proxmox File Archive Format - Meta (``.mpxar``) > +----------------------------------------------- > + > +.. graphviz:: meta-format-overview.dot > + > +.. _ppxar-format: > + > +Proxmox File Archive Format - Payload (``.ppxar``) > +-------------------------------------------------- > + > +The pxar payload contains a concatenation of regular file payloads, > +each prefixed by a `PAYLOAD` header. Further, the entries can have > +some padding following the actual payload, if a referenced chunk was > +not fully reused: > + > +.. list-table:: > + :widths: auto > + > + * - ``PAYLOAD_START_MARKER`` > + - ``[u8; 16]`` > + * - ``PAYLOAD`` > + - ``header with [u8; 16]`` > + * - ``Payload`` > + - ``raw regular file payload`` > + * - ``Padding`` > + - ``none if chunk fully reused`` well.. technically somehow true, but for a format description this only giv= es half the picture IMHO ;) at least mentioning that the Padding itself consis= ts of (possibly truncated) ``PAYLOAD`` entries would probably help for new peo= ple trying to understand the structure. also, mentioning what the 16 bytes in t= he header mean would be helpful? it might also be nice to dump the magic values and include them here and in= the other related sections, like for the blobs (but always correct, not as a possibly outdated copy ;)) > + * - ``...`` > + - ``Further list of header, payload and padding`` > + * - ``PAYLOAD_TAIL_MARKER`` > + - ``[u8; 16]`` > =20 > .. _data-blob-format: