[PATCH] Documentation: Add doc about aerdriver.* parameters to kernel-parameters.txt

[PATCH] Documentation: Add doc about aerdriver.* parameters to kernel-parameters.txt

[John Villalovos]

Adding documentation about two aerdriver.* command line parameters.

Signed-off-by: John L. Villalovos <john.l.villalovos@intel.com>

diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
index 1808f11..57ff168 100644
--- a/Documentation/kernel-parameters.txt
+++ b/Documentation/kernel-parameters.txt
@@ -293,6 +293,19 @@ and is between 256 and 4096 characters. It is defined in the file
 			Format: <io>,<irq>,<dma>,<mss_io>,<mpu_io>,<mpu_irq>
 			See also header of sound/oss/aedsp16.c.
 
+	aerdriver.forceload= [HW,PCIE] Advanced Error Recovery (AER) Root Driver
+			{ y, n }
+			y: Force the AER Root driver to load
+			n: Do not force the AER Root driver to load [DEFAULT]
+			See also Documentation/PCI/pcieaer-howto.txt
+
+	aerdriver.nosourceid= [HW,PCIE]
+			{ y, n }
+			y: Use when broken hardware (mostly chipsets) has root
+			   ports that cannot obtain the reporting source ID.
+			n: [DEFAULT]
+			See also Documentation/PCI/pcieaer-howto.txt
+
 	agp=		[AGP]
 			{ off | try_unsupported }
 			off: disable AGP support

Re: [PATCH] Documentation: Add doc about aerdriver.* parameters to kernel-parameters.txt

[Andrew Morton]

On Wed, 2 Jun 2010 11:27:22 -0400
John Villalovos <jvillalo@redhat.com> wrote:

> Adding documentation about two aerdriver.* command line parameters.
> 
> Signed-off-by: John L. Villalovos <john.l.villalovos@intel.com>
> 
> diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
> index 1808f11..57ff168 100644
> --- a/Documentation/kernel-parameters.txt
> +++ b/Documentation/kernel-parameters.txt
> @@ -293,6 +293,19 @@ and is between 256 and 4096 characters. It is defined in the file
>  			Format: <io>,<irq>,<dma>,<mss_io>,<mpu_io>,<mpu_irq>
>  			See also header of sound/oss/aedsp16.c.
>  
> +	aerdriver.forceload= [HW,PCIE] Advanced Error Recovery (AER) Root Driver
> +			{ y, n }
> +			y: Force the AER Root driver to load
> +			n: Do not force the AER Root driver to load [DEFAULT]
> +			See also Documentation/PCI/pcieaer-howto.txt
> +
> +	aerdriver.nosourceid= [HW,PCIE]
> +			{ y, n }
> +			y: Use when broken hardware (mostly chipsets) has root
> +			   ports that cannot obtain the reporting source ID.
> +			n: [DEFAULT]
> +			See also Documentation/PCI/pcieaer-howto.txt
> +
>  	agp=		[AGP]
>  			{ off | try_unsupported }
>  			off: disable AGP support

We don't normally document the parameters for random drivers within
kernel-parameters.txt - that file is more for core-kernel things.

The way to document these guys is with MODULE_PARM_DESC() in
drivers/pci/pcie/aer/aerdrv_core.c.  Coz some dope forgot to do that.

I'm sure there's some way of extracting all these random
MODULE_PARM_DESC()s from vmlinux/modules/etc for human consumption, but
I'm not sure what that way is.

Re: [PATCH] Documentation: Add doc about aerdriver.* parameters to kernel-parameters.txt

[Randy Dunlap]

Andrew Morton wrote:
> On Wed, 2 Jun 2010 11:27:22 -0400
> John Villalovos <jvillalo@redhat.com> wrote:
> 
>> Adding documentation about two aerdriver.* command line parameters.
>>
>> Signed-off-by: John L. Villalovos <john.l.villalovos@intel.com>
>>
>> diff --git a/Documentation/kernel-parameters.txt b/Documentation/kernel-parameters.txt
>> index 1808f11..57ff168 100644
>> --- a/Documentation/kernel-parameters.txt
>> +++ b/Documentation/kernel-parameters.txt
>> @@ -293,6 +293,19 @@ and is between 256 and 4096 characters. It is defined in the file
>>  			Format: <io>,<irq>,<dma>,<mss_io>,<mpu_io>,<mpu_irq>
>>  			See also header of sound/oss/aedsp16.c.
>>  
>> +	aerdriver.forceload= [HW,PCIE] Advanced Error Recovery (AER) Root Driver
>> +			{ y, n }
>> +			y: Force the AER Root driver to load
>> +			n: Do not force the AER Root driver to load [DEFAULT]
>> +			See also Documentation/PCI/pcieaer-howto.txt
>> +
>> +	aerdriver.nosourceid= [HW,PCIE]
>> +			{ y, n }
>> +			y: Use when broken hardware (mostly chipsets) has root
>> +			   ports that cannot obtain the reporting source ID.
>> +			n: [DEFAULT]
>> +			See also Documentation/PCI/pcieaer-howto.txt
>> +
>>  	agp=		[AGP]
>>  			{ off | try_unsupported }
>>  			off: disable AGP support
> 
> We don't normally document the parameters for random drivers within
> kernel-parameters.txt - that file is more for core-kernel things.
> 
> The way to document these guys is with MODULE_PARM_DESC() in
> drivers/pci/pcie/aer/aerdrv_core.c.  Coz some dope forgot to do that.
> 
> I'm sure there's some way of extracting all these random
> MODULE_PARM_DESC()s from vmlinux/modules/etc for human consumption, but
> I'm not sure what that way is.

modinfo <module.ko> does it for one binary module file.

I wrote a script a few years ago that runs 'modinfo *.ko' for all .ko files
that are found in a tree or scans all source files for MODULE_PARM_DESC().
I haven't tested it lately and I don't know of anything "official."

==> http://www.xenotime.net/linux/scripts/module-params

~Randy