mirror of https://lore.kernel.org/lkml/
 help / color / mirror / Atom feed
From: Dirk Behme <dirk.behme@gmail.com>
To: Danilo Krummrich <dakr@kernel.org>, Marko Turk <mt@markoturk.info>
Cc: dirk.behme@de.bosch.com, linux-pci@vger.kernel.org,
	linux-kernel@vger.kernel.org, rust-for-linux@vger.kernel.org
Subject: Re: [PATCH 2/2] rust: pci: fix typo in Bar struct's comment
Date: Sat, 3 Jan 2026 16:38:36 +0100	[thread overview]
Message-ID: <84cc5699-f9ab-42b3-a1ea-15bf9bd80d19@gmail.com> (raw)
In-Reply-To: <DFF23OTZRIDS.2PZIV7D8AHWFA@kernel.org>

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@markoturk.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
> 
> 


  reply	other threads:[~2026-01-03 15:38 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2026-01-03 14:31 [PATCH 1/2] rust: io: fix Bar reference in Io " Marko Turk
2026-01-03 14:31 ` [PATCH 2/2] rust: pci: fix typo in Bar " Marko Turk
2026-01-03 15:24   ` Danilo Krummrich
2026-01-03 15:38     ` Dirk Behme [this message]
2026-01-03 21:16       ` Marko Turk
2026-01-04 12:45         ` Miguel Ojeda
2026-01-04 14:08           ` Danilo Krummrich
2026-01-04 18:30             ` Miguel Ojeda
2026-01-05  6:25               ` Greg KH
2026-01-05 10:39                 ` Miguel Ojeda
2026-01-05 12:38                   ` Danilo Krummrich
2026-01-03 15:22 ` [PATCH 1/2] rust: io: fix Bar reference in Io " Danilo Krummrich

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=84cc5699-f9ab-42b3-a1ea-15bf9bd80d19@gmail.com \
    --to=dirk.behme@gmail.com \
    --cc=dakr@kernel.org \
    --cc=dirk.behme@de.bosch.com \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-pci@vger.kernel.org \
    --cc=mt@markoturk.info \
    --cc=rust-for-linux@vger.kernel.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

all inboxes | Powered by JetHome®