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 4C6981FF15F for ; Mon, 2 Dec 2024 10:58:19 +0100 (CET) Received: from firstgate.proxmox.com (localhost [127.0.0.1]) by firstgate.proxmox.com (Proxmox) with ESMTP id EA83112F37; Mon, 2 Dec 2024 10:58:17 +0100 (CET) From: Maximiliano Sandoval To: pbs-devel@lists.proxmox.com Date: Mon, 2 Dec 2024 10:58:04 +0100 Message-Id: <20241202095808.128299-9-m.sandoval@proxmox.com> X-Mailer: git-send-email 2.39.5 In-Reply-To: <20241202095808.128299-1-m.sandoval@proxmox.com> References: <20241202095808.128299-1-m.sandoval@proxmox.com> MIME-Version: 1.0 X-SPAM-LEVEL: Spam detection results: 0 AWL -1.348 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 FSL_BULK_SIG 0.001 Bulk signature with no Unsubscribe KAM_DMARC_STATUS 0.01 Test Rule for DKIM or SPF Failure with Strict Alignment RAZOR2_CF_RANGE_51_100 1.886 Razor2 gives confidence level above 50% RAZOR2_CHECK 0.922 Listed in Razor2 (http://razor.sf.net/) SPF_HELO_NONE 0.001 SPF: HELO does not publish an SPF Record SPF_PASS -0.001 SPF: sender matches SPF record URIBL_SBL_A 0.1 Contains URL's A record listed in the Spamhaus SBL blocklist [185.199.110.153, 185.199.108.153, 185.199.109.153, 185.199.111.153] Subject: [pbs-devel] [PATCH backup 09/13] docs: fix outer docs comments 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" Fixes the suspicious_doc_comments clippy lints: ``` warning: this is an outer doc comment and does not apply to the parent module or crate --> proxmox-restore-daemon/src/main.rs:1:1 | 1 | ///! Daemon binary to run inside a micro-VM for secure single file restore of disk images | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments = note: `#[warn(clippy::suspicious_doc_comments)]` on by default help: use an inner doc comment to document the parent module or crate | 1 | //! Daemon binary to run inside a micro-VM for secure single file restore of disk images | warning: this is an outer doc comment and does not apply to the parent module or crate --> proxmox-restore-daemon/src/proxmox_restore_daemon/mod.rs:1:1 | 1 | ///! File restore VM related functionality | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments help: use an inner doc comment to document the parent module or crate | 1 | //! File restore VM related functionality | warning: this is an outer doc comment and does not apply to the parent module or crate --> proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs:1:1 | 1 | ///! File-restore API running inside the restore VM | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ | = help: for further information visit https://rust-lang.github.io/rust-clippy/master/index.html#suspicious_doc_comments help: use an inner doc comment to document the parent module or crate | 1 | //! File-restore API running inside the restore VM | ``` Signed-off-by: Maximiliano Sandoval --- proxmox-restore-daemon/src/main.rs | 2 +- proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs | 2 +- proxmox-restore-daemon/src/proxmox_restore_daemon/mod.rs | 2 +- 3 files changed, 3 insertions(+), 3 deletions(-) diff --git a/proxmox-restore-daemon/src/main.rs b/proxmox-restore-daemon/src/main.rs index 0131d771b..7f61faed8 100644 --- a/proxmox-restore-daemon/src/main.rs +++ b/proxmox-restore-daemon/src/main.rs @@ -1,4 +1,4 @@ -///! Daemon binary to run inside a micro-VM for secure single file restore of disk images +//! Daemon binary to run inside a micro-VM for secure single file restore of disk images use std::fs::File; use std::io::prelude::*; use std::os::unix::{ diff --git a/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs b/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs index 6c27a8861..8955772bc 100644 --- a/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs +++ b/proxmox-restore-daemon/src/proxmox_restore_daemon/api.rs @@ -1,4 +1,4 @@ -///! File-restore API running inside the restore VM +//! File-restore API running inside the restore VM use std::ffi::OsStr; use std::fs; use std::os::unix::ffi::OsStrExt; diff --git a/proxmox-restore-daemon/src/proxmox_restore_daemon/mod.rs b/proxmox-restore-daemon/src/proxmox_restore_daemon/mod.rs index 58e2bb6e1..d50c3287a 100644 --- a/proxmox-restore-daemon/src/proxmox_restore_daemon/mod.rs +++ b/proxmox-restore-daemon/src/proxmox_restore_daemon/mod.rs @@ -1,4 +1,4 @@ -///! File restore VM related functionality +//! File restore VM related functionality mod api; pub use api::*; -- 2.39.5 _______________________________________________ pbs-devel mailing list pbs-devel@lists.proxmox.com https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel