all lists on lists.proxmox.com
 help / color / mirror / Atom feed
From: Maximiliano Sandoval <m.sandoval@proxmox.com>
To: pbs-devel@lists.proxmox.com
Subject: [pbs-devel] [PATCH proxmox 1/4] fix typos in rust api documentation
Date: Thu, 18 Jul 2024 15:05:31 +0200	[thread overview]
Message-ID: <20240718130534.370768-1-m.sandoval@proxmox.com> (raw)

Signed-off-by: Maximiliano Sandoval <m.sandoval@proxmox.com>
---
 proxmox-access-control/src/cached_user_info.rs | 2 +-
 proxmox-acme/src/account.rs                    | 4 ++--
 proxmox-acme/src/authorization.rs              | 2 +-
 proxmox-acme/src/error.rs                      | 2 +-
 proxmox-acme/src/types.rs                      | 2 +-
 proxmox-api-macro/src/api/mod.rs               | 2 +-
 proxmox-api-macro/src/util.rs                  | 2 +-
 proxmox-apt-api-types/src/lib.rs               | 4 ++--
 proxmox-apt/src/deb822/release_file.rs         | 2 +-
 proxmox-auth-api/src/auth_key.rs               | 2 +-
 proxmox-client/src/lib.rs                      | 6 +++---
 proxmox-http/src/client/tls.rs                 | 2 +-
 proxmox-http/src/websocket/mod.rs              | 2 +-
 proxmox-io/src/read.rs                         | 8 ++++----
 proxmox-io/src/write.rs                        | 4 ++--
 proxmox-ldap/src/lib.rs                        | 4 ++--
 proxmox-login/src/ticket.rs                    | 4 ++--
 proxmox-router/src/cli/command.rs              | 4 ++--
 proxmox-router/src/cli/environment.rs          | 2 +-
 proxmox-router/src/cli/text_table.rs           | 6 +++---
 proxmox-router/src/format.rs                   | 4 ++--
 proxmox-schema/src/format.rs                   | 6 +++---
 proxmox-schema/src/schema.rs                   | 4 ++--
 proxmox-section-config/src/lib.rs              | 2 +-
 proxmox-sys/src/crypt.rs                       | 4 ++--
 proxmox-sys/src/linux/pid.rs                   | 2 +-
 proxmox-sys/src/linux/procfs/mod.rs            | 2 +-
 proxmox-sys/src/linux/timer.rs                 | 2 +-
 proxmox-time/src/posix.rs                      | 2 +-
 proxmox-uuid/src/lib.rs                        | 2 +-
 30 files changed, 48 insertions(+), 48 deletions(-)

diff --git a/proxmox-access-control/src/cached_user_info.rs b/proxmox-access-control/src/cached_user_info.rs
index 00f22a6b..4d011f00 100644
--- a/proxmox-access-control/src/cached_user_info.rs
+++ b/proxmox-access-control/src/cached_user_info.rs
@@ -180,7 +180,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/proxmox-acme/src/account.rs b/proxmox-acme/src/account.rs
index 112a2ad9..0f023224 100644
--- a/proxmox-acme/src/account.rs
+++ b/proxmox-acme/src/account.rs
@@ -284,7 +284,7 @@ impl CertificateRevocation<'_> {
 /// creation request can be created via the [`request`](AccountCreator::request()) method, giving
 /// it a nonce and a directory.  This can be repeated, if necessary, like when the nonce fails.
 ///
-/// When the server sends a succesful response, it should be passed to the
+/// When the server sends a successful response, it should be passed to the
 /// [`response`](AccountCreator::response()) method to finish the creation of an [`Account`] which
 /// can then be persisted.
 #[derive(Default)]
