From mboxrd@z Thu Jan 1 00:00:00 1970
Return-Path: <pbs-devel-bounces@lists.proxmox.com>
Received: from firstgate.proxmox.com (firstgate.proxmox.com [IPv6:2a01:7e0:0:424::9])
by lore.proxmox.com (Postfix) with ESMTPS id E2B591FF16B
for <inbox@lore.proxmox.com>; Thu, 6 Mar 2025 13:45:18 +0100 (CET)
Received: from firstgate.proxmox.com (localhost [127.0.0.1])
by firstgate.proxmox.com (Proxmox) with ESMTP id 6B7B860C9;
Thu, 6 Mar 2025 13:45:14 +0100 (CET)
From: Shannon Sterz <s.sterz@proxmox.com>
To: pbs-devel@lists.proxmox.com
Date: Thu, 6 Mar 2025 13:43:49 +0100
Message-Id: <20250306124349.288370-20-s.sterz@proxmox.com>
X-Mailer: git-send-email 2.39.5
In-Reply-To: <20250306124349.288370-1-s.sterz@proxmox.com>
References: <20250306124349.288370-1-s.sterz@proxmox.com>
MIME-Version: 1.0
X-SPAM-LEVEL: Spam detection results: 0
AWL 0.011 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
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] [PATCH proxmox 19/19] tree-wide: fix intra doc links
X-BeenThere: pbs-devel@lists.proxmox.com
X-Mailman-Version: 2.1.29
Precedence: list
List-Id: Proxmox Backup Server development discussion
<pbs-devel.lists.proxmox.com>
List-Unsubscribe: <https://lists.proxmox.com/cgi-bin/mailman/options/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=unsubscribe>
List-Archive: <http://lists.proxmox.com/pipermail/pbs-devel/>
List-Post: <mailto:pbs-devel@lists.proxmox.com>
List-Help: <mailto:pbs-devel-request@lists.proxmox.com?subject=help>
List-Subscribe: <https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel>,
<mailto:pbs-devel-request@lists.proxmox.com?subject=subscribe>
Reply-To: Proxmox Backup Server development discussion
<pbs-devel@lists.proxmox.com>
Content-Type: text/plain; charset="us-ascii"
Content-Transfer-Encoding: 7bit
Errors-To: pbs-devel-bounces@lists.proxmox.com
Sender: "pbs-devel" <pbs-devel-bounces@lists.proxmox.com>
this fixes intra document links or rephrases the documentation in a
more appropriate way to remove all `broken_intra_doc_links` warnings.
Signed-off-by: Shannon Sterz <s.sterz@proxmox.com>
---
proxmox-access-control/src/acl.rs | 15 +++++++--------
proxmox-acme/src/async_client.rs | 2 +-
proxmox-client/src/client.rs | 2 +-
proxmox-rest-server/src/api_config.rs | 4 ++--
proxmox-rest-server/src/worker_task.rs | 5 ++---
5 files changed, 13 insertions(+), 15 deletions(-)
diff --git a/proxmox-access-control/src/acl.rs b/proxmox-access-control/src/acl.rs
index 5a676d3d..b8041688 100644
--- a/proxmox-access-control/src/acl.rs
+++ b/proxmox-access-control/src/acl.rs
@@ -39,8 +39,7 @@ pub struct AclTree {
/// Node representing ACLs for a certain ACL path.
#[derive(Default)]
pub struct AclTreeNode {
- /// [User](pbs_api_types::User) or
- /// [Token](pbs_api_types::ApiToken) ACLs for this node.
+ /// `User` or `Token` ACLs for this node.
pub users: HashMap<Authid, HashMap<String, bool>>,
/// `Group` ACLs for this node (not yet implemented)
pub groups: HashMap<String, HashMap<String, bool>>,
@@ -60,8 +59,8 @@ impl AclTreeNode {
/// Returns applicable role and their propagation status for a given [Authid].
///
- /// If the `Authid` is a [User](pbs_api_types::User) that has no specific `Roles` configured on
- /// this node, applicable `Group` roles will be returned instead.
+ /// If the `Authid` is a `User` that has no specific `Roles` configured on this node,
+ /// applicable `Group` roles will be returned instead.
///
/// If `leaf` is `false`, only those roles where the propagate flag in the ACL is set to `true`
/// are returned. Otherwise, all roles will be returned.
@@ -558,14 +557,14 @@ pub fn lock_config() -> Result<ApiLockGuard, Error> {
open_api_lockfile(acl_config_lock(), None, true)
}
-/// Reads the [`AclTree`] from the [default path](ACL_CFG_FILENAME).
+/// Reads the [`AclTree`] from `acl.cfg` in the configuration directory.
pub fn config() -> Result<(AclTree, ConfigDigest), Error> {
let path = acl_config();
AclTree::load(&path)
}
-/// Returns a cached [`AclTree`] or fresh copy read directly from the [default
-/// path](ACL_CFG_FILENAME)
+/// Returns a cached [`AclTree`] or a fresh copy read directly from `acl.cfg` in the configuration
+/// directory.
///
/// Since the AclTree is used for every API request's permission check, this caching mechanism
/// allows to skip reading and parsing the file again if it is unchanged.
@@ -620,7 +619,7 @@ pub fn cached_config() -> Result<Arc<AclTree>, Error> {
Ok(config)
}
-/// Saves an [`AclTree`] to the [default path](ACL_CFG_FILENAME), ensuring proper ownership and
+/// Saves an [`AclTree`] to `acl.cfg` in the configuration directory, ensuring proper ownership and
/// file permissions.
pub fn save_config(acl: &AclTree) -> Result<(), Error> {
let mut raw: Vec<u8> = Vec::new();
diff --git a/proxmox-acme/src/async_client.rs b/proxmox-acme/src/async_client.rs
index ce5a6c79..6e38570f 100644
--- a/proxmox-acme/src/async_client.rs
+++ b/proxmox-acme/src/async_client.rs
@@ -342,7 +342,7 @@ impl AcmeClient {
/// Get the directory URL without querying the `Directory` structure.
///
- /// The difference to [`directory`](Client::directory()) is that this does not
+ /// The difference to [`directory`](AcmeClient::directory()) is that this does not
/// attempt to fetch the directory data from the ACME server.
pub fn directory_url(&self) -> &str {
&self.directory_url
diff --git a/proxmox-client/src/client.rs b/proxmox-client/src/client.rs
index a1b4eee2..6f1c9ef1 100644
--- a/proxmox-client/src/client.rs
+++ b/proxmox-client/src/client.rs
@@ -62,7 +62,7 @@ impl TlsOptions {
}
}
-/// A Proxmox API client base backed by a [`proxmox_http::Client`].
+/// A Proxmox API client base backed by a [`proxmox_http::client::Client`].
pub struct Client {
api_url: Uri,
auth: Mutex<Option<Arc<AuthenticationKind>>>,
diff --git a/proxmox-rest-server/src/api_config.rs b/proxmox-rest-server/src/api_config.rs
index 7dbcad52..b20b2da0 100644
--- a/proxmox-rest-server/src/api_config.rs
+++ b/proxmox-rest-server/src/api_config.rs
@@ -47,7 +47,7 @@ impl ApiConfig {
///
/// `get_index_fn` - callback to generate the root page
/// (index). Please note that this functions gets a reference to
- /// the [ApiConfig], so it can use [Handlebars] templates
+ /// the [ApiConfig], so it can use [handlebars::Handlebars] templates
/// ([render_template](Self::render_template) to generate pages.
pub fn new<B: Into<PathBuf>>(basedir: B, env_type: RpcEnvironmentType) -> Self {
Self {
@@ -175,7 +175,7 @@ impl ApiConfig {
self.env_type
}
- /// Register a [Handlebars] template file
+ /// Register a [handlebars::Handlebars] template file
///
/// Those templates cane be use with [render_template](Self::render_template) to generate pages.
#[cfg(feature = "templates")]
diff --git a/proxmox-rest-server/src/worker_task.rs b/proxmox-rest-server/src/worker_task.rs
index 9351bbee..6368206c 100644
--- a/proxmox-rest-server/src/worker_task.rs
+++ b/proxmox-rest-server/src/worker_task.rs
@@ -38,9 +38,8 @@ pub async fn last_worker_future() {
let _ = last_worker_listeners().subscribe().wait_for(|&v| v).await;
}
-/// This drives the [`last_worker_listener()`] futures: if a shutdown is requested and no workers
-/// and no internal tasks are running, the [`last_worker_listener()`] futures are triggered to
-/// finish.
+/// This drives the worker listener futures: if a shutdown is requested and no workers and no
+/// internal tasks are running, the last worker listener futures are triggered to finish.
pub fn check_last_worker() {
if proxmox_daemon::is_shutdown_requested()
&& WORKER_COUNT.load(Ordering::Acquire) == 0
--
2.39.5
_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel