[pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct

[pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct

[Maximiliano Sandoval]

Fixes:

```
warning: public documentation for `PxarExtractContext` links to private item `ExtractorIter`
   --> pbs-client/src/pxar/extract.rs:404:27
    |
404 | /// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
    |                           ^^^^^^^^^^^^^ this item is private
    |
    = note: this link will resolve properly if you pass `--document-private-items`
    = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 pbs-client/src/pxar/extract.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pbs-client/src/pxar/extract.rs b/pbs-client/src/pxar/extract.rs
index cfbd8d51..c31e1be8 100644
--- a/pbs-client/src/pxar/extract.rs
+++ b/pbs-client/src/pxar/extract.rs
@@ -401,7 +401,7 @@ where
 }
 
 /// Provides additional [context][C] for [`anyhow::Error`]s that are returned
-/// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
+/// while traversing an ExtractorIter. The [`PxarExtractContext`] can then
 /// be accessed [via `anyhow`'s facilities][A] and may aid during error handling.
 ///
 ///
-- 
2.39.5



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

[pbs-devel] [PATCH backup 2/3] config: acl: docs: link to PRIVILEGES with namespace

[Maximiliano Sandoval]

Otherwise:

```
warning: unresolved link to `PRIVILEGES`
  --> pbs-config/src/acl.rs:15:71
   |
15 | /// Map of pre-defined [Roles](Role) to their associated [privileges](PRIVILEGES) combination
   |                                                                       ^^^^^^^^^^ no item named `PRIVILEGES` in scope
   |
   = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
   = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
```

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

diff --git a/pbs-config/src/acl.rs b/pbs-config/src/acl.rs
index d8138078..e8690560 100644
--- a/pbs-config/src/acl.rs
+++ b/pbs-config/src/acl.rs
@@ -12,8 +12,8 @@ use pbs_api_types::{Authid, Role, Userid, ROLE_NAME_NO_ACCESS};
 
 use crate::{open_backup_lockfile, replace_backup_config, BackupLockGuard};
 
-/// Map of pre-defined [Roles](Role) to their associated [privileges](PRIVILEGES) combination
-/// and description.
+/// Map of pre-defined [Roles](Role) to their associated
+/// [privileges](pbs_api_types::PRIVILEGES) combination and description.
 pub static ROLE_NAMES: LazyLock<HashMap<&'static str, (u64, &'static str)>> = LazyLock::new(|| {
     let mut map = HashMap::new();
 
-- 
2.39.5



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

[pbs-devel] applied: [PATCH backup 2/3] config: acl: docs: link to PRIVILEGES with namespace

[Fabian Grünbichler]

On December 3, 2024 10:32 am, Maximiliano Sandoval wrote:
> Otherwise:
> 
> ```
> warning: unresolved link to `PRIVILEGES`
>   --> pbs-config/src/acl.rs:15:71
>    |
> 15 | /// Map of pre-defined [Roles](Role) to their associated [privileges](PRIVILEGES) combination
>    |                                                                       ^^^^^^^^^^ no item named `PRIVILEGES` in scope
>    |
>    = help: to escape `[` and `]` characters, add '\' before them like `\[` or `\]`
>    = note: `#[warn(rustdoc::broken_intra_doc_links)]` on by default
> ```
> 
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
>  pbs-config/src/acl.rs | 4 ++--
>  1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/pbs-config/src/acl.rs b/pbs-config/src/acl.rs
> index d8138078..e8690560 100644
> --- a/pbs-config/src/acl.rs
> +++ b/pbs-config/src/acl.rs
> @@ -12,8 +12,8 @@ use pbs_api_types::{Authid, Role, Userid, ROLE_NAME_NO_ACCESS};
>  
>  use crate::{open_backup_lockfile, replace_backup_config, BackupLockGuard};
>  
> -/// Map of pre-defined [Roles](Role) to their associated [privileges](PRIVILEGES) combination
> -/// and description.
> +/// Map of pre-defined [Roles](Role) to their associated
> +/// [privileges](pbs_api_types::PRIVILEGES) combination and description.
>  pub static ROLE_NAMES: LazyLock<HashMap<&'static str, (u64, &'static str)>> = LazyLock::new(|| {
>      let mut map = HashMap::new();
>  
> -- 
> 2.39.5
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
> 


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

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

[Maximiliano Sandoval]

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@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



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

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

[Fabian Grünbichler]

On December 3, 2024 10:32 am, Maximiliano Sandoval wrote:
> 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
> ```

there were two more of those that I fixed in the same fashion..

> 
> Signed-off-by: Maximiliano Sandoval <m.sandoval@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
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
> 


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

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

[Maximiliano Sandoval]

Fabian Grünbichler <f.gruenbichler@proxmox.com> writes:

> On December 3, 2024 10:32 am, Maximiliano Sandoval wrote:
>> 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
>> ```
>
> there were two more of those that I fixed in the same fashion..

I sent another set of patches where I fixed two more. Did you push the
changes already? Or where they different ones?

--
Maximiliano


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

Re: [pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct

[Fabian Grünbichler]

On December 3, 2024 10:32 am, Maximiliano Sandoval wrote:
> Fixes:
> 
> ```
> warning: public documentation for `PxarExtractContext` links to private item `ExtractorIter`
>    --> pbs-client/src/pxar/extract.rs:404:27
>     |
> 404 | /// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
>     |                           ^^^^^^^^^^^^^ this item is private
>     |
>     = note: this link will resolve properly if you pass `--document-private-items`
>     = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
> ```

we have lots of private/internal stuff that is documented though, should
we maybe look for a way to set that flag always?

> 
> Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
> ---
>  pbs-client/src/pxar/extract.rs | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/pbs-client/src/pxar/extract.rs b/pbs-client/src/pxar/extract.rs
> index cfbd8d51..c31e1be8 100644
> --- a/pbs-client/src/pxar/extract.rs
> +++ b/pbs-client/src/pxar/extract.rs
> @@ -401,7 +401,7 @@ where
>  }
>  
>  /// Provides additional [context][C] for [`anyhow::Error`]s that are returned
> -/// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
> +/// while traversing an ExtractorIter. The [`PxarExtractContext`] can then
>  /// be accessed [via `anyhow`'s facilities][A] and may aid during error handling.
>  ///
>  ///
> -- 
> 2.39.5
> 
> 
> 
> _______________________________________________
> pbs-devel mailing list
> pbs-devel@lists.proxmox.com
> https://lists.proxmox.com/cgi-bin/mailman/listinfo/pbs-devel
> 
> 
> 


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

Re: [pbs-devel] [PATCH backup 1/3] client: pxar: docs: do not link to private ExtractorIter struct

[Maximiliano Sandoval]

Fabian Grünbichler <f.gruenbichler@proxmox.com> writes:

> On December 3, 2024 10:32 am, Maximiliano Sandoval wrote:
>> Fixes:
>>
>> ```
>> warning: public documentation for `PxarExtractContext` links to private item `ExtractorIter`
>>    --> pbs-client/src/pxar/extract.rs:404:27
>>     |
>> 404 | /// while traversing an [`ExtractorIter`]. The [`PxarExtractContext`] can then
>>     |                           ^^^^^^^^^^^^^ this item is private
>>     |
>>     = note: this link will resolve properly if you pass `--document-private-items`
>>     = note: `#[warn(rustdoc::private_intra_doc_links)]` on by default
>> ```
>
> we have lots of private/internal stuff that is documented though, should
> we maybe look for a way to set that flag always?

Makes sense to me to use that flag, at least for rustdoc.proxmox.com.

--
Maximiliano


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