@@ -297,7 +297,7 @@ pub struct AccountCreator {
 }
 
 impl AccountCreator {
-    /// Replace the contact infor with the provided ACME compatible data.
+    /// Replace the contact info with the provided ACME compatible data.
     pub fn set_contacts(mut self, contact: Vec<String>) -> Self {
         self.contact = contact;
         self
diff --git a/proxmox-acme/src/authorization.rs b/proxmox-acme/src/authorization.rs
index fee3614d..28bc1b4b 100644
--- a/proxmox-acme/src/authorization.rs
+++ b/proxmox-acme/src/authorization.rs
@@ -76,7 +76,7 @@ pub enum ChallengeStatus {
     /// The challenge is pending and has not been validated yet.
     Pending,
 
-    /// The valiation is in progress.
+    /// The validation is in progress.
     Processing,
 
     /// The challenge was successfully validated.
diff --git a/proxmox-acme/src/error.rs b/proxmox-acme/src/error.rs
index 59da3ea1..4253f8e2 100644
--- a/proxmox-acme/src/error.rs
+++ b/proxmox-acme/src/error.rs
@@ -22,7 +22,7 @@ pub enum Error {
     /// the user has to agree to the new terms.
     UserActionRequired(String),
 
-    /// Other error repsonses from the Acme API not handled specially.
+    /// Other error responses from the Acme API not handled specially.
     Api(crate::request::ErrorResponse),
 
     /// The Acme API behaved unexpectedly.
diff --git a/proxmox-acme/src/types.rs b/proxmox-acme/src/types.rs
index 9a1650ff..e5a6b34d 100644
--- a/proxmox-acme/src/types.rs
+++ b/proxmox-acme/src/types.rs
@@ -95,7 +95,7 @@ pub struct AccountData {
     #[serde(skip_serializing_if = "Option::is_none")]
     pub orders: Option<String>,
 
-    /// The acccount's contact info.
+    /// The account's contact info.
     ///
     /// This usually contains a `"mailto:<email address>"` entry but may also contain some other
     /// data if the server accepts it.
diff --git a/proxmox-api-macro/src/api/mod.rs b/proxmox-api-macro/src/api/mod.rs
index 01bd5e20..abd1b036 100644
--- a/proxmox-api-macro/src/api/mod.rs
+++ b/proxmox-api-macro/src/api/mod.rs
@@ -526,7 +526,7 @@ impl SchemaObject {
         }
     }
 
-    /// Check whether ther are any kind of fields defined in the struct, regardless of whether
+    /// Check whether there are any kind of fields defined in the struct, regardless of whether
     /// they're flattened or not.
     #[inline]
     pub fn is_empty(&self) -> bool {
diff --git a/proxmox-api-macro/src/util.rs b/proxmox-api-macro/src/util.rs
index 5f486e4b..adacd225 100644
--- a/proxmox-api-macro/src/util.rs
+++ b/proxmox-api-macro/src/util.rs
@@ -137,7 +137,7 @@ impl Parse for FieldName {
 }
 
 /// Most of our schema definition consists of a json-like notation.
-/// For parsing we mostly just need to destinguish between objects and non-objects.
+/// For parsing we mostly just need to distinguish between objects and non-objects.
 /// For specific expression types we match on the contained expression later on.
 // FIXME: Expr(Box<syn::Expr>)
 #[allow(clippy::large_enum_variant)]
diff --git a/proxmox-apt-api-types/src/lib.rs b/proxmox-apt-api-types/src/lib.rs
index 6025722f..ce6f5d78 100644
--- a/proxmox-apt-api-types/src/lib.rs
+++ b/proxmox-apt-api-types/src/lib.rs
@@ -50,7 +50,7 @@ serde_plain::derive_fromstr_from_deserialize!(APTRepositoryPackageType);
 #[derive(Debug, Clone, Serialize, Deserialize, PartialEq)]
 #[serde(rename_all = "PascalCase")] // for consistency
 /// Additional options for an APT repository.
-/// Used for both single- and mutli-value options.
+/// Used for both single- and multi-value options.
 pub struct APTRepositoryOption {
     /// Option key.
     pub key: String,
@@ -223,7 +223,7 @@ pub struct APTRepositoryInfo {
     #[serde(default, skip_serializing_if = "String::is_empty")]
     pub path: String,
 
-    /// Index of the associated respository within the file (starting from 0).
+    /// Index of the associated repository within the file (starting from 0).
     pub index: usize,
 
     /// The property from which the info originates (e.g. "Suites")
diff --git a/proxmox-apt/src/deb822/release_file.rs b/proxmox-apt/src/deb822/release_file.rs
index 3973dad0..dbf1a367 100644
--- a/proxmox-apt/src/deb822/release_file.rs
+++ b/proxmox-apt/src/deb822/release_file.rs
@@ -46,7 +46,7 @@ pub type Architecture = String;
 pub type Component = String;
 
 #[derive(Clone, Debug, PartialEq, Eq, PartialOrd, Ord)]
-/// Type of file reference extraced from path.
+/// Type of file reference extracted from path.
 ///
 /// `Packages` and `Sources` will contain further reference to binary or source package files.
 ///  These are handled in `PackagesFile` and `SourcesFile` respectively.
diff --git a/proxmox-auth-api/src/auth_key.rs b/proxmox-auth-api/src/auth_key.rs
index 3ea4bbd3..9873d935 100644
--- a/proxmox-auth-api/src/auth_key.rs
+++ b/proxmox-auth-api/src/auth_key.rs
@@ -229,7 +229,7 @@ enum VerificationKey {
 
 /// A key ring for authentication.
 ///
-/// This can hold one active signing key for new tickets (either an HMAC secret or an assymmetric
+/// This can hold one active signing key for new tickets (either an HMAC secret or an asymmetric
 /// key), and optionally multiple public keys and HMAC secrets for verifying them in order to
 /// support key rollover.
 pub struct Keyring {
diff --git a/proxmox-client/src/lib.rs b/proxmox-client/src/lib.rs
index eab6cf23..dd57290a 100644
--- a/proxmox-client/src/lib.rs
+++ b/proxmox-client/src/lib.rs
@@ -36,7 +36,7 @@ pub trait HttpApiClient {
 
     /// `POST` request with a path and query component (no hostname), and a serializable body.
     ///
-    /// The body should be serialized to json and sent with `Content-type: applicaion/json`.
+    /// The body should be serialized to json and sent with `Content-type: application/json`.
     ///
     /// For this request, authentication headers should be set!
     fn post<'a, T>(&'a self, path_and_query: &'a str, params: &T) -> Self::ResponseFuture<'a>
@@ -50,7 +50,7 @@ pub trait HttpApiClient {
 
     /// `PUT` request with a path and query component (no hostname), and a serializable body.
     ///
-    /// The body should be serialized to json and sent with `Content-type: applicaion/json`.
+    /// The body should be serialized to json and sent with `Content-type: application/json`.
     ///
     /// For this request, authentication headers should be set!
     fn put<'a, T>(&'a self, path_and_query: &'a str, params: &T) -> Self::ResponseFuture<'a>
@@ -76,7 +76,7 @@ pub struct HttpApiResponse {
 }
 
 impl HttpApiResponse {
-    /// Expect a JSON response as returend by the `extjs` formatter.
+    /// Expect a JSON response as returned by the `extjs` formatter.
     pub fn expect_json<T>(self) -> Result<ApiResponseData<T>, Error>
     where
         T: for<'de> Deserialize<'de>,
diff --git a/proxmox-http/src/client/tls.rs b/proxmox-http/src/client/tls.rs
index f785108a..81aff783 100644
--- a/proxmox-http/src/client/tls.rs
+++ b/proxmox-http/src/client/tls.rs
@@ -10,7 +10,7 @@ use tokio_openssl::SslStream;
 
 /// Asynchronous stream, possibly encrypted and proxied
 ///
-/// Usefule for HTTP client implementations using hyper.
+/// Useful for HTTP client implementations using hyper.
 pub enum MaybeTlsStream<S> {
     Normal(S),
     Proxied(S),
diff --git a/proxmox-http/src/websocket/mod.rs b/proxmox-http/src/websocket/mod.rs
index 6d3faea6..a39ff03a 100644
--- a/proxmox-http/src/websocket/mod.rs
+++ b/proxmox-http/src/websocket/mod.rs
@@ -228,7 +228,7 @@ pub fn create_frame(
 ///
 /// Send websocket frames to anything accepting AsyncWrite.
 ///
-/// Note: Every write to it gets encoded as a seperate websocket frame, without any fragmentation
+/// Note: Every write to it gets encoded as a separate websocket frame, without any fragmentation
 /// being enforced.
 ///
 /// Example usage:
diff --git a/proxmox-io/src/read.rs b/proxmox-io/src/read.rs
index 4ad8a65d..67a608dc 100644
--- a/proxmox-io/src/read.rs
+++ b/proxmox-io/src/read.rs
@@ -10,7 +10,7 @@ use crate::vec::{self, ByteVecExt};
 /// Adds some additional related functionality for types implementing [`Read`](std::io::Read).
 ///
 /// Particularly for reading into a newly allocated buffer, appending to a `Vec<u8>` or reading
-/// values of a specific endianess (types implementing [`Endian`]).
+/// values of a specific endianness (types implementing [`Endian`]).
 ///
 /// Examples:
 /// ```no_run
@@ -29,7 +29,7 @@ use crate::vec::{self, ByteVecExt};
 /// # }
 /// ```
 ///
-/// Or for reading values of a defined representation and endianess:
+/// Or for reading values of a defined representation and endianness:
 ///
 /// ```no_run
 /// # use endian_trait::Endian;
@@ -77,7 +77,7 @@ pub trait ReadExt {
     /// Append an exact amount of data to a vector, growing it as necessary.
     fn append_exact_to_vec(&mut self, out: &mut Vec<u8>, size: usize) -> io::Result<()>;
 
-    /// Read a value with host endianess.
+    /// Read a value with host endianness.
     ///
     /// This is limited to types implementing the [`Endian`] trait under the assumption that
     /// this is only done for types which are supposed to be read/writable directly.
@@ -187,7 +187,7 @@ pub trait ReadExt {
     /// [`Endian`]: https://docs.rs/endian_trait/0.6/endian_trait/trait.Endian.html
     unsafe fn read_be_value<T: Endian>(&mut self) -> io::Result<T>;
 
-    /// Read a boxed value with host endianess.
+    /// Read a boxed value with host endianness.
     ///
     /// This is currently not limited to types implementing the [`Endian`] trait as in our use
     /// cases we use this for types which are too big to want to always perform endian swaps
diff --git a/proxmox-io/src/write.rs b/proxmox-io/src/write.rs
index f519c057..d0d2eca1 100644
--- a/proxmox-io/src/write.rs
+++ b/proxmox-io/src/write.rs
@@ -6,7 +6,7 @@ use endian_trait::Endian;
 
 /// Adds some additional related functionality for types implementing [`Write`](std::io::Write).
 ///
-/// Particularly for writing values of a specific endianess (types implementing [`Endian`]).
+/// Particularly for writing values of a specific endianness (types implementing [`Endian`]).
 ///
 /// Examples:
 /// ```no_run
@@ -35,7 +35,7 @@ use endian_trait::Endian;
 ///
 /// [`Endian`]: https://docs.rs/endian_trait/0.6/endian_trait/trait.Endian.html
 pub trait WriteExt {
-    /// Write a value with host endianess.
+    /// Write a value with host endianness.
     ///
     /// This is limited to types implementing the [`Endian`] trait under the assumption that this
     /// is only done for types which are supposed to be read/writable directly.
diff --git a/proxmox-ldap/src/lib.rs b/proxmox-ldap/src/lib.rs
index ce37c778..014bdcc1 100644
--- a/proxmox-ldap/src/lib.rs
+++ b/proxmox-ldap/src/lib.rs
@@ -58,7 +58,7 @@ pub struct Config {
 pub struct SearchParameters {
     /// Attributes that should be retrieved
     pub attributes: Vec<String>,
-    /// `objectclass`es of intereset
+    /// `objectclass`es of interest
     pub user_classes: Vec<String>,
     /// Custom user filter
     pub user_filter: Option<String>,
@@ -217,7 +217,7 @@ impl Connection {
             .ok_or_else(|| format_err!("failed to retrieve root DSE attribute '{attr}'"))
     }
 
-    /// Retrive port from LDAP configuration, otherwise use the correct default
+    /// Retrieve port from LDAP configuration, otherwise use the correct default
     fn port_from_config(&self) -> u16 {
         self.config.port.unwrap_or_else(|| {
             if self.config.tls_mode == ConnectionMode::Ldaps {
diff --git a/proxmox-login/src/ticket.rs b/proxmox-login/src/ticket.rs
index 9543b70e..40decf99 100644
--- a/proxmox-login/src/ticket.rs
+++ b/proxmox-login/src/ticket.rs
@@ -7,7 +7,7 @@ use serde::{Deserialize, Serialize};
 use crate::error::TicketError;
 use crate::tfa::TfaChallenge;
 
-/// The repsonse to a ticket call can either be a complete ticket, or a TFA challenge.
+/// The response to a ticket call can either be a complete ticket, or a TFA challenge.
 #[derive(Clone, Debug, Serialize, Deserialize)]
 pub(crate) enum TicketResponse {
     Full(Ticket),
@@ -62,7 +62,7 @@ impl Ticket {
         &self.data[start..(start + len)]
     }
 
-    /// Thet ticket's timestamp as a UNIX epoch.
+    /// The ticket's timestamp as a UNIX epoch.
     pub fn timestamp(&self) -> i64 {
         self.timestamp
     }
diff --git a/proxmox-router/src/cli/command.rs b/proxmox-router/src/cli/command.rs
index b658e055..2b6c39ed 100644
--- a/proxmox-router/src/cli/command.rs
+++ b/proxmox-router/src/cli/command.rs
@@ -393,7 +393,7 @@ pub async fn run_async_cli_command<C: Into<CommandLineInterface>>(def: C, rpcenv
 
 /// Helper to get arguments and invoke the command.
 ///
-/// This is the synchrounous version of run_async_cli_command. You can
+/// This is the synchronous version of run_async_cli_command. You can
 /// pass an optional ``run`` function to execute async commands (else
 /// async commands simply fail).
 pub fn run_cli_command<C: Into<CommandLineInterface>>(
@@ -437,7 +437,7 @@ where
 
 /// Helper to get arguments and invoke the command.
 ///
-/// This is the synchrounous version of run_async_cli_command. You can
+/// This is the synchronous version of run_async_cli_command. You can
 /// pass an optional ``run`` function to execute async commands (else
 /// async commands simply fail).
 pub fn run_cli_command_with_args<A, C>(
diff --git a/proxmox-router/src/cli/environment.rs b/proxmox-router/src/cli/environment.rs
index 860a4ea2..3d3dec19 100644
--- a/proxmox-router/src/cli/environment.rs
+++ b/proxmox-router/src/cli/environment.rs
@@ -7,7 +7,7 @@ use proxmox_schema::ApiType;
 
 use crate::{RpcEnvironment, RpcEnvironmentType};
 
-/// `RpcEnvironmet` implementation for command line tools
+/// `RpcEnvironment` implementation for command line tools
 #[derive(Default)]
 pub struct CliEnvironment {
     result_attributes: Value,
diff --git a/proxmox-router/src/cli/text_table.rs b/proxmox-router/src/cli/text_table.rs
index 1b47ccc2..34173b4d 100644
--- a/proxmox-router/src/cli/text_table.rs
+++ b/proxmox-router/src/cli/text_table.rs
@@ -6,11 +6,11 @@ use unicode_width::UnicodeWidthStr;
 
 use proxmox_schema::{ObjectSchemaType, OneOfSchema, Schema, SchemaPropertyEntry};
 
-/// allows to configure the default output fromat using environment vars
+/// allows to configure the default output format using environment vars
 pub const ENV_VAR_PROXMOX_OUTPUT_FORMAT: &str = "PROXMOX_OUTPUT_FORMAT";
-/// if set, supress borders (and headers) when printing tables
+/// if set, suppress borders (and headers) when printing tables
 pub const ENV_VAR_PROXMOX_OUTPUT_NO_BORDER: &str = "PROXMOX_OUTPUT_NO_BORDER";
-/// if set, supress headers when printing tables
+/// if set, suppress headers when printing tables
 pub const ENV_VAR_PROXMOX_OUTPUT_NO_HEADER: &str = "PROXMOX_OUTPUT_NO_HEADER";
 
 /// Helper to get output format from parameters or environment
diff --git a/proxmox-router/src/format.rs b/proxmox-router/src/format.rs
index a265a2c8..67568af0 100644
--- a/proxmox-router/src/format.rs
+++ b/proxmox-router/src/format.rs
@@ -1,4 +1,4 @@
-//! Module to generate and format API Documenation
+//! Module to generate and format API Documentation
 
 use std::io::Write;
 
@@ -41,7 +41,7 @@ fn dump_method_definition(method: &str, path: &str, def: Option<&ApiMethod>) ->
     }
 }
 
-/// Generate ReST Documentaion for a complete API defined by a ``Router``.
+/// Generate ReST Documentation for a complete API defined by a ``Router``.
 pub fn dump_api(
     output: &mut dyn Write,
     router: &crate::Router,
diff --git a/proxmox-schema/src/format.rs b/proxmox-schema/src/format.rs
index fd9df988..4a8b559a 100644
--- a/proxmox-schema/src/format.rs
+++ b/proxmox-schema/src/format.rs
@@ -1,4 +1,4 @@
-//! Module to generate and format API Documenation
+//! Module to generate and format API Documentation
 
 use anyhow::{bail, Error};
 
@@ -134,7 +134,7 @@ fn get_simple_type_text(schema: &Schema, list_enums: bool) -> String {
     }
 }
 
-/// Generate ReST Documentaion for object properties
+/// Generate ReST Documentation for object properties
 pub fn dump_properties(
     param: &dyn ObjectSchemaType,
     indent: &str,
@@ -424,7 +424,7 @@ fn get_object_type_text(object_schema: &ObjectSchema) -> String {
     type_text
 }
 
-/// Generate ReST Documentaion for enumeration.
+/// Generate ReST Documentation for enumeration.
 pub fn dump_enum_properties(schema: &Schema) -> Result<String, Error> {
     let mut res = String::new();
 
diff --git a/proxmox-schema/src/schema.rs b/proxmox-schema/src/schema.rs
index b71720bb..eec6d81a 100644
--- a/proxmox-schema/src/schema.rs
+++ b/proxmox-schema/src/schema.rs
@@ -1,6 +1,6 @@
 //! Data types to decscribe data types.
 //!
-//! This is loosly based on JSON Schema, but uses static rust data types. This way we can build
+//! This is loosely based on JSON Schema, but uses static rust data types. This way we can build
 //! completely static API definitions that can be included within the programs read-only text
 //! segment.
 
@@ -1403,7 +1403,7 @@ impl EnumEntry {
 /// Use a schema to describe complex types encoded as string.
 ///
 /// Arrays are parsed as comma separated lists, i.e: `"1,2,3"`. The
-/// list may be sparated by comma, semicolon or whitespace.
+/// list may be separated by comma, semicolon or whitespace.
 ///
 /// Objects are parsed as comma (or semicolon) separated `key=value` pairs, i.e:
 /// `"prop1=2,prop2=test"`. Any whitespace is trimmed from key and value.
diff --git a/proxmox-section-config/src/lib.rs b/proxmox-section-config/src/lib.rs
index cfa79ad4..3d383880 100644
--- a/proxmox-section-config/src/lib.rs
+++ b/proxmox-section-config/src/lib.rs
@@ -1221,7 +1221,7 @@ sync: fail
     assert!(config.parse(filename, raw).is_err());
 }
 
-/// Generate ReST Documentaion for ``SectionConfig``
+/// Generate ReST Documentation for ``SectionConfig``
 pub fn dump_section_config(config: &SectionConfig) -> String {
     let mut res = String::new();
 
diff --git a/proxmox-sys/src/crypt.rs b/proxmox-sys/src/crypt.rs
index 3313f668..8bc0d7e3 100644
--- a/proxmox-sys/src/crypt.rs
+++ b/proxmox-sys/src/crypt.rs
@@ -35,7 +35,7 @@ struct crypt_data {
     internal: [libc::c_char; CRYPT_DATA_INTERNAL_SIZE],
 }
 
-/// Encrypt a pasword - see man crypt(3)
+/// Encrypt a password - see man crypt(3)
 pub fn crypt(password: &[u8], salt: &[u8]) -> Result<String, Error> {
     #[link(name = "crypt")]
     extern "C" {
@@ -142,7 +142,7 @@ pub fn crypt_gensalt(prefix: &str, count: u64, rbytes: &[u8]) -> Result<String,
     Ok(res.to_str()?.to_string())
 }
 
-/// Encrypt a pasword using sha256 hashing method
+/// Encrypt a password using sha256 hashing method
 pub fn encrypt_pw(password: &str) -> Result<String, Error> {
     // 8*32 = 256 bits security (128+ recommended, see `man crypt(5)`)
     let salt = crate::linux::random_data(32)?;
diff --git a/proxmox-sys/src/linux/pid.rs b/proxmox-sys/src/linux/pid.rs
index 488b3f8d..4407c82f 100644
--- a/proxmox-sys/src/linux/pid.rs
+++ b/proxmox-sys/src/linux/pid.rs
@@ -38,7 +38,7 @@ unsafe fn pidfd_send_signal(
     libc::syscall(SYS_pidfd_send_signal, pidfd, sig, info, flags)
 }
 
-/// File descriptor refernce to a process.
+/// File descriptor reference to a process.
 pub struct PidFd {
     fd: OwnedFd,
     pid: Pid,
diff --git a/proxmox-sys/src/linux/procfs/mod.rs b/proxmox-sys/src/linux/procfs/mod.rs
index 06ad6206..6c436c74 100644
--- a/proxmox-sys/src/linux/procfs/mod.rs
+++ b/proxmox-sys/src/linux/procfs/mod.rs
@@ -753,7 +753,7 @@ pub fn read_loadavg() -> Result<Loadavg, Error> {
     Loadavg::read()
 }
 
-/// Load avarage: floating point values for 1, 5 and 15 minutes of runtime.
+/// Load average: floating point values for 1, 5 and 15 minutes of runtime.
 #[derive(Clone, Debug)]
 pub struct Loadavg(pub f64, pub f64, pub f64);
 
diff --git a/proxmox-sys/src/linux/timer.rs b/proxmox-sys/src/linux/timer.rs
index d18118ac..1317caaf 100644
--- a/proxmox-sys/src/linux/timer.rs
+++ b/proxmox-sys/src/linux/timer.rs
@@ -314,7 +314,7 @@ impl TimeoutBlockGuard {
 }
 
 /// Unblock the timeout signal for the current thread. By default we block the
-/// signal this behavior should be restored when done using timeouts, therefor this
+/// signal this behavior should be restored when done using timeouts, therefore this
 /// returns a guard:
 #[inline(always)]
 pub fn unblock_timeout_signal() -> TimeoutBlockGuard {
diff --git a/proxmox-time/src/posix.rs b/proxmox-time/src/posix.rs
index 73a5368b..7db69928 100644
--- a/proxmox-time/src/posix.rs
+++ b/proxmox-time/src/posix.rs
@@ -94,7 +94,7 @@ pub fn epoch_i64() -> i64 {
 
 /// Returns Unix Epoch (now) as f64 with subseconds resolution
 ///
-/// Note: This can be inacurrate for values greater the 2^53. But this
+/// Note: This can be inaccurate for values greater the 2^53. But this
 /// should never happen.
 pub fn epoch_f64() -> f64 {
     use std::time::{SystemTime, UNIX_EPOCH};
diff --git a/proxmox-uuid/src/lib.rs b/proxmox-uuid/src/lib.rs
index 4b424c2d..b8fd733b 100644
--- a/proxmox-uuid/src/lib.rs
+++ b/proxmox-uuid/src/lib.rs
@@ -44,7 +44,7 @@ fn hex_digit(b: u8) -> Result<u8, UuidError> {
 ///
 /// let uuid = Uuid::generate();
 /// println!("Generated uuid: {}", uuid);
-/// // prints somethign like:
+/// // prints something like:
 /// //    Generated uuid: 65b85639-78d7-4330-85c6-39502b2f9b01
 ///
 /// let bytes: &[u8] = uuid.as_ref();
-- 
2.39.2



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


             reply	other threads:[~2024-07-18 13:05 UTC|newest]

Thread overview: 5+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-07-18 13:05 Maximiliano Sandoval [this message]
2024-07-18 13:05 ` [pbs-devel] [PATCH proxmox 2/4] fix typos in code documentation Maximiliano Sandoval
2024-07-18 13:05 ` [pbs-devel] [PATCH proxmox 3/4] fix typos in variable and function names Maximiliano Sandoval
2024-07-18 13:05 ` [pbs-devel] [PATCH proxmox 4/4] fix typos in strings Maximiliano Sandoval
2024-07-22  6:50 ` [pbs-devel] applied-series: [PATCH proxmox 1/4] fix typos in rust api documentation Thomas Lamprecht

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240718130534.370768-1-m.sandoval@proxmox.com \
    --to=m.sandoval@proxmox.com \
    --cc=pbs-devel@lists.proxmox.com \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.
Service provided by Proxmox Server Solutions GmbH | Privacy | Legal