public inbox for pbs-devel@lists.proxmox.com
 help / color / mirror / Atom feed
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH backup 3/4] datastore: docs: escape <uuid>
Date: Tue,  3 Dec 2024 14:41:38 +0100	[thread overview]
Message-ID: <20241203134139.399703-3-m.sandoval@proxmox.com> (raw)
In-Reply-To: <20241203134139.399703-1-m.sandoval@proxmox.com>

Fixes the cargo doc lint:

```
warning: unclosed HTML tag `uuid`
  --> pbs-datastore/src/datastore.rs:60:41
   |
60 | ///  - could not stat /dev/disk/by-uuid/<uuid>
   |                                         ^^^^^^
   |
   = note: `#[warn(rustdoc::invalid_html_tags)]` on by default

warning: unclosed HTML tag `uuid`
  --> pbs-datastore/src/datastore.rs:61:26
   |
61 | ///  - /dev/disk/by-uuid/<uuid> is not a block device
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 pbs-datastore/src/datastore.rs | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/pbs-datastore/src/datastore.rs b/pbs-datastore/src/datastore.rs
index cf55befa..0801b4bf 100644
--- a/pbs-datastore/src/datastore.rs
+++ b/pbs-datastore/src/datastore.rs
@@ -56,9 +56,9 @@ pub fn check_backup_owner(owner: &Authid, auth_id: &Authid) -> Result<(), Error>
 /// returning false.
 ///
 /// Reasons it could fail other than not being mounted where expected:
-///  - could not read /proc/self/mountinfo
-///  - could not stat /dev/disk/by-uuid/<uuid>
-///  - /dev/disk/by-uuid/<uuid> is not a block device
+///  - could not read `/proc/self/mountinfo`
+///  - could not stat `/dev/disk/by-uuid/<uuid>`
+///  - `/dev/disk/by-uuid/<uuid>` is not a block device
 ///
 /// Since these are very much out of our control, there is no real value in distinguishing
 /// between them, so for this function they all are treated as 'device not mounted'
-- 
2.39.5



_______________________________________________
pbs-devel mailing list
pbs-devel@lists.proxmox.com
https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel


  parent reply	other threads:[~2024-12-03 13:42 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-12-03 13:41 [pbs-devel] [PATCH backup 1/4] datastore: docs: turn uri into hyperlink Maximiliano Sandoval
2024-12-03 13:41 ` [pbs-devel] [PATCH backup 2/4] pxar: extract: docs: remove redundant explicit link Maximiliano Sandoval
2024-12-03 13:41 ` Maximiliano Sandoval [this message]
2024-12-03 13:41 ` [pbs-devel] [PATCH backup 4/4] auth: doc: Explicitly set namespace for UserInfomation Maximiliano Sandoval
2024-12-04 13:42 ` [pbs-devel] applied-series: [PATCH backup 1/4] datastore: docs: turn uri into hyperlink Fabian Grünbichler

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20241203134139.399703-3-m.sandoval@proxmox.com \
    --to=m.sandoval@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal