[PATCH] Documentation: PCI: Fix typos in msi-howto.rst

[PATCH] Documentation: PCI: Fix typos in msi-howto.rst

[Shawn Lin]

Fix subjject-verb agreement for "has a requirements" as well as
"neither...or" conjunction mistake. And convert "Message Signalled
Interrupts" to "Message Signaled Interrupts" to match the PCIe spec.

Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>
---

 Documentation/PCI/msi-howto.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/PCI/msi-howto.rst b/Documentation/PCI/msi-howto.rst
index 0692c9a..667ebe2 100644
--- a/Documentation/PCI/msi-howto.rst
+++ b/Documentation/PCI/msi-howto.rst
@@ -98,7 +98,7 @@ function::
 
 which allocates up to max_vecs interrupt vectors for a PCI device.  It
 returns the number of vectors allocated or a negative error.  If the device
-has a requirements for a minimum number of vectors the driver can pass a
+has a requirement for a minimum number of vectors the driver can pass a
 min_vecs argument set to this limit, and the PCI core will return -ENOSPC
 if it can't meet the minimum number of vectors.
 
@@ -127,7 +127,7 @@ not be able to allocate as many vectors for MSI as it could for MSI-X.  On
 some platforms, MSI interrupts must all be targeted at the same set of CPUs
 whereas MSI-X interrupts can all be targeted at different CPUs.
 
-If a device supports neither MSI-X or MSI it will fall back to a single
+If a device supports neither MSI-X nor MSI it will fall back to a single
 legacy IRQ vector.
 
 The typical usage of MSI or MSI-X interrupts is to allocate as many vectors
@@ -203,7 +203,7 @@ How to tell whether MSI/MSI-X is enabled on a device
 ----------------------------------------------------
 
 Using 'lspci -v' (as root) may show some devices with "MSI", "Message
-Signalled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
+Signaled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
 has an 'Enable' flag which is followed with either "+" (enabled)
 or "-" (disabled).
 
-- 
2.7.4

Re: [PATCH] Documentation: PCI: Fix typos in msi-howto.rst

[Randy Dunlap]

On 12/25/25 5:45 PM, Shawn Lin wrote:
> Fix subjject-verb agreement for "has a requirements" as well as
> "neither...or" conjunction mistake. And convert "Message Signalled
> Interrupts" to "Message Signaled Interrupts" to match the PCIe spec.
> 
> Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>

Reviewed-by: Randy Dunlap <rdunlap@infradead.org>
Tested-by: Randy Dunlap <rdunlap@infradead.org>

Thanks.

> ---
> 
>  Documentation/PCI/msi-howto.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/PCI/msi-howto.rst b/Documentation/PCI/msi-howto.rst
> index 0692c9a..667ebe2 100644
> --- a/Documentation/PCI/msi-howto.rst
> +++ b/Documentation/PCI/msi-howto.rst
> @@ -98,7 +98,7 @@ function::
>  
>  which allocates up to max_vecs interrupt vectors for a PCI device.  It
>  returns the number of vectors allocated or a negative error.  If the device
> -has a requirements for a minimum number of vectors the driver can pass a
> +has a requirement for a minimum number of vectors the driver can pass a
>  min_vecs argument set to this limit, and the PCI core will return -ENOSPC
>  if it can't meet the minimum number of vectors.
>  
> @@ -127,7 +127,7 @@ not be able to allocate as many vectors for MSI as it could for MSI-X.  On
>  some platforms, MSI interrupts must all be targeted at the same set of CPUs
>  whereas MSI-X interrupts can all be targeted at different CPUs.
>  
> -If a device supports neither MSI-X or MSI it will fall back to a single
> +If a device supports neither MSI-X nor MSI it will fall back to a single
>  legacy IRQ vector.
>  
>  The typical usage of MSI or MSI-X interrupts is to allocate as many vectors
> @@ -203,7 +203,7 @@ How to tell whether MSI/MSI-X is enabled on a device
>  ----------------------------------------------------
>  
>  Using 'lspci -v' (as root) may show some devices with "MSI", "Message
> -Signalled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
> +Signaled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
>  has an 'Enable' flag which is followed with either "+" (enabled)
>  or "-" (disabled).
>  

-- 
~Randy

Re: [PATCH] Documentation: PCI: Fix typos in msi-howto.rst

[Bagas Sanjaya]

