From: Alice Ryhl <aliceryhl@google.com>
To: Dirk Behme <dirk.behme@de.bosch.com>
Cc: rust-for-linux@vger.kernel.org, ojeda@kernel.org,
daniel.almeida@collabora.com, Boqun Feng <boqun.feng@gmail.com>,
Gary Guo <gary@garyguo.net>,
Andreas Hindborg <a.hindborg@kernel.org>,
Trevor Gross <tmgross@umich.edu>
Subject: Re: [PATCH v3 1/2] rust: types: `Opaque` doc: Add some intra doc linkage
Date: Wed, 5 Mar 2025 08:12:40 +0000 [thread overview]
Message-ID: <Z8gHeIe-1AkhnNgO@google.com> (raw)
In-Reply-To: <20250305053438.1532397-1-dirk.behme@de.bosch.com>
On Wed, Mar 05, 2025 at 06:34:37AM +0100, Dirk Behme wrote:
> Add some missing intra doc linkage `[...]`.
>
> Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
Reviewed-by: Alice Ryhl <aliceryhl@google.com>
> rust/kernel/types.rs | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs
> index c3dc798221dbc..af30e9c0ebccb 100644
> --- a/rust/kernel/types.rs
> +++ b/rust/kernel/types.rs
> @@ -271,7 +271,7 @@ fn drop(&mut self) {
>
> /// Stores an opaque value.
> ///
> -/// `Opaque<T>` is meant to be used with FFI objects that are never interpreted by Rust code.
> +/// [`Opaque<T>`] is meant to be used with FFI objects that are never interpreted by Rust code.
> ///
> /// It is used to wrap structs from the C side, like for example `Opaque<bindings::mutex>`.
> /// It gets rid of all the usual assumptions that Rust has for a value:
> @@ -286,7 +286,7 @@ fn drop(&mut self) {
> /// This has to be used for all values that the C side has access to, because it can't be ensured
> /// that the C side is adhering to the usual constraints that Rust needs.
> ///
> -/// Using `Opaque<T>` allows to continue to use references on the Rust side even for values shared
> +/// Using [`Opaque<T>`] allows to continue to use references on the Rust side even for values shared
> /// with C.
> ///
> /// # Examples
> --
> 2.48.0
>
next prev parent reply other threads:[~2025-03-05 8:12 UTC|newest]
Thread overview: 19+ messages / expand[flat|nested] mbox.gz Atom feed top
[not found] <Qag_hE1Uvj0nZB8Bf_MPl4UUT5v6CzPHCzseIqIvESgDKvayvNPlhVBSSS-HVW_ubhQh1GJrGH3eU-8Fy84YOQ==@protonmail.internalid>
2025-03-05 5:34 ` [PATCH v3 1/2] rust: types: `Opaque` doc: Add some intra doc linkage Dirk Behme
2025-03-05 5:34 ` [PATCH v3 2/2] rust: types: `Opaque` doc: Add some destructor description Dirk Behme
2025-03-05 7:47 ` Andreas Hindborg
2025-03-05 15:39 ` Boqun Feng
2025-03-05 17:32 ` Andreas Hindborg
2025-03-05 18:49 ` Boqun Feng
2025-03-05 21:07 ` Andreas Hindborg
2025-03-06 6:01 ` Boqun Feng
2025-03-06 9:42 ` Andreas Hindborg
2025-03-06 10:45 ` Benno Lossin
2025-03-07 0:00 ` Boqun Feng
2025-03-06 9:48 ` Alice Ryhl
2025-03-07 8:22 ` Andreas Hindborg
2025-03-10 16:20 ` Miguel Ojeda
2025-03-05 15:25 ` Boqun Feng
2025-03-05 7:41 ` [PATCH v3 1/2] rust: types: `Opaque` doc: Add some intra doc linkage Andreas Hindborg
2025-03-05 8:12 ` Alice Ryhl [this message]
2025-03-05 8:40 ` Fiona Behrens
2025-03-10 14:25 ` 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=Z8gHeIe-1AkhnNgO@google.com \
--to=aliceryhl@google.com \
--cc=a.hindborg@kernel.org \
--cc=boqun.feng@gmail.com \
--cc=daniel.almeida@collabora.com \
--cc=dirk.behme@de.bosch.com \
--cc=gary@garyguo.net \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=tmgross@umich.edu \
/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).