[pbs-devel] [PATCH backup 3/4] datastore: docs: escape <uuid>
Maximiliano Sandoval
m.sandoval at proxmox.com
Tue Dec 3 14:41:38 CET 2024
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 at 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
More information about the pbs-devel
mailing list