mbox series

[v2,00/12] rust: kernel: documentation improvements

Message ID 20240123150112.124084-1-kernel@valentinobst.de
Headers
Series rust: kernel: documentation improvements |

Message

Valentin Obst Jan. 23, 2024, 3 p.m. UTC 
  This patch set aims to make small improvements to the documentation of
the kernel crate. It engages in a few different activities:
- fixing trivial typos (commit #1),
- updating code examples to better reflect an idiomatic coding style
  (commits #2,6),
- increasing the consistency within the crate's documentation as a whole
  (commits #3,5,7,8,9,11,12),
- adding more intra-doc links as well as srctree-relative links to C
  header files (commits #4,10).

---
Changes in v2:
- Drop commit "rust: kernel: add doclinks with html tags" in response to
  review.
- Fix another list item alignment issue pointed out during review of v1.
  Was added to commit "rust: kernel: fix multiple typos in
  documentation".
- Commit "rust: error: move unsafe block into function call" is now
  "rust: error: improve unsafe code in example" and also rewords the
  SAFETY comment of the code example.
  - Did not add 'Reviewed-By' tags offered in v1 tags due to changes.
- Link to v1: https://lore.kernel.org/lkml/20240116160141.165951-1-kernel@valentinobst.de/
---
Valentin Obst (12):
  rust: kernel: fix multiple typos in documentation
  rust: error: improve unsafe code in example
  rust: ioctl: end top-level module docs with full stop
  rust: kernel: add srctree-relative doclinks
  rust: str: use `NUL` instead of 0 in doc comments
  rust: str: move SAFETY comment in front of unsafe block
  rust: kernel: unify spelling of refcount in docs
  rust: kernel: mark code fragments in docs with backticks
  rust: kernel: add blank lines in front of code blocks
  rust: kernel: add doclinks
  rust: kernel: remove unneeded doclink targets
  rust: locked_by: shorten doclink preview

 rust/kernel/allocator.rs          |  2 +-
 rust/kernel/error.rs              | 10 ++---
 rust/kernel/init.rs               | 16 ++++----
 rust/kernel/ioctl.rs              |  6 +--
 rust/kernel/lib.rs                |  2 +-
 rust/kernel/str.rs                |  8 ++--
 rust/kernel/sync/arc.rs           | 14 +++----
 rust/kernel/sync/condvar.rs       |  2 +
 rust/kernel/sync/lock.rs          | 15 ++++++--
 rust/kernel/sync/lock/spinlock.rs |  2 +-
 rust/kernel/sync/locked_by.rs     |  5 ++-
 rust/kernel/task.rs               |  6 +--
 rust/kernel/types.rs              |  3 ++
 rust/kernel/workqueue.rs          | 64 +++++++++++++++----------------
 14 files changed, 83 insertions(+), 72 deletions(-)

Comments

Alice Ryhl Jan. 30, 2024, 9:22 a.m. UTC | #1 
Valentin Obst <kernel@valentinobst.de> writes:
> This patch set aims to make small improvements to the documentation of
> the kernel crate. It engages in a few different activities:
> - fixing trivial typos (commit #1),
> - updating code examples to better reflect an idiomatic coding style
>   (commits #2,6),
> - increasing the consistency within the crate's documentation as a whole
>   (commits #3,5,7,8,9,11,12),
> - adding more intra-doc links as well as srctree-relative links to C
>   header files (commits #4,10).

I left one comment [1] on the last patch. With that fixed, you may add:

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

to all of the patches.

(I responded on v1 by accident, but it was v2 that I have reviewed.)

[1]: https://lore.kernel.org/rust-for-linux/CAH5fLghSaorRgDDuqNCN-BhQ86ysX96b=nKM_cZAN0_E6Ai04A@mail.gmail.com/
Valentin Obst Jan. 30, 2024, 10:44 a.m. UTC | #2 
> I left one comment [1] on the last patch. With that fixed, you may add:
>
> Reviewed-by: Alice Ryhl <aliceryhl@google.com>
>
> to all of the patches.

Thanks, I'll fix that, rebase with `rust-next` and send out a v3.

	- Valentin

>
> (I responded on v1 by accident, but it was v2 that I have reviewed.)
>
> [1]: https://lore.kernel.org/rust-for-linux/CAH5fLghSaorRgDDuqNCN-BhQ86ysX96b=nKM_cZAN0_E6Ai04A@mail.gmail.com/