From: Valentin Obst <kernel@valentinobst.de>
To: Valentin Obst <fraunhofer@valentinobst.de>,
Miguel Ojeda <ojeda@kernel.org>,
Alex Gaynor <alex.gaynor@gmail.com>,
Wedson Almeida Filho <wedsonaf@gmail.com>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org
Subject: [PATCH v2 00/12] rust: kernel: documentation improvements
Date: Tue, 23 Jan 2024 16:00:54 +0100 [thread overview]
Message-ID: <20240123150112.124084-1-kernel@valentinobst.de> (raw)
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(-)
--
2.43.0
next reply other threads:[~2024-01-23 15:01 UTC|newest]
Thread overview: 16+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-23 15:00 Valentin Obst [this message]
2024-01-23 15:00 ` [PATCH v2 01/12] rust: kernel: fix multiple typos in documentation Valentin Obst
2024-01-23 15:00 ` [PATCH v2 02/12] rust: error: improve unsafe code in example Valentin Obst
2024-01-27 15:10 ` Martin Rodriguez Reboredo
2024-01-23 15:00 ` [PATCH v2 03/12] rust: ioctl: end top-level module docs with full stop Valentin Obst
2024-01-23 15:00 ` [PATCH v2 04/12] rust: kernel: add srctree-relative doclinks Valentin Obst
2024-01-23 15:00 ` [PATCH v2 05/12] rust: str: use `NUL` instead of 0 in doc comments Valentin Obst
2024-01-23 16:06 ` [PATCH v2 06/12] rust: str: move SAFETY comment in front of unsafe block Valentin Obst
2024-01-23 16:07 ` [PATCH v2 07/12] rust: kernel: unify spelling of refcount in docs Valentin Obst
2024-01-23 16:09 ` [PATCH v2 08/12] rust: kernel: mark code fragments in docs with backticks Valentin Obst
2024-01-23 16:09 ` [PATCH v2 09/12] rust: kernel: add blank lines in front of code blocks Valentin Obst
2024-01-23 16:10 ` [PATCH v2 10/12] rust: kernel: add doclinks Valentin Obst
2024-01-23 16:10 ` [PATCH v2 11/12] rust: kernel: remove unneeded doclink targets Valentin Obst
2024-01-23 16:10 ` [PATCH v2 12/12] rust: locked_by: shorten doclink preview Valentin Obst
2024-01-30 9:22 ` [PATCH v2 00/12] rust: kernel: documentation improvements Alice Ryhl
2024-01-30 10:44 ` Valentin Obst
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=20240123150112.124084-1-kernel@valentinobst.de \
--to=kernel@valentinobst.de \
--cc=alex.gaynor@gmail.com \
--cc=fraunhofer@valentinobst.de \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=wedsonaf@gmail.com \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for read-only IMAP folder(s) and NNTP newsgroup(s).