rust-for-linux.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Miguel Ojeda <ojeda@kernel.org>
To: Miguel Ojeda <ojeda@kernel.org>, Alex Gaynor <alex.gaynor@gmail.com>
Cc: "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@kernel.org>,
	"Alice Ryhl" <aliceryhl@google.com>,
	"Trevor Gross" <tmgross@umich.edu>,
	"Danilo Krummrich" <dakr@kernel.org>,
	rust-for-linux@vger.kernel.org, linux-kernel@vger.kernel.org,
	patches@lists.linux.dev,
	"Greg Kroah-Hartman" <gregkh@linuxfoundation.org>,
	"Rafael J. Wysocki" <rafael@kernel.org>,
	"Rob Herring (Arm)" <robh@kernel.org>
Subject: [PATCH 08/10] rust: platform: fix docs related to missing Markdown code spans
Date: Mon, 24 Mar 2025 22:03:55 +0100	[thread overview]
Message-ID: <20250324210359.1199574-9-ojeda@kernel.org> (raw)
In-Reply-To: <20250324210359.1199574-1-ojeda@kernel.org>

Convert `TODO` from documentation to a normal comment, and put code in
block.

This was found using the Clippy `doc_markdown` lint, which we may want
to enable.

Fixes: 683a63befc73 ("rust: platform: add basic platform device / driver abstractions")
Signed-off-by: Miguel Ojeda <ojeda@kernel.org>
---
 rust/kernel/platform.rs | 9 +++++----
 1 file changed, 5 insertions(+), 4 deletions(-)

diff --git a/rust/kernel/platform.rs b/rust/kernel/platform.rs
index 1297f5292ba9..2426eaf915bb 100644
--- a/rust/kernel/platform.rs
+++ b/rust/kernel/platform.rs
@@ -147,10 +147,11 @@ macro_rules! module_platform_driver {
 ///```
 pub trait Driver {
     /// The type holding driver private data about each device id supported by the driver.
-    ///
-    /// TODO: Use associated_type_defaults once stabilized:
-    ///
-    /// type IdInfo: 'static = ();
+    // TODO: Use associated_type_defaults once stabilized:
+    //
+    // ```
+    // type IdInfo: 'static = ();
+    // ```
     type IdInfo: 'static;

     /// The table of OF device ids supported by the driver.
--
2.49.0

  parent reply	other threads:[~2025-03-24 21:04 UTC|newest]

Thread overview: 24+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2025-03-24 21:03 [PATCH 00/10] rust: clean and enable Clippy `doc_markdown` lint Miguel Ojeda
2025-03-24 21:03 ` [PATCH 01/10] drm/panic: add missing space Miguel Ojeda
2025-03-25  9:02   ` Jocelyn Falempe
2025-03-24 21:03 ` [PATCH 02/10] drm/panic: add missing Markdown code span Miguel Ojeda
2025-03-25  9:05   ` Jocelyn Falempe
2025-03-25 19:04     ` Miguel Ojeda
2025-03-27 15:22       ` Jocelyn Falempe
2025-03-24 21:03 ` [PATCH 03/10] rust: alloc: add missing Markdown code spans Miguel Ojeda
2025-03-24 21:03 ` [PATCH 04/10] rust: alloc: add missing Markdown code span Miguel Ojeda
2025-03-24 21:03 ` [PATCH 05/10] rust: dma: " Miguel Ojeda
2025-03-24 21:03 ` [PATCH 06/10] rust: of: " Miguel Ojeda
2025-03-24 21:03 ` [PATCH 07/10] rust: pci: fix docs related to missing Markdown code spans Miguel Ojeda
2025-03-24 22:53   ` Benno Lossin
2025-03-24 23:01     ` Miguel Ojeda
2025-03-24 21:03 ` Miguel Ojeda [this message]
2025-03-24 21:03 ` [PATCH 09/10] rust: task: add missing Markdown code spans and intra-doc links Miguel Ojeda
2025-03-24 21:03 ` [RFC PATCH 10/10] rust: kbuild: enable `doc_markdown` Clippy lint Miguel Ojeda
2025-03-24 22:59 ` [PATCH 00/10] rust: clean and enable Clippy `doc_markdown` lint Benno Lossin
2025-03-24 23:09   ` Miguel Ojeda
2025-03-25  0:17     ` Benno Lossin
2025-05-21 14:01 ` Miguel Ojeda
2025-05-21 15:09   ` Greg Kroah-Hartman
2025-05-24 14:18   ` Danilo Krummrich
2025-05-25 21:20 ` 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=20250324210359.1199574-9-ojeda@kernel.org \
    --to=ojeda@kernel.org \
    --cc=a.hindborg@kernel.org \
    --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=dakr@kernel.org \
    --cc=gary@garyguo.net \
    --cc=gregkh@linuxfoundation.org \
    --cc=linux-kernel@vger.kernel.org \
    --cc=patches@lists.linux.dev \
    --cc=rafael@kernel.org \
    --cc=robh@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).