From: Valentin Obst via B4 Relay <devnull+kernel.valentinobst.de@kernel.org>
To: "Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>,
"Wedson Almeida Filho" <wedsonaf@gmail.com>,
"Boqun Feng" <boqun.feng@gmail.com>,
"Gary Guo" <gary@garyguo.net>,
"Björn Roy Baron" <bjorn3_gh@protonmail.com>,
"Benno Lossin" <benno.lossin@proton.me>,
"Andreas Hindborg" <a.hindborg@samsung.com>,
"Alice Ryhl" <aliceryhl@google.com>
Cc: rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
Valentin Obst <kernel@valentinobst.de>,
Trevor Gross <tmgross@umich.edu>,
Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Subject: [PATCH v3 00/12] rust: kernel: documentation improvements
Date: Wed, 31 Jan 2024 21:23:22 +0100 [thread overview]
Message-ID: <20240131-doc-fixes-v3-v3-0-0c8af94ed7de@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 v3:
- Adjusted word wrapping in "rust: locked_by: shorten doclink preview"
to make use of the gained space.
- Rebased with `rust-next`.
- Link to v2: https://lore.kernel.org/lkml/20240123150112.124084-1-kernel@valentinobst.de/
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 | 7 +++--
rust/kernel/task.rs | 6 ++--
rust/kernel/types.rs | 3 ++
rust/kernel/workqueue.rs | 64 +++++++++++++++++++--------------------
14 files changed, 84 insertions(+), 73 deletions(-)
---
base-commit: f090f0d0eea9666a96702b29bc9a64cbabee85c5
change-id: 20240131-doc-fixes-v3-88af6c8c1777
Best regards,
--
Valentin Obst <kernel@valentinobst.de>
next reply other threads:[~2024-01-31 20:24 UTC|newest]
Thread overview: 15+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-01-31 20:23 Valentin Obst via B4 Relay [this message]
2024-01-31 20:23 ` [PATCH v3 01/12] rust: kernel: fix multiple typos in documentation Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 02/12] rust: error: improve unsafe code in example Valentin Obst via B4 Relay
2024-02-01 2:23 ` Trevor Gross
2024-01-31 20:23 ` [PATCH v3 03/12] rust: ioctl: end top-level module docs with full stop Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 04/12] rust: kernel: add srctree-relative doclinks Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 05/12] rust: str: use `NUL` instead of 0 in doc comments Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 06/12] rust: str: move SAFETY comment in front of unsafe block Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 07/12] rust: kernel: unify spelling of refcount in docs Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 08/12] rust: kernel: mark code fragments in docs with backticks Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 09/12] rust: kernel: add blank lines in front of code blocks Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 10/12] rust: kernel: add doclinks Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 11/12] rust: kernel: remove unneeded doclink targets Valentin Obst via B4 Relay
2024-01-31 20:23 ` [PATCH v3 12/12] rust: locked_by: shorten doclink preview Valentin Obst via B4 Relay
2024-02-18 20:24 ` [PATCH v3 00/12] rust: kernel: documentation improvements Miguel Ojeda
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=20240131-doc-fixes-v3-v3-0-0c8af94ed7de@valentinobst.de \
--to=devnull+kernel.valentinobst.de@kernel.org \
--cc=a.hindborg@samsung.com \
--cc=alex.gaynor@gmail.com \
--cc=aliceryhl@google.com \
--cc=benno.lossin@proton.me \
--cc=bjorn3_gh@protonmail.com \
--cc=boqun.feng@gmail.com \
--cc=gary@garyguo.net \
--cc=kernel@valentinobst.de \
--cc=linux-kernel@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
--cc=wedsonaf@gmail.com \
--cc=yakoyoku@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 NNTP newsgroup(s).