[pbs-devel] [PATCH backup 3/3] restore: docs: escape <uid> with code block

Maximiliano Sandoval m.sandoval at proxmox.com
Tue Dec 3 10:32:43 CET 2024


otherwise:

```
warning: unclosed HTML tag `uid`
   --> proxmox-file-restore/src/main.rs:686:63
    |
686 | /// "www-data", so we use a custom one in /run/proxmox-backup/<uid> instead.
    |                                                               ^^^^^
    |
    = note: `#[warn(rustdoc::invalid_html_tags)]` on by default
```

Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 proxmox-file-restore/src/main.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/proxmox-file-restore/src/main.rs b/proxmox-file-restore/src/main.rs
index 59ccbe52..572e2d18 100644
--- a/proxmox-file-restore/src/main.rs
+++ b/proxmox-file-restore/src/main.rs
@@ -663,7 +663,7 @@ fn main() {
 
 /// Returns a runtime dir owned by the current user.
 /// Note that XDG_RUNTIME_DIR is not always available, especially for non-login users like
-/// "www-data", so we use a custom one in /run/proxmox-backup/<uid> instead.
+/// "www-data", so we use a custom one in `/run/proxmox-backup/<uid>` instead.
 pub fn get_user_run_dir() -> Result<std::path::PathBuf, Error> {
     let uid = nix::unistd::Uid::current();
     let mut path: std::path::PathBuf = pbs_buildcfg::PROXMOX_BACKUP_RUN_DIR.into();
-- 
2.39.5





More information about the pbs-devel mailing list