[pbs-devel] [PATCH backup 2/5] fix typos in rust documentation blocks

Maximiliano Sandoval m.sandoval at proxmox.com
Wed Aug 7 12:32:19 CEST 2024


Signed-off-by: Maximiliano Sandoval <m.sandoval at proxmox.com>
---
 pbs-api-types/src/acl.rs                 | 2 +-
 pbs-client/src/pxar/create.rs            | 2 +-
 pbs-config/src/cached_user_info.rs       | 2 +-
 pbs-tools/src/lib.rs                     | 2 +-
 proxmox-backup-client/src/benchmark.rs   | 2 +-
 proxmox-file-restore/src/block_driver.rs | 2 +-
 src/api2/backup/environment.rs           | 2 +-
 src/api2/node/services.rs                | 2 +-
 src/api2/reader/environment.rs           | 2 +-
 src/tape/file_formats/mod.rs             | 2 +-
 10 files changed, 10 insertions(+), 10 deletions(-)

diff --git a/pbs-api-types/src/acl.rs b/pbs-api-types/src/acl.rs
index ef639862..e133247d 100644
--- a/pbs-api-types/src/acl.rs
+++ b/pbs-api-types/src/acl.rs
@@ -223,7 +223,7 @@ pub enum Role {
     RemoteAudit = ROLE_REMOTE_AUDIT,
     /// Remote Administrator
     RemoteAdmin = ROLE_REMOTE_ADMIN,
-    /// Syncronisation Opertator
+    /// Synchronization Opertator
     RemoteSyncOperator = ROLE_REMOTE_SYNC_OPERATOR,
     /// Tape Auditor
     TapeAudit = ROLE_TAPE_AUDIT,
diff --git a/pbs-client/src/pxar/create.rs b/pbs-client/src/pxar/create.rs
index 4dd3b656..c48524c4 100644
--- a/pbs-client/src/pxar/create.rs
+++ b/pbs-client/src/pxar/create.rs
@@ -62,7 +62,7 @@ pub struct PxarCreateOptions {
 
 pub type MetadataArchiveReader = Arc<dyn ReadAt + Send + Sync + 'static>;
 
-/// Statefull information of previous backups snapshots for partial backups
+/// Stateful information of previous backups snapshots for partial backups
 pub struct PxarPrevRef {
     /// Reference accessor for metadata comparison
     pub accessor: Accessor<MetadataArchiveReader>,
diff --git a/pbs-config/src/cached_user_info.rs b/pbs-config/src/cached_user_info.rs
index b9534b80..f8ecb6c1 100644
--- a/pbs-config/src/cached_user_info.rs
+++ b/pbs-config/src/cached_user_info.rs
@@ -179,7 +179,7 @@ impl CachedUserInfo {
         (privs, propagated_privs)
     }
 
-    /// Checks whether the `auth_id` has any of the privilegs `privs` on any object below `path`.
+    /// Checks whether the `auth_id` has any of the privileges `privs` on any object below `path`.
     pub fn any_privs_below(
         &self,
         auth_id: &Authid,
diff --git a/pbs-tools/src/lib.rs b/pbs-tools/src/lib.rs
index bee5c1c0..af900c92 100644
--- a/pbs-tools/src/lib.rs
+++ b/pbs-tools/src/lib.rs
@@ -10,7 +10,7 @@ pub mod async_lru_cache;
 
 /// Set MMAP_THRESHOLD to a fixed value (128 KiB)
 ///
-/// This avoids the "dynamic" mmap-treshold logic from glibc's malloc, which seems misguided and
+/// This avoids the "dynamic" mmap-threshold logic from glibc's malloc, which seems misguided and
 /// effectively avoids using mmap for all allocations smaller than 32 MiB. Which, in combination
 /// with the allocation pattern from our/tokio's complex async machinery, resulted in very large
 /// RSS sizes due to defragmentation and long-living (smaller) allocation on top of the heap
diff --git a/proxmox-backup-client/src/benchmark.rs b/proxmox-backup-client/src/benchmark.rs
index 2145d45e..a6f24d74 100644
--- a/proxmox-backup-client/src/benchmark.rs
+++ b/proxmox-backup-client/src/benchmark.rs
@@ -29,7 +29,7 @@ use crate::{
 #[derive(Copy, Clone, Serialize)]
 /// Speed test result
 struct Speed {
-    /// The meassured speed in Bytes/second
+    /// The measured speed in Bytes/second
     #[serde(skip_serializing_if = "Option::is_none")]
     speed: Option<f64>,
     /// Top result we want to compare with
diff --git a/proxmox-file-restore/src/block_driver.rs b/proxmox-file-restore/src/block_driver.rs
index fa954832..56b868b5 100644
--- a/proxmox-file-restore/src/block_driver.rs
+++ b/proxmox-file-restore/src/block_driver.rs
@@ -37,7 +37,7 @@ pub type Async<R> = Pin<Box<dyn Future<Output = R> + Send>>;
 
 /// An abstract implementation for retrieving data out of a block file backup
 pub trait BlockRestoreDriver {
-    /// List ArchiveEntrys for the given image file and path
+    /// List ArchiveEntries for the given image file and path
     fn data_list(
         &self,
         details: SnapRestoreDetails,
diff --git a/src/api2/backup/environment.rs b/src/api2/backup/environment.rs
index 51f4a15b..0a7c67b6 100644
--- a/src/api2/backup/environment.rs
+++ b/src/api2/backup/environment.rs
@@ -101,7 +101,7 @@ impl SharedBackupState {
     }
 }
 
-/// `RpcEnvironmet` implementation for backup service
+/// `RpcEnvironment` implementation for backup service
 #[derive(Clone)]
 pub struct BackupEnvironment {
     env_type: RpcEnvironmentType,
diff --git a/src/api2/node/services.rs b/src/api2/node/services.rs
index a8db0e27..2da9e1ad 100644
--- a/src/api2/node/services.rs
+++ b/src/api2/node/services.rs
@@ -306,7 +306,7 @@ fn stop_service(
         permission: &Permission::Privilege(&["system", "services", "{service}"], PRIV_SYS_MODIFY, false),
     },
 )]
-/// Retart service.
+/// Restart service.
 fn restart_service(
     service: String,
     _param: Value,
diff --git a/src/api2/reader/environment.rs b/src/api2/reader/environment.rs
index 37039da2..602c65e4 100644
--- a/src/api2/reader/environment.rs
+++ b/src/api2/reader/environment.rs
@@ -11,7 +11,7 @@ use pbs_datastore::DataStore;
 use proxmox_rest_server::formatter::*;
 use proxmox_rest_server::WorkerTask;
 
-/// `RpcEnvironmet` implementation for backup reader service
+/// `RpcEnvironment` implementation for backup reader service
 #[derive(Clone)]
 pub struct ReaderEnvironment {
     env_type: RpcEnvironmentType,
diff --git a/src/tape/file_formats/mod.rs b/src/tape/file_formats/mod.rs
index 0f983059..b1d8c455 100644
--- a/src/tape/file_formats/mod.rs
+++ b/src/tape/file_formats/mod.rs
@@ -150,7 +150,7 @@ pub struct MediaSetLabel {
     pub seq_nr: u64,
     /// Creation time stamp
     pub ctime: i64,
-    /// Encryption key finkerprint (if encryped)
+    /// Encryption key finkerprint (if encrypted)
     #[serde(skip_serializing_if = "Option::is_none")]
     pub encryption_key_fingerprint: Option<Fingerprint>,
 }
-- 
2.39.2





More information about the pbs-devel mailing list