Received-SPF: pass (google.com: domain of linux-kernel+bounces-35485-linux.lists.archive=gmail.com@vger.kernel.org designates 139.178.88.99 as permitted sender) client-ip=139.178.88.99;
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
Message-ID: <20240123150112.124084-1-kernel@valentinobst.de>
Precedence: bulk
MIME-Version: 1.0
Content-Transfer-Encoding: 8bit
UI-OutboundReport: notjunk:1;M01:P0:JKMwDlkILMs=;zwH/XDKpH9DoDb5R2VRayJs59I+
 ci1Si+3/RuqmgBOhv041VaO11OrV61338fR0wEYyU7S9T7QW+/rNF6wj1X9FqeGyusEUQ6SNC
 +yEUV13ztw5uwVB8SbZjGj3q8CizlWertmbATrmYi0oKHfbKQyzjiFZF72Ov3f0eZ02sZV1nk
 YwnXfZVWfN0zwk8pd7v1l6yMJ8L74gcopGb9bx8oAzX6QSQKl4LwGRcURtOX2vvuI1nGiYX2/
 86kqmshFrnFwCa+PVeypAL3F+D1PUw6jwt/1hx1BFPyPyjZxdDcJ5RMrT8Vu6/wqWesXPvwli
 zTQIYJoDh7RliEMAk1uzh94eXcL5mAUFJ2DTWiiEO5/W+vfbHBuWMwp78BEO0X+IIYtByAiB/
 e6JVcFuO8RLkTiTnBmq/P3wqH5f/lLlXMcD3Yzpr1BDlYQBFn1PKavhYDq3qFMmNHV+U0Ftf3
 EC68X3buN2Okorxrpdkb9L7eHnzANZP65Sr3X5CDTSyaoChkM5D4Mo/E82l9d9WNedxg8TIE0
 g6Ae14KaXi2/LiIQTsPq2rOBmYWXHydpP+dc8gUPQT6ZAz8Lop1DKmUBJ+nCFepLlRqZwscJp
 mg577D+Pc78y0WtCnhxoXdWcqpNaiTpspo02rV1iNii6hdEpoRoRXKTsU6P0glyxOFiZt44Nx
 z27S/5xsk272VzkM299gJWFspxnnHubJ9PeBEZDOTArRVmM0oKFdoSQ8dTBxV9WyWJ4bQiFS+
 H0moMU3YYnhqeLMHKVCu5twc1oqJQEQRWmwgS3Gd4O+87++47MfxxV0FdcdLAp5ATJ9lkQncf
 Oc/MD9iDKSnDRJ1KsQuIcSiW59v4P/pWhep5zEsM77Cs31WyS9kw5czeqJS98rrmoG8ulNNgu
 dA1FxKkyZXK/9pw==

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