rust: kernel: fix multiple typos in documentation
authorValentin Obst <kernel@valentinobst.de>
Wed, 31 Jan 2024 20:23:23 +0000 (21:23 +0100)
committerMiguel Ojeda <ojeda@kernel.org>
Sun, 18 Feb 2024 20:22:27 +0000 (21:22 +0100)
commitb6cda913bba42e1fdad82df41d906ff603319743
treeb9ae399105ee1f1893a98b552a8f706df1601da7
parent789809a3d540bb2108ca58afac5612a3fbd1eda7
rust: kernel: fix multiple typos in documentation

Fixes multiple trivial typos in documentation and comments of the
kernel crate.

allocator:
- Fix a trivial list item alignment issue in the last SAFETY comment of
  `krealloc_aligned`.

init:
- Replace 'type' with 'trait' in the doc comments of the `PinInit` and
  `Init` traits.
- Add colons before starting lists.
- Add spaces between the type and equal sign to respect the code
  formatting rules in example code.
- End a sentence with a full stop instead of a colon.

ioctl:
- Replace 'an' with 'a' where appropriate.

str:
- Replace 'Return' with 'Returns' in the doc comment of `bytes_written`
  as the text describes what the function does.

sync/lock:
- Fix a trivial list item alignment issue in the Safety section of the
  `Backend` trait's description.

sync/lock/spinlock:
- The code in this module operates on spinlocks, not mutexes. Thus,
  replace 'mutex' with 'spinlock' in the SAFETY comment of `unlock`.

workqueue:
- Replace "wont" with "won't" in the doc comment of `__enqueue`.

Signed-off-by: Valentin Obst <kernel@valentinobst.de>
Reviewed-by: Trevor Gross <tmgross@umich.edu>
Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
Link: https://lore.kernel.org/r/20240131-doc-fixes-v3-v3-1-0c8af94ed7de@valentinobst.de
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
rust/kernel/allocator.rs
rust/kernel/init.rs
rust/kernel/ioctl.rs
rust/kernel/str.rs
rust/kernel/sync/lock.rs
rust/kernel/sync/lock/spinlock.rs
rust/kernel/workqueue.rs