From: Danilo Krummrich <dakr@kernel.org>
To: Wren Turkal <wt@penguintechs.org>
Cc: "Rahul Rameshbabu" <sergeantsagara@protonmail.com>,
linux-pci@vger.kernel.org, rust-for-linux@vger.kernel.org,
"Bjorn Helgaas" <bhelgaas@google.com>,
"Krzysztof Wilczyński" <kwilczynski@kernel.org>,
"Miguel Ojeda" <ojeda@kernel.org>,
"Alex Gaynor" <alex.gaynor@gmail.com>
Subject: Re: [PATCH] rust: pci: fix documentation related to Device instances
Date: Sat, 5 Jul 2025 13:11:52 +0200 [thread overview]
Message-ID: <21caf88e-aa7d-4133-b6e4-5d365ce8b69d@kernel.org> (raw)
In-Reply-To: <954c0915-25d9-4bc3-ac82-452650902a3c@penguintechs.org>
On 6/29/25 9:14 AM, Wren Turkal wrote:
> On 6/28/25 10:57 PM, Rahul Rameshbabu wrote:
>> ///
>> /// # Invariants
>> ///
>> -/// A [`Device`] instance represents a valid `struct device` created by the C
>> portion of the kernel.
>> +/// A [`Device`] instance represents a valid `struct pci_dev` created by the
>> C portion of the kernel.
>
> Should this not just be a "a valid pci device" and let the type in the function
> definition speak for the type instead of duplicating the type name in the doc
> comment?
The type is relevant for the invariant.
next prev parent reply other threads:[~2025-07-05 11:11 UTC|newest]
Thread overview: 8+ messages / expand[flat|nested] mbox.gz Atom feed top
2025-06-29 5:57 [PATCH] rust: pci: fix documentation related to Device instances Rahul Rameshbabu
2025-06-29 7:14 ` Wren Turkal
2025-07-05 7:05 ` Rahul Rameshbabu
2025-07-05 11:11 ` Danilo Krummrich [this message]
2025-06-29 7:15 ` Wren Turkal
2025-06-29 7:20 ` Wren Turkal
2025-07-05 11:14 ` Danilo Krummrich
2025-07-06 4:02 ` Rahul Rameshbabu
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=21caf88e-aa7d-4133-b6e4-5d365ce8b69d@kernel.org \
--to=dakr@kernel.org \
--cc=alex.gaynor@gmail.com \
--cc=bhelgaas@google.com \
--cc=kwilczynski@kernel.org \
--cc=linux-pci@vger.kernel.org \
--cc=ojeda@kernel.org \
--cc=rust-for-linux@vger.kernel.org \
--cc=sergeantsagara@protonmail.com \
--cc=wt@penguintechs.org \
/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).