From 8b0205b934ced1114dc7ff6fd7d8d1dbdff8dfc1 Mon Sep 17 00:00:00 2001 From: weriomat Date: Sun, 12 Jul 2026 16:33:00 +0200 Subject: [PATCH 1/3] feat: correct spelling in comments --- ipmi-rs-core/src/app/get_device_id.rs | 2 +- ipmi-rs-core/src/connection/mod.rs | 6 +++--- ipmi-rs/src/rmcp/v1_5/mod.rs | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/ipmi-rs-core/src/app/get_device_id.rs b/ipmi-rs-core/src/app/get_device_id.rs index 5db4407..fc99aac 100644 --- a/ipmi-rs-core/src/app/get_device_id.rs +++ b/ipmi-rs-core/src/app/get_device_id.rs @@ -29,7 +29,7 @@ pub struct DeviceId { pub device_revision: u8, /// `true` if the device provides device SDRs. pub provides_device_sdrs: bool, - /// `true` if the device is availalbe, `false` if the device + /// `true` if the device is available, `false` if the device /// is in device firmware, SDR repository update, or self-initialization state. pub device_available: bool, /// The major version of the firmware revision of the device. diff --git a/ipmi-rs-core/src/connection/mod.rs b/ipmi-rs-core/src/connection/mod.rs index d20205d..5c2fec0 100644 --- a/ipmi-rs-core/src/connection/mod.rs +++ b/ipmi-rs-core/src/connection/mod.rs @@ -175,11 +175,11 @@ pub trait IpmiConnection { /// Receive a response from the remote end of this connection. fn recv(&mut self) -> Result; - /// Send `request` to and reveive a response from the remote end of this connection. + /// Send `request` to and receive a response from the remote end of this connection. fn send_recv(&mut self, request: &mut Request) -> Result; } -/// The wire representation of an IPMI messag.e +/// The wire representation of an IPMI message. #[derive(Clone, Debug, PartialEq)] pub struct Message { netfn: u8, @@ -266,7 +266,7 @@ pub trait IpmiCommand: Into { /// provided `data`, assuming a successful completion code. fn parse_success_response(data: &[u8]) -> Result; - /// Get the intended target [`Address`] and [`Channel`] for this commmand. + /// Get the intended target [`Address`] and [`Channel`] for this command. fn target(&self) -> Option<(Address, Channel)> { None } diff --git a/ipmi-rs/src/rmcp/v1_5/mod.rs b/ipmi-rs/src/rmcp/v1_5/mod.rs index 9c9d53a..09bf459 100644 --- a/ipmi-rs/src/rmcp/v1_5/mod.rs +++ b/ipmi-rs/src/rmcp/v1_5/mod.rs @@ -153,7 +153,7 @@ impl State { Err(e) => return Err(ActivationError::ActivateSession(e)), }; - log::debug!("Succesfully started a session ({:?})", activation_info); + log::debug!("Successfully started a session ({:?})", activation_info); self = ipmi.release(); @@ -179,7 +179,7 @@ impl IpmiConnection for State { let request_sequence = &mut self.session_sequence; // Only increment the request sequence once a session has been established - // succesfully. + // successfully. if self.session_id.is_some() { *request_sequence = request_sequence.wrapping_add(1); } From 47db5227b286749b2a1b6e6536a87dbbc5d83057 Mon Sep 17 00:00:00 2001 From: weriomat Date: Sun, 12 Jul 2026 16:34:07 +0200 Subject: [PATCH 2/3] feat!: correct spelling in source code --- ipmi-rs-core/src/app/auth/activate_session.rs | 4 ++-- ipmi-rs-core/src/storage/sdr/units.rs | 10 +++++----- ipmi-rs/src/rmcp/v1_5/mod.rs | 2 +- ipmi-rs/src/rmcp/v2_0/messages/rakp_3.rs | 4 ++-- ipmi-rs/src/rmcp/v2_0/mod.rs | 2 +- 5 files changed, 11 insertions(+), 11 deletions(-) diff --git a/ipmi-rs-core/src/app/auth/activate_session.rs b/ipmi-rs-core/src/app/auth/activate_session.rs index bd58c2f..33fa70a 100644 --- a/ipmi-rs-core/src/app/auth/activate_session.rs +++ b/ipmi-rs-core/src/app/auth/activate_session.rs @@ -7,7 +7,7 @@ use super::{AuthError, AuthType, PrivilegeLevel}; #[derive(Debug, Clone)] pub struct ActivateSession { pub auth_type: AuthType, - pub maxiumum_privilege_level: PrivilegeLevel, + pub maximum_privilege_level: PrivilegeLevel, pub challenge_string: [u8; 16], pub initial_sequence_number: u32, } @@ -25,7 +25,7 @@ impl From for Message { let mut data = vec![0u8; 22]; data[0] = value.auth_type.into(); - data[1] = value.maxiumum_privilege_level.into(); + data[1] = value.maximum_privilege_level.into(); data[2..18].copy_from_slice(&value.challenge_string); data[18..22].copy_from_slice(&value.initial_sequence_number.to_le_bytes()); diff --git a/ipmi-rs-core/src/storage/sdr/units.rs b/ipmi-rs-core/src/storage/sdr/units.rs index 7384eed..3fcd466 100644 --- a/ipmi-rs-core/src/storage/sdr/units.rs +++ b/ipmi-rs-core/src/storage/sdr/units.rs @@ -124,7 +124,7 @@ macro_rules ! unit { unit! { Unspecified = [0, None, "Unspecified", "Unspecified"], - DegreesCelcius = [1, Some("°C"), "Degree Celcius", "Degrees Celcius"], + DegreesCelsius = [1, Some("°C"), "Degree Celsius", "Degrees Celsius"], DegreesFahrenheit = [2, Some("°F"), "Degree Fahrenheit", "Degrees Fahrenheit"], DegreesKelvin = [3, Some("°K"), "Degree Kelvin", "Degrees Kelvin"], Volt = [4, Some("V"), "Volt", "Volts"], @@ -208,7 +208,7 @@ unit! { Underrun = [83, None, "Underrun", "Underruns"], Collision = [84, None, "Collision", "Collisions"], Packet = [85, None, "Packet", "Packets"], - Message = [86, None, "Message", "Messges"], + Message = [86, None, "Message", "Messages"], Character = [87, None, "Character", "Characters"], Error = [88, None, "Error", "Errors"], CorrectableError = [89, None, "Correctable Error", "Correctable Errors"], @@ -221,9 +221,9 @@ unit! { fn display_tests() { use Unit::*; - assert_eq!("32 °C", DegreesCelcius.display(true, 32)); - assert_eq!("32 Degrees Celcius", DegreesCelcius.display(false, 32)); - assert_eq!("1 Degree Celcius", DegreesCelcius.display(false, 1)); + assert_eq!("32 °C", DegreesCelsius.display(true, 32)); + assert_eq!("32 Degrees Celsius", DegreesCelsius.display(false, 32)); + assert_eq!("1 Degree Celsius", DegreesCelsius.display(false, 1)); assert_eq!("-1 Nit", Nit.display(true, -1)); assert_eq!("-1 Nit", Nit.display(false, -1)); assert_eq!("-15 Nits", Nit.display(false, -15)); diff --git a/ipmi-rs/src/rmcp/v1_5/mod.rs b/ipmi-rs/src/rmcp/v1_5/mod.rs index 09bf459..0f40d21 100644 --- a/ipmi-rs/src/rmcp/v1_5/mod.rs +++ b/ipmi-rs/src/rmcp/v1_5/mod.rs @@ -138,7 +138,7 @@ impl State { let activate_session: ActivateSession = ActivateSession { auth_type: activation_auth_type, - maxiumum_privilege_level: privilege_level, + maximum_privilege_level: privilege_level, challenge_string: challenge.challenge_string, initial_sequence_number: 0xDEAD_BEEF, }; diff --git a/ipmi-rs/src/rmcp/v2_0/messages/rakp_3.rs b/ipmi-rs/src/rmcp/v2_0/messages/rakp_3.rs index b59aca3..ebc2e67 100644 --- a/ipmi-rs/src/rmcp/v2_0/messages/rakp_3.rs +++ b/ipmi-rs/src/rmcp/v2_0/messages/rakp_3.rs @@ -15,7 +15,7 @@ impl RakpMessage3<'_> { let (status, after_id) = match &self.contents { RakpMessage3Contents::Failure(status) => ((*status).into(), &[][..]), - RakpMessage3Contents::Succes(data) => (0x00, *data), + RakpMessage3Contents::Success(data) => (0x00, *data), }; // Status code: success @@ -34,7 +34,7 @@ impl RakpMessage3<'_> { pub enum RakpMessage3Contents<'a> { Failure(RakpMessage3ErrorStatusCode), - Succes(&'a [u8]), + Success(&'a [u8]), } #[derive(Debug, Clone, Copy)] diff --git a/ipmi-rs/src/rmcp/v2_0/mod.rs b/ipmi-rs/src/rmcp/v2_0/mod.rs index 0c7bb25..41be8de 100644 --- a/ipmi-rs/src/rmcp/v2_0/mod.rs +++ b/ipmi-rs/src/rmcp/v2_0/mod.rs @@ -360,7 +360,7 @@ impl State { RakpMessage3 { message_tag: 0x0A, managed_system_session_id: response.managed_system_session_id, - contents: RakpMessage3Contents::Succes(m3), + contents: RakpMessage3Contents::Success(m3), } } else { log::warn!("Received RAKP message 2 with invalid integrity check value."); From e8c14a31b7ed1caab87efdf65eb7b0c0367cc709 Mon Sep 17 00:00:00 2001 From: weriomat Date: Sun, 12 Jul 2026 18:13:24 +0200 Subject: [PATCH 3/3] ci: add spell checking via typos We added `Ba` to the ignored words as it is contained in `dBa` which is correct. --- .github/workflows/spelling.yml | 19 +++++++++++++++++++ typos.toml | 4 ++++ 2 files changed, 23 insertions(+) create mode 100644 .github/workflows/spelling.yml create mode 100644 typos.toml diff --git a/.github/workflows/spelling.yml b/.github/workflows/spelling.yml new file mode 100644 index 0000000..bed717f --- /dev/null +++ b/.github/workflows/spelling.yml @@ -0,0 +1,19 @@ +name: Spelling + +permissions: + contents: read + +on: [pull_request] + +env: + CLICOLOR: 1 + +jobs: + spelling: + name: Spell Check with Typos + runs-on: ubuntu-latest + steps: + - name: Checkout Actions Repository + uses: actions/checkout@v5 + - name: Spell Check Repo + uses: crate-ci/typos@v1.48.0 diff --git a/typos.toml b/typos.toml new file mode 100644 index 0000000..456764c --- /dev/null +++ b/typos.toml @@ -0,0 +1,4 @@ +[default] + +[default.extend-words] +Ba = "Ba"