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 0FF041FF170 for ; Tue, 3 Dec 2024 14:41:36 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id E2F20553B; Tue, 3 Dec 2024 14:41:41 +0100 (CET) From: Maximiliano Sandoval To: pbs-devel@lists.proxmox.com Date: Tue, 3 Dec 2024 14:41:37 +0100 Message-Id: <20241203134139.399703-2-m.sandoval@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241203134139.399703-1-m.sandoval@proxmox.com> References: <20241203134139.399703-1-m.sandoval@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL 0.106 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 RCVD_IN_VALIDITY_CERTIFIED_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_RPBL_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. RCVD_IN_VALIDITY_SAFE_BLOCKED 0.001 ADMINISTRATOR NOTICE: The query to Validity was blocked. See https://knowledge.validity.com/hc/en-us/articles/20961730681243 for more information. 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. [extract.rs] Subject: [pbs-devel] [PATCH backup 2/4] pxar: extract: docs: remove redundant explicit link 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" Also fix `Entries` link. Fixes the cargo doc lint: ``` warning: redundant explicit link target --> pbs-client/src/pxar/extract.rs:212:27 | 212 | /// * The [`Entry`][E]'s filename is invalid (contains nul bytes or a slash) | ------- ^ explicit target is redundant | | | because label contains path that resolves to same destination | note: referenced explicit link target defined here --> pbs-client/src/pxar/extract.rs:221:14 | 221 | /// [E]: pxar::Entry | ^^^^^^^^^^^ = note: when a link's destination is not specified, the label is used to resolve intra-doc links = note: `#[warn(rustdoc::redundant_explicit_links)]` on by default help: remove explicit link target | 212 | /// * The [`Entry`]'s filename is invalid (contains nul bytes or a slash) | ~~~~~~~~~ warning: redundant explicit link target --> pbs-client/src/pxar/extract.rs:215:37 | 215 | /// fetching the next [`Entry`][E]), the error may be handled by the | ------- ^ explicit target is redundant | | | because label contains path that resolves to same destination | note: referenced explicit link target defined here --> pbs-client/src/pxar/extract.rs:221:14 | 221 | /// [E]: pxar::Entry | ^^^^^^^^^^^ = note: when a link's destination is not specified, the label is used to resolve intra-doc links help: remove explicit link target | 215 | /// fetching the next [`Entry`]), the error may be handled by the ``` Signed-off-by: Maximiliano Sandoval --- pbs-client/src/pxar/extract.rs | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/pbs-client/src/pxar/extract.rs b/pbs-client/src/pxar/extract.rs index cfbd8d51..48e3aef4 100644 --- a/pbs-client/src/pxar/extract.rs +++ b/pbs-client/src/pxar/extract.rs @@ -202,23 +202,22 @@ where { type Item = Result<(), Error>; - /// Performs the extraction of [`Entries`][E] yielded by the [`Decoder`][D]. + /// Performs the extraction of [`Entries`][Entry] yielded by the [`Decoder`][D]. /// /// In detail, the [`ExtractorIter`] will stop if and only if one of the /// following conditions is true: /// * The [`Decoder`][D] is exhausted /// * The [`Decoder`][D] failed to read from the archive and consequently /// yielded an [`io::Error`] - /// * The [`Entry`][E]'s filename is invalid (contains nul bytes or a slash) + /// * The [`Entry`]'s filename is invalid (contains nul bytes or a slash) /// /// Should an error occur during any point of extraction (**not** while - /// fetching the next [`Entry`][E]), the error may be handled by the + /// fetching the next [`Entry`]), the error may be handled by the /// [`ErrorHandler`] provided by the [`PxarExtractOptions`] used to /// initialize the iterator. /// /// Extraction errors will have a corresponding [`PxarExtractContext`] attached. /// - /// [E]: pxar::Entry /// [D]: pxar::decoder::Decoder fn next(&mut self) -> Option { if self.state.end_reached { -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel