[PATCH] PCI/MSI: Fix cut-and-paste errors in documentation

[PATCH] PCI/MSI: Fix cut-and-paste errors in documentation

[Alexander Gordeev]

Function pci_enable_msi_range() is used in examples where
pci_enable_msix_range() should have been used instead.

Reported-by: Bjorn Helgaas <bhelgaas@google.com>
Cc: linux-pci@vger.kernel.org
Signed-off-by: Alexander Gordeev <agordeev@redhat.com>
---
 Documentation/PCI/MSI-HOWTO.txt |   12 ++++++------
 1 files changed, 6 insertions(+), 6 deletions(-)

diff --git a/Documentation/PCI/MSI-HOWTO.txt b/Documentation/PCI/MSI-HOWTO.txt
index a8d0100..43c5a5f 100644
--- a/Documentation/PCI/MSI-HOWTO.txt
+++ b/Documentation/PCI/MSI-HOWTO.txt
@@ -257,8 +257,8 @@ possible, likely up to the limit returned by pci_msix_vec_count() function:
 
 static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
 {
-	return pci_enable_msi_range(adapter->pdev, adapter->msix_entries,
-				    1, nvec);
+	return pci_enable_msix_range(adapter->pdev, adapter->msix_entries,
+				     1, nvec);
 }
 
 Note the value of 'minvec' parameter is 1.  As 'minvec' is inclusive,
@@ -269,8 +269,8 @@ In this case the function could look like this:
 
 static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
 {
-	return pci_enable_msi_range(adapter->pdev, adapter->msix_entries,
-				    FOO_DRIVER_MINIMUM_NVEC, nvec);
+	return pci_enable_msix_range(adapter->pdev, adapter->msix_entries,
+				     FOO_DRIVER_MINIMUM_NVEC, nvec);
 }
 
 4.3.1.2 Exact number of MSI-X interrupts
@@ -282,8 +282,8 @@ parameters:
 
 static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
 {
-	return pci_enable_msi_range(adapter->pdev, adapter->msix_entries,
-				    nvec, nvec);
+	return pci_enable_msix_range(adapter->pdev, adapter->msix_entries,
+				     nvec, nvec);
 }
 
 4.3.1.3 Specific requirements to the number of MSI-X interrupts
-- 
1.7.7.6

Re: [PATCH] PCI/MSI: Fix cut-and-paste errors in documentation

[Bjorn Helgaas]

On Wed, Feb 12, 2014 at 11:35:25AM +0100, Alexander Gordeev wrote:
> Function pci_enable_msi_range() is used in examples where
> pci_enable_msix_range() should have been used instead.
> 
> Reported-by: Bjorn Helgaas <bhelgaas@google.com>
> Cc: linux-pci@vger.kernel.org
> Signed-off-by: Alexander Gordeev <agordeev@redhat.com>

Applied to pci/misc for v3.15, thanks!

Bjorn

> ---
>  Documentation/PCI/MSI-HOWTO.txt |   12 ++++++------
>  1 files changed, 6 insertions(+), 6 deletions(-)
> 
> diff --git a/Documentation/PCI/MSI-HOWTO.txt b/Documentation/PCI/MSI-HOWTO.txt
> index a8d0100..43c5a5f 100644
> --- a/Documentation/PCI/MSI-HOWTO.txt
> +++ b/Documentation/PCI/MSI-HOWTO.txt
> @@ -257,8 +257,8 @@ possible, likely up to the limit returned by pci_msix_vec_count() function:
>  
>  static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
>  {
> -	return pci_enable_msi_range(adapter->pdev, adapter->msix_entries,
> -				    1, nvec);
> +	return pci_enable_msix_range(adapter->pdev, adapter->msix_entries,
> +				     1, nvec);
>  }
>  
>  Note the value of 'minvec' parameter is 1.  As 'minvec' is inclusive,
> @@ -269,8 +269,8 @@ In this case the function could look like this:
>  
>  static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
>  {
> -	return pci_enable_msi_range(adapter->pdev, adapter->msix_entries,
> -				    FOO_DRIVER_MINIMUM_NVEC, nvec);
> +	return pci_enable_msix_range(adapter->pdev, adapter->msix_entries,
> +				     FOO_DRIVER_MINIMUM_NVEC, nvec);
>  }
>  
>  4.3.1.2 Exact number of MSI-X interrupts
> @@ -282,8 +282,8 @@ parameters:
>  
>  static int foo_driver_enable_msix(struct foo_adapter *adapter, int nvec)
>  {
> -	return pci_enable_msi_range(adapter->pdev, adapter->msix_entries,
> -				    nvec, nvec);
> +	return pci_enable_msix_range(adapter->pdev, adapter->msix_entries,
> +				     nvec, nvec);
>  }
>  
>  4.3.1.3 Specific requirements to the number of MSI-X interrupts
> -- 
> 1.7.7.6
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-pci" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html