[PATCH] rust: fix typos in documentation

[PATCH] rust: fix typos in documentation

[Michael Vetter]

Fix spelling mistakes in code comments.

Signed-off-by: Michael Vetter <jubalh@iodoru.org>
---
 rust/kernel/init/macros.rs | 4 ++--
 rust/kernel/net/phy.rs     | 2 +-
 2 files changed, 3 insertions(+), 3 deletions(-)

diff --git a/rust/kernel/init/macros.rs b/rust/kernel/init/macros.rs
index 02ecedc4a..9a0c4650e 100644
--- a/rust/kernel/init/macros.rs
+++ b/rust/kernel/init/macros.rs
@@ -145,7 +145,7 @@
 //!         }
 //!     }
 //!     // Implement the internal `PinData` trait that marks the pin-data struct as a pin-data
-//!     // struct. This is important to ensure that no user can implement a rouge `__pin_data`
+//!     // struct. This is important to ensure that no user can implement a rogue `__pin_data`
 //!     // function without using `unsafe`.
 //!     unsafe impl<T> ::kernel::init::__internal::PinData for __ThePinData<T> {
 //!         type Datee = Bar<T>;
@@ -156,7 +156,7 @@
 //!     // case no such fields exist, hence this is almost empty. The two phantomdata fields exist
 //!     // for two reasons:
 //!     // - `__phantom`: every generic must be used, since we cannot really know which generics
-//!     //   are used, we declere all and then use everything here once.
+//!     //   are used, we declare all and then use everything here once.
 //!     // - `__phantom_pin`: uses the `'__pin` lifetime and ensures that this struct is invariant
 //!     //   over it. The lifetime is needed to work around the limitation that trait bounds must
 //!     //   not be trivial, e.g. the user has a `#[pin] PhantomPinned` field -- this is
diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs
index fd40b703d..91dac63ff 100644
--- a/rust/kernel/net/phy.rs
+++ b/rust/kernel/net/phy.rs
@@ -491,7 +491,7 @@ impl<T: Driver> Adapter<T> {
 pub struct DriverVTable(Opaque<bindings::phy_driver>);
 
 // SAFETY: `DriverVTable` doesn't expose any &self method to access internal data, so it's safe to
-// share `&DriverVTable` across execution context boundries.
+// share `&DriverVTable` across execution context boundaries.
 unsafe impl Sync for DriverVTable {}
 
 /// Creates a [`DriverVTable`] instance from [`Driver`].
-- 
2.35.3

Re: [PATCH] rust: fix typos in documentation

[Alice Ryhl]

On Mon, Aug 19, 2024 at 11:03 PM Michael Vetter <jubalh@iodoru.org> wrote:
>
> Fix spelling mistakes in code comments.
>
> Signed-off-by: Michael Vetter <jubalh@iodoru.org>

Reviewed-by: Alice Ryhl <aliceryhl@google.com>

Re: [PATCH] rust: fix typos in documentation

[Benno Lossin]

On 19.08.24 22:57, Michael Vetter wrote:
> Fix spelling mistakes in code comments.
> 
> Signed-off-by: Michael Vetter <jubalh@iodoru.org>

Reviewed-by: Benno Lossin <benno.lossin@proton.me>

---
Cheers,
Benno

> ---
>  rust/kernel/init/macros.rs | 4 ++--
>  rust/kernel/net/phy.rs     | 2 +-
>  2 files changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/rust/kernel/init/macros.rs b/rust/kernel/init/macros.rs
> index 02ecedc4a..9a0c4650e 100644
> --- a/rust/kernel/init/macros.rs
> +++ b/rust/kernel/init/macros.rs
> @@ -145,7 +145,7 @@
>  //!         }
>  //!     }
>  //!     // Implement the internal `PinData` trait that marks the pin-data struct as a pin-data
> -//!     // struct. This is important to ensure that no user can implement a rouge `__pin_data`
> +//!     // struct. This is important to ensure that no user can implement a rogue `__pin_data`
>  //!     // function without using `unsafe`.
>  //!     unsafe impl<T> ::kernel::init::__internal::PinData for __ThePinData<T> {
>  //!         type Datee = Bar<T>;
> @@ -156,7 +156,7 @@
>  //!     // case no such fields exist, hence this is almost empty. The two phantomdata fields exist
>  //!     // for two reasons:
>  //!     // - `__phantom`: every generic must be used, since we cannot really know which generics
> -//!     //   are used, we declere all and then use everything here once.
> +//!     //   are used, we declare all and then use everything here once.
>  //!     // - `__phantom_pin`: uses the `'__pin` lifetime and ensures that this struct is invariant
>  //!     //   over it. The lifetime is needed to work around the limitation that trait bounds must
>  //!     //   not be trivial, e.g. the user has a `#[pin] PhantomPinned` field -- this is
> diff --git a/rust/kernel/net/phy.rs b/rust/kernel/net/phy.rs
> index fd40b703d..91dac63ff 100644
> --- a/rust/kernel/net/phy.rs
> +++ b/rust/kernel/net/phy.rs
> @@ -491,7 +491,7 @@ impl<T: Driver> Adapter<T> {
>  pub struct DriverVTable(Opaque<bindings::phy_driver>);
> 
>  // SAFETY: `DriverVTable` doesn't expose any &self method to access internal data, so it's safe to
> -// share `&DriverVTable` across execution context boundries.
> +// share `&DriverVTable` across execution context boundaries.
>  unsafe impl Sync for DriverVTable {}
> 
>  /// Creates a [`DriverVTable`] instance from [`Driver`].
> --
> 2.35.3
> 
> 

Re: [PATCH] rust: fix typos in documentation

[Miguel Ojeda]

On Mon, Aug 19, 2024 at 11:03 PM Michael Vetter <jubalh@iodoru.org> wrote:
>
> Fix spelling mistakes in code comments.
>
> Signed-off-by: Michael Vetter <jubalh@iodoru.org>

Applied to `rust-fixes` -- thanks everyone!

    [ Reworded slightly. - Miguel ]

Cheers,
Miguel