PCI: Correct the resource_alignment parameter example
diff mbox series

Message ID 20190606032557.107542-1-aik@ozlabs.ru
State Accepted
Delegated to: Bjorn Helgaas
Headers show
Series
  • PCI: Correct the resource_alignment parameter example
Related show

Commit Message

Alexey Kardashevskiy June 6, 2019, 3:25 a.m. UTC
The option description requires an order and so does the option
parsing code, however the example uses a size, fix this.

Fixes: 8b078c603249 ("PCI: Update "pci=resource_alignment" documentation")
Signed-off-by: Alexey Kardashevskiy <aik@ozlabs.ru>
---
 Documentation/admin-guide/kernel-parameters.txt | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

Comments

Alexey Kardashevskiy June 6, 2019, 4:38 a.m. UTC | #1
Argh, it should have had "PATCH" in the subject, I broke my scripts so
they run git format-patch --subject-prefix="". Sorry. Repost?


On 06/06/2019 13:25, Alexey Kardashevskiy wrote:
> The option description requires an order and so does the option
> parsing code, however the example uses a size, fix this.
> 
> Fixes: 8b078c603249 ("PCI: Update "pci=resource_alignment" documentation")
> Signed-off-by: Alexey Kardashevskiy <aik@ozlabs.ru>
> ---
>  Documentation/admin-guide/kernel-parameters.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 2b8ee90bb644..dcb53d64ad74 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -3340,27 +3340,28 @@
>  		resource_alignment=
>  				Format:
>  				[<order of align>@]<pci_dev>[; ...]
>  				Specifies alignment and device to reassign
>  				aligned memory resources. How to
>  				specify the device is described above.
>  				If <order of align> is not specified,
>  				PAGE_SIZE is used as alignment.
>  				PCI-PCI bridge can be specified, if resource
>  				windows need to be expanded.
>  				To specify the alignment for several
>  				instances of a device, the PCI vendor,
>  				device, subvendor, and subdevice may be
> -				specified, e.g., 4096@pci:8086:9c22:103c:198f
> +				specified, e.g., 12@pci:8086:9c22:103c:198f
> +				for the 4096 alignment.
>  		ecrc=		Enable/disable PCIe ECRC (transaction layer
>  				end-to-end CRC checking).
>  				bios: Use BIOS/firmware settings. This is the
>  				the default.
>  				off: Turn ECRC off
>  				on: Turn ECRC on.
>  		hpiosize=nn[KMG]	The fixed amount of bus space which is
>  				reserved for hotplug bridge's IO window.
>  				Default size is 256 bytes.
>  		hpmemsize=nn[KMG]	The fixed amount of bus space which is
>  				reserved for hotplug bridge's memory window.
>  				Default size is 2 megabytes.
>  		hpbussize=nn	The minimum amount of additional bus numbers
>
Bjorn Helgaas Aug. 8, 2019, 8:15 p.m. UTC | #2
On Thu, Jun 06, 2019 at 01:25:57PM +1000, Alexey Kardashevskiy wrote:
> The option description requires an order and so does the option
> parsing code, however the example uses a size, fix this.
> 
> Fixes: 8b078c603249 ("PCI: Update "pci=resource_alignment" documentation")
> Signed-off-by: Alexey Kardashevskiy <aik@ozlabs.ru>

Applied to pci/resource for v5.4, thanks!

> ---
>  Documentation/admin-guide/kernel-parameters.txt | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
> 
> diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
> index 2b8ee90bb644..dcb53d64ad74 100644
> --- a/Documentation/admin-guide/kernel-parameters.txt
> +++ b/Documentation/admin-guide/kernel-parameters.txt
> @@ -3340,27 +3340,28 @@
>  		resource_alignment=
>  				Format:
>  				[<order of align>@]<pci_dev>[; ...]
>  				Specifies alignment and device to reassign
>  				aligned memory resources. How to
>  				specify the device is described above.
>  				If <order of align> is not specified,
>  				PAGE_SIZE is used as alignment.
>  				PCI-PCI bridge can be specified, if resource
>  				windows need to be expanded.
>  				To specify the alignment for several
>  				instances of a device, the PCI vendor,
>  				device, subvendor, and subdevice may be
> -				specified, e.g., 4096@pci:8086:9c22:103c:198f
> +				specified, e.g., 12@pci:8086:9c22:103c:198f
> +				for the 4096 alignment.
>  		ecrc=		Enable/disable PCIe ECRC (transaction layer
>  				end-to-end CRC checking).
>  				bios: Use BIOS/firmware settings. This is the
>  				the default.
>  				off: Turn ECRC off
>  				on: Turn ECRC on.
>  		hpiosize=nn[KMG]	The fixed amount of bus space which is
>  				reserved for hotplug bridge's IO window.
>  				Default size is 256 bytes.
>  		hpmemsize=nn[KMG]	The fixed amount of bus space which is
>  				reserved for hotplug bridge's memory window.
>  				Default size is 2 megabytes.
>  		hpbussize=nn	The minimum amount of additional bus numbers
> -- 
> 2.17.1
>

Patch
diff mbox series

diff --git a/Documentation/admin-guide/kernel-parameters.txt b/Documentation/admin-guide/kernel-parameters.txt
index 2b8ee90bb644..dcb53d64ad74 100644
--- a/Documentation/admin-guide/kernel-parameters.txt
+++ b/Documentation/admin-guide/kernel-parameters.txt
@@ -3340,27 +3340,28 @@ 
 		resource_alignment=
 				Format:
 				[<order of align>@]<pci_dev>[; ...]
 				Specifies alignment and device to reassign
 				aligned memory resources. How to
 				specify the device is described above.
 				If <order of align> is not specified,
 				PAGE_SIZE is used as alignment.
 				PCI-PCI bridge can be specified, if resource
 				windows need to be expanded.
 				To specify the alignment for several
 				instances of a device, the PCI vendor,
 				device, subvendor, and subdevice may be
-				specified, e.g., 4096@pci:8086:9c22:103c:198f
+				specified, e.g., 12@pci:8086:9c22:103c:198f
+				for the 4096 alignment.
 		ecrc=		Enable/disable PCIe ECRC (transaction layer
 				end-to-end CRC checking).
 				bios: Use BIOS/firmware settings. This is the
 				the default.
 				off: Turn ECRC off
 				on: Turn ECRC on.
 		hpiosize=nn[KMG]	The fixed amount of bus space which is
 				reserved for hotplug bridge's IO window.
 				Default size is 256 bytes.
 		hpmemsize=nn[KMG]	The fixed amount of bus space which is
 				reserved for hotplug bridge's memory window.
 				Default size is 2 megabytes.
 		hpbussize=nn	The minimum amount of additional bus numbers