[pbs-devel] [PATCH backup 1/4] datastore: docs: turn uri into hyperlink

[Maximiliano Sandoval <m.sandoval@proxmox.com>]

Fixes the cargo doc lint:

```
warning: this URL is not a hyperlink
   --> pbs-datastore/src/data_blob.rs:555:5
    |
555 | /// https://github.com/facebook/zstd/blob/dev/lib/common/error_private.h
    |     ^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
    |
    = note: bare URLs are not automatically turned into clickable links
    = note: `#[warn(rustdoc::bare_urls)]` on by default
help: use an automatic link instead
    |
555 | /// <https://github.com/facebook/zstd/blob/dev/lib/common/error_private.h>
    |     +                                                                    +
```

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
Found more warnings when running

    cargo doc --workspace --all


 pbs-datastore/src/data_blob.rs | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/pbs-datastore/src/data_blob.rs b/pbs-datastore/src/data_blob.rs
index 0fb4d44c..0c05c5a4 100644
--- a/pbs-datastore/src/data_blob.rs
+++ b/pbs-datastore/src/data_blob.rs
@@ -552,7 +552,7 @@ impl<'a, 'b> DataChunkBuilder<'a, 'b> {
 /// Check if the error code returned by `zstd_safe::compress`, or anything else that does FFI calls
 /// into zstd code, was `70` 'Destination buffer is too small' by subtracting the error code from
 /// `0` (with underflow), see `ERR_getErrorCode` in
-/// https://github.com/facebook/zstd/blob/dev/lib/common/error_private.h
+/// <https://github.com/facebook/zstd/blob/dev/lib/common/error_private.h>
 ///
 /// There is a test below to ensure we catch any change in the interface or internal value.
 fn zstd_error_is_target_too_small(err: usize) -> bool {
-- 
2.39.5



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