[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]
Message-ID: <84cc5699-f9ab-42b3-a1ea-15bf9bd80d19@gmail.com>
Date: Sat, 3 Jan 2026 16:38:36 +0100
From: Dirk Behme <dirk.behme@...il.com>
To: Danilo Krummrich <dakr@...nel.org>, Marko Turk <mt@...koturk.info>
Cc: dirk.behme@...bosch.com, linux-pci@...r.kernel.org,
linux-kernel@...r.kernel.org, rust-for-linux@...r.kernel.org
Subject: Re: [PATCH 2/2] rust: pci: fix typo in Bar struct's comment
On 03.01.26 16:24, Danilo Krummrich wrote:
> On Sat Jan 3, 2026 at 3:31 PM CET, Marko Turk wrote:
>> inststance -> instance
>
> It's trivial in this case, but we usually write at least something along the
> lines of "Fix a typo in the doc-comment of the Bar structure: 'inststance ->
> instance'."
>
> Please also add a corresponding Fixes: tag.
While looking at this some days ago as well I came up with
Fixes: 3c2e31d717ac ("rust: pci: move I/O infrastructure to separate
file")
But that just moves the pre-existing typo from rust/kernel/pci.rs to
rust/kernel/pci/io.rs. So I'm unsure if that move-only commit should
be mentioned in Fixes:? Or if we should go back more to search for the
commit introducing this typo?
Best regards
Dirk
Btw: While we are at this file, do we want to add an 'is' in line 57
as well?
// `pdev` valid by the invariants of `Device`. => ... is valid ...
>> Signed-off-by: Marko Turk <mt@...koturk.info>
>> ---
>> rust/kernel/pci/io.rs | 2 +-
>> 1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/rust/kernel/pci/io.rs b/rust/kernel/pci/io.rs
>> index 0d55c3139b6f..fba746c4dc5d 100644
>> --- a/rust/kernel/pci/io.rs
>> +++ b/rust/kernel/pci/io.rs
>> @@ -20,7 +20,7 @@
>> ///
>> /// # Invariants
>> ///
>> -/// `Bar` always holds an `IoRaw` inststance that holds a valid pointer to the start of the I/O
>> +/// `Bar` always holds an `IoRaw` instance that holds a valid pointer to the start of the I/O
>> /// memory mapped PCI BAR and its size.
>> pub struct Bar<const SIZE: usize = 0> {
>> pdev: ARef<Device>,
>> --
>> 2.51.0
>
>
Powered by blists - more mailing lists