All of lore.kernel.org
 help / color / mirror / Atom feed
From: Andreas Hindborg <a.hindborg@kernel.org>
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>,
	 "Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>
Subject: Re: [PATCH v2 1/2] rust: types: `Opaque` doc: Add some intra doc linkage
Date: Wed, 19 Feb 2025 08:59:38 +0100	[thread overview]
Message-ID: <87y0y2e55h.fsf@kernel.org> (raw)
In-Reply-To: <20250219055516.359454-1-dirk.behme@de.bosch.com> (Dirk Behme's message of "Wed, 19 Feb 2025 06:55:15 +0100")

"Dirk Behme" <dirk.behme@de.bosch.com> writes:

> Add some missing intra doc linkage `[...]`.
>
> Signed-off-by: Dirk Behme <dirk.behme@de.bosch.com>
> ---
> Changes in v2:
>   * Split out this change into this extra patch (Miguel)
>
>  rust/kernel/types.rs | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/rust/kernel/types.rs b/rust/kernel/types.rs
> index c3dc798221dbc..8ed802444c594 100644
> --- a/rust/kernel/types.rs
> +++ b/rust/kernel/types.rs
> @@ -271,10 +271,10 @@ 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:
> +/// It gets rid of all the usual assumptions that Rust has for a value of type `T`:

You yank the effect of this change in patch 2, so maybe just leave it
till then?


Best regards,
Andreas Hindborg



  parent reply	other threads:[~2025-02-19  8:06 UTC|newest]

Thread overview: 10+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
     [not found] <QD0GOJgCH2aX4JQuTDvwU-r5K8zcpSxD3eN6ixps2goHl3elDKOJFlkzUpSQSKaYDFls5CElJa-QXcoHLpInog==@protonmail.internalid>
2025-02-19  5:55 ` [PATCH v2 1/2] rust: types: `Opaque` doc: Add some intra doc linkage Dirk Behme
2025-02-19  5:55   ` [PATCH v2 2/2] rust: types: `Opaque` doc: Add some destructor description Dirk Behme
2025-02-19  8:06     ` Andreas Hindborg
2025-02-25 10:07       ` Daniel Almeida
2025-02-25 10:36         ` Andreas Hindborg
2025-02-25 11:38           ` Miguel Ojeda
2025-02-25 10:20     ` Daniel Almeida
2025-02-19  7:59   ` Andreas Hindborg [this message]
2025-02-19 10:54     ` [PATCH v2 1/2] rust: types: `Opaque` doc: Add some intra doc linkage Miguel Ojeda
2025-02-22 18:26       ` 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=87y0y2e55h.fsf@kernel.org \
    --to=a.hindborg@kernel.org \
    --cc=aliceryhl@google.com \
    --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 an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.