[-- Attachment #1: Type: text/plain, Size: 1853 bytes --]

On Fri, Dec 26, 2025 at 09:45:28AM +0800, Shawn Lin wrote:
> diff --git a/Documentation/PCI/msi-howto.rst b/Documentation/PCI/msi-howto.rst
> index 0692c9a..667ebe2 100644
> --- a/Documentation/PCI/msi-howto.rst
> +++ b/Documentation/PCI/msi-howto.rst
> @@ -98,7 +98,7 @@ function::
>  
>  which allocates up to max_vecs interrupt vectors for a PCI device.  It
>  returns the number of vectors allocated or a negative error.  If the device
> -has a requirements for a minimum number of vectors the driver can pass a
> +has a requirement for a minimum number of vectors the driver can pass a
>  min_vecs argument set to this limit, and the PCI core will return -ENOSPC
>  if it can't meet the minimum number of vectors.
>  
> @@ -127,7 +127,7 @@ not be able to allocate as many vectors for MSI as it could for MSI-X.  On
>  some platforms, MSI interrupts must all be targeted at the same set of CPUs
>  whereas MSI-X interrupts can all be targeted at different CPUs.
>  
> -If a device supports neither MSI-X or MSI it will fall back to a single
> +If a device supports neither MSI-X nor MSI it will fall back to a single
>  legacy IRQ vector.
>  
>  The typical usage of MSI or MSI-X interrupts is to allocate as many vectors
> @@ -203,7 +203,7 @@ How to tell whether MSI/MSI-X is enabled on a device
>  ----------------------------------------------------
>  
>  Using 'lspci -v' (as root) may show some devices with "MSI", "Message
> -Signalled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
> +Signaled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
>  has an 'Enable' flag which is followed with either "+" (enabled)
>  or "-" (disabled).
>  

Looks good, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>

-- 
An old man doll... just what I always wanted! - Clara

[-- Attachment #2: signature.asc --]
[-- Type: application/pgp-signature, Size: 228 bytes --]

Re: [PATCH] Documentation: PCI: Fix typos in msi-howto.rst

[Zenghui Yu]

On 2025/12/26 09:45, Shawn Lin wrote:
> Fix subjject-verb agreement for "has a requirements" as well as
> "neither...or" conjunction mistake. And convert "Message Signalled
> Interrupts" to "Message Signaled Interrupts" to match the PCIe spec.
> 
> Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>
> ---
> 
>  Documentation/PCI/msi-howto.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/PCI/msi-howto.rst b/Documentation/PCI/msi-howto.rst
> index 0692c9a..667ebe2 100644
> --- a/Documentation/PCI/msi-howto.rst
> +++ b/Documentation/PCI/msi-howto.rst
> @@ -98,7 +98,7 @@ function::
>  
>  which allocates up to max_vecs interrupt vectors for a PCI device.  It
>  returns the number of vectors allocated or a negative error.  If the device
> -has a requirements for a minimum number of vectors the driver can pass a
> +has a requirement for a minimum number of vectors the driver can pass a
>  min_vecs argument set to this limit, and the PCI core will return -ENOSPC
>  if it can't meet the minimum number of vectors.
>  
> @@ -127,7 +127,7 @@ not be able to allocate as many vectors for MSI as it could for MSI-X.  On
>  some platforms, MSI interrupts must all be targeted at the same set of CPUs
>  whereas MSI-X interrupts can all be targeted at different CPUs.
>  
> -If a device supports neither MSI-X or MSI it will fall back to a single
> +If a device supports neither MSI-X nor MSI it will fall back to a single
>  legacy IRQ vector.
>  
>  The typical usage of MSI or MSI-X interrupts is to allocate as many vectors
> @@ -203,7 +203,7 @@ How to tell whether MSI/MSI-X is enabled on a device
>  ----------------------------------------------------
>  
>  Using 'lspci -v' (as root) may show some devices with "MSI", "Message
> -Signalled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
> +Signaled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
>  has an 'Enable' flag which is followed with either "+" (enabled)
>  or "-" (disabled).

It was indeed reported as "Message Signalled Interrupts" and was later
changed to "MSI" in [1].  It has been 17 years since then.  Probably we
can just drop the outdated (and misspelled) words?

[1] https://github.com/pciutils/pciutils/commit/acbd2e055b65

Thanks,
Zenghui

Re: [PATCH] Documentation: PCI: Fix typos in msi-howto.rst

[Bjorn Helgaas]

On Fri, Dec 26, 2025 at 09:45:28AM +0800, Shawn Lin wrote:
> Fix subjject-verb agreement for "has a requirements" as well as
> "neither...or" conjunction mistake. And convert "Message Signalled
> Interrupts" to "Message Signaled Interrupts" to match the PCIe spec.
> 
> Signed-off-by: Shawn Lin <shawn.lin@rock-chips.com>

Applied to pci/misc for v6.20, thanks!

> ---
> 
>  Documentation/PCI/msi-howto.rst | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
> 
> diff --git a/Documentation/PCI/msi-howto.rst b/Documentation/PCI/msi-howto.rst
> index 0692c9a..667ebe2 100644
> --- a/Documentation/PCI/msi-howto.rst
> +++ b/Documentation/PCI/msi-howto.rst
> @@ -98,7 +98,7 @@ function::
>  
>  which allocates up to max_vecs interrupt vectors for a PCI device.  It
>  returns the number of vectors allocated or a negative error.  If the device
> -has a requirements for a minimum number of vectors the driver can pass a
> +has a requirement for a minimum number of vectors the driver can pass a
>  min_vecs argument set to this limit, and the PCI core will return -ENOSPC
>  if it can't meet the minimum number of vectors.
>  
> @@ -127,7 +127,7 @@ not be able to allocate as many vectors for MSI as it could for MSI-X.  On
>  some platforms, MSI interrupts must all be targeted at the same set of CPUs
>  whereas MSI-X interrupts can all be targeted at different CPUs.
>  
> -If a device supports neither MSI-X or MSI it will fall back to a single
> +If a device supports neither MSI-X nor MSI it will fall back to a single
>  legacy IRQ vector.
>  
>  The typical usage of MSI or MSI-X interrupts is to allocate as many vectors
> @@ -203,7 +203,7 @@ How to tell whether MSI/MSI-X is enabled on a device
>  ----------------------------------------------------
>  
>  Using 'lspci -v' (as root) may show some devices with "MSI", "Message
> -Signalled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
> +Signaled Interrupts" or "MSI-X" capabilities.  Each of these capabilities
>  has an 'Enable' flag which is followed with either "+" (enabled)
>  or "-" (disabled).
>  
> -- 
> 2.7.4
>