mbox series

[00/13] rust: kernel: documentation improvements

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

Message

Valentin Obst Jan. 16, 2024, 4:01 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,12,13)
- adding more intra-doc links as well as srctree-relative links to C
  header files (commits #4,10,11)

Valentin Obst (13):
  rust: kernel: fix multiple typos in documentation
  rust: error: move unsafe block into function call
  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: add doclinks with html tags
  rust: kernel: remove unneeded doclink targets
  rust: locked_by: shorten doclink preview

 rust/kernel/allocator.rs          |  2 +-
 rust/kernel/error.rs              |  7 +---
 rust/kernel/init.rs               | 16 +++----
 rust/kernel/ioctl.rs              |  6 +--
 rust/kernel/lib.rs                |  2 +-
 rust/kernel/str.rs                | 15 +++----
 rust/kernel/sync/arc.rs           | 34 ++++++++-------
 rust/kernel/sync/condvar.rs       |  2 +
 rust/kernel/sync/lock.rs          | 13 ++++--
 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          | 70 +++++++++++++++----------------
 14 files changed, 98 insertions(+), 85 deletions(-)

Comments

Martin Rodriguez Reboredo Jan. 17, 2024, 1:41 a.m. UTC | #1 
On 1/16/24 13:01, Valentin Obst wrote:
> 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,12,13)
> - adding more intra-doc links as well as srctree-relative links to C
>    header files (commits #4,10,11)
> 
> Valentin Obst (13):
>    rust: kernel: fix multiple typos in documentation
>    rust: error: move unsafe block into function call
>    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: add doclinks with html tags
>    rust: kernel: remove unneeded doclink targets
>    rust: locked_by: shorten doclink preview
> 
>   rust/kernel/allocator.rs          |  2 +-
>   rust/kernel/error.rs              |  7 +---
>   rust/kernel/init.rs               | 16 +++----
>   rust/kernel/ioctl.rs              |  6 +--
>   rust/kernel/lib.rs                |  2 +-
>   rust/kernel/str.rs                | 15 +++----
>   rust/kernel/sync/arc.rs           | 34 ++++++++-------
>   rust/kernel/sync/condvar.rs       |  2 +
>   rust/kernel/sync/lock.rs          | 13 ++++--
>   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          | 70 +++++++++++++++----------------
>   14 files changed, 98 insertions(+), 85 deletions(-)
> 

Add my `Reviewed-By` to all the patch series except [PATCH 11/13].

Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>