rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
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,
	Trevor Gross <tmgross@umich.edu>,
	Martin Rodriguez Reboredo <yakoyoku@gmail.com>
Subject: [PATCH v2 04/12] rust: kernel: add srctree-relative doclinks
Date: Tue, 23 Jan 2024 16:00:58 +0100	[thread overview]
Message-ID: <20240123150112.124084-5-kernel@valentinobst.de> (raw)
In-Reply-To: <20240123150112.124084-1-kernel@valentinobst.de>

Convert existing references to C header files to make use of
Commit bc2e7d5c298a ("rust: support `srctree`-relative links").

Signed-off-by: Valentin Obst <kernel@valentinobst.de>
Reviewed-by: Trevor Gross <tmgross@umich.edu>
Reviewed-by: Martin Rodriguez Reboredo <yakoyoku@gmail.com>
---
 rust/kernel/lib.rs          | 2 +-
 rust/kernel/sync/condvar.rs | 2 ++
 2 files changed, 3 insertions(+), 1 deletion(-)

diff --git a/rust/kernel/lib.rs b/rust/kernel/lib.rs
index e6aff80b521f..0d365c71cae2 100644
--- a/rust/kernel/lib.rs
+++ b/rust/kernel/lib.rs
@@ -75,7 +75,7 @@ pub trait Module: Sized + Sync {
 
 /// Equivalent to `THIS_MODULE` in the C API.
 ///
-/// C header: `include/linux/export.h`
+/// C header: [`include/linux/export.h`](srctree/include/linux/export.h)
 pub struct ThisModule(*mut bindings::module);
 
 // SAFETY: `THIS_MODULE` may be used from all threads within a module.
diff --git a/rust/kernel/sync/condvar.rs b/rust/kernel/sync/condvar.rs
index f65e19d5a37c..0bb76400efd9 100644
--- a/rust/kernel/sync/condvar.rs
+++ b/rust/kernel/sync/condvar.rs
@@ -77,6 +77,8 @@ pub struct CondVar {
 
     /// A condvar needs to be pinned because it contains a [`struct list_head`] that is
     /// self-referential, so it cannot be safely moved once it is initialised.
+    ///
+    /// [`struct list_head`]: srctree/include/linux/types.h
     #[pin]
     _pin: PhantomPinned,
 }
-- 
2.43.0


  parent 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 [PATCH v2 00/12] rust: kernel: documentation improvements Valentin Obst
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 ` Valentin Obst [this message]
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-5-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=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).