diff mbox series

Kconfig label updates

Message ID 20190108223024.GA147017@google.com (mailing list archive)
State New, archived
Delegated to: Bjorn Helgaas
Headers show
Series Kconfig label updates | expand

Commit Message

Bjorn Helgaas Jan. 8, 2019, 10:30 p.m. UTC
Hi,

I want to update the PCI Kconfig labels so they're more consistent and
useful to users, something like the patch below.  IIUC, the items
below are all IBM-related; please correct me if not.

I'd also like to expand (or remove) "RPA" because Google doesn't find
anything about "IBM RPA", except Robotic Process Automation, which I
think must be something else.

Is there some text expansion of RPA that we could use that would be
meaningful to a user, i.e., something he/she might find on a nameplate
or in a user manual?

Ideally the PCI Kconfig labels would match the terms used in
arch/.../Kconfig, e.g.,

  config PPC_POWERNV
    bool "IBM PowerNV (Non-Virtualized) platform support"

  config PPC_PSERIES
    bool "IBM pSeries & new (POWER5-based) iSeries"

  config MARCH_Z900
    bool "IBM zSeries model z800 and z900"

  config MARCH_Z9_109
    bool "IBM System z9"

Bjorn

Comments

Oliver O'Halloran Jan. 9, 2019, 1 a.m. UTC | #1
On Wed, Jan 9, 2019 at 9:31 AM Bjorn Helgaas <helgaas@kernel.org> wrote:
>
> Hi,
>
> I want to update the PCI Kconfig labels so they're more consistent and
> useful to users, something like the patch below.  IIUC, the items
> below are all IBM-related; please correct me if not.
>
> I'd also like to expand (or remove) "RPA" because Google doesn't find
> anything about "IBM RPA", except Robotic Process Automation, which I
> think must be something else.
>
> Is there some text expansion of RPA that we could use that would be
> meaningful to a user, i.e., something he/she might find on a nameplate
> or in a user manual?

"RISC Platform Architecture" apparently. I couldn't find any
documentation written in the last decade that uses the term so it's
probably a hold-over from when pseries and iseries had separate
hardware platforms. Replacing "RPA" with "pseries" would be the least
confusing way to handle it.

> Ideally the PCI Kconfig labels would match the terms used in
> arch/.../Kconfig, e.g.,
>
>   config PPC_POWERNV
>     bool "IBM PowerNV (Non-Virtualized) platform support"
>
>   config PPC_PSERIES
>     bool "IBM pSeries & new (POWER5-based) iSeries"
>
>   config MARCH_Z900
>     bool "IBM zSeries model z800 and z900"
>
>   config MARCH_Z9_109
>     bool "IBM System z9"
>
> Bjorn
>
>
> diff --git a/drivers/pci/hotplug/Kconfig b/drivers/pci/hotplug/Kconfig
> index e9f78eb390d2..1c1d145bfd84 100644
> --- a/drivers/pci/hotplug/Kconfig
> +++ b/drivers/pci/hotplug/Kconfig
> @@ -112,7 +112,7 @@ config HOTPLUG_PCI_SHPC
>           When in doubt, say N.
>
>  config HOTPLUG_PCI_POWERNV
> -       tristate "PowerPC PowerNV PCI Hotplug driver"
> +       tristate "IBM PowerNV PCI Hotplug driver"
>         depends on PPC_POWERNV && EEH
>         select OF_DYNAMIC
>         help
> @@ -125,10 +125,11 @@ config HOTPLUG_PCI_POWERNV
>           When in doubt, say N.
>
>  config HOTPLUG_PCI_RPA
> -       tristate "RPA PCI Hotplug driver"
> +       tristate "IBM Power Systems RPA PCI Hotplug driver"
>         depends on PPC_PSERIES && EEH
>         help
>           Say Y here if you have a RPA system that supports PCI Hotplug.
> +         This includes the earlier pSeries and iSeries.
>
>           To compile this driver as a module, choose M here: the
>           module will be called rpaphp.
> @@ -136,7 +137,7 @@ config HOTPLUG_PCI_RPA
>           When in doubt, say N.
>
>  config HOTPLUG_PCI_RPA_DLPAR
> -       tristate "RPA Dynamic Logical Partitioning for I/O slots"
> +       tristate "IBM RPA Dynamic Logical Partitioning for I/O slots"
>         depends on HOTPLUG_PCI_RPA
>         help
>           Say Y here if your system supports Dynamic Logical Partitioning
> @@ -157,7 +158,7 @@ config HOTPLUG_PCI_SGI
>           When in doubt, say N.
>
>  config HOTPLUG_PCI_S390
> -       bool "System z PCI Hotplug Support"
> +       bool "IBM System z PCI Hotplug Support"
>         depends on S390 && 64BIT
>         help
>           Say Y here if you want to use the System z PCI Hotplug
Martin Schwidefsky Jan. 9, 2019, 8:35 a.m. UTC | #2
On Tue, 8 Jan 2019 16:30:24 -0600
Bjorn Helgaas <helgaas@kernel.org> wrote:

> Hi,
> 
> I want to update the PCI Kconfig labels so they're more consistent and
> useful to users, something like the patch below.  IIUC, the items
> below are all IBM-related; please correct me if not.
> 
> I'd also like to expand (or remove) "RPA" because Google doesn't find
> anything about "IBM RPA", except Robotic Process Automation, which I
> think must be something else.
> 
> Is there some text expansion of RPA that we could use that would be
> meaningful to a user, i.e., something he/she might find on a nameplate
> or in a user manual?
> 
> Ideally the PCI Kconfig labels would match the terms used in
> arch/.../Kconfig, e.g.,
> 
>   config PPC_POWERNV
>     bool "IBM PowerNV (Non-Virtualized) platform support"
> 
>   config PPC_PSERIES
>     bool "IBM pSeries & new (POWER5-based) iSeries"
> 
>   config MARCH_Z900
>     bool "IBM zSeries model z800 and z900"
> 
>   config MARCH_Z9_109
>     bool "IBM System z9"
> 
> Bjorn
> 
> 
> diff --git a/drivers/pci/hotplug/Kconfig b/drivers/pci/hotplug/Kconfig
> index e9f78eb390d2..1c1d145bfd84 100644
> --- a/drivers/pci/hotplug/Kconfig
> +++ b/drivers/pci/hotplug/Kconfig
> @@ -112,7 +112,7 @@ config HOTPLUG_PCI_SHPC
>  	  When in doubt, say N.
> 
>  config HOTPLUG_PCI_POWERNV
> -	tristate "PowerPC PowerNV PCI Hotplug driver"
> +	tristate "IBM PowerNV PCI Hotplug driver"
>  	depends on PPC_POWERNV && EEH
>  	select OF_DYNAMIC
>  	help
> @@ -125,10 +125,11 @@ config HOTPLUG_PCI_POWERNV
>  	  When in doubt, say N.
> 
>  config HOTPLUG_PCI_RPA
> -	tristate "RPA PCI Hotplug driver"
> +	tristate "IBM Power Systems RPA PCI Hotplug driver"
>  	depends on PPC_PSERIES && EEH
>  	help
>  	  Say Y here if you have a RPA system that supports PCI Hotplug.
> +	  This includes the earlier pSeries and iSeries.
> 
>  	  To compile this driver as a module, choose M here: the
>  	  module will be called rpaphp.
> @@ -136,7 +137,7 @@ config HOTPLUG_PCI_RPA
>  	  When in doubt, say N.
> 
>  config HOTPLUG_PCI_RPA_DLPAR
> -	tristate "RPA Dynamic Logical Partitioning for I/O slots"
> +	tristate "IBM RPA Dynamic Logical Partitioning for I/O slots"
>  	depends on HOTPLUG_PCI_RPA
>  	help
>  	  Say Y here if your system supports Dynamic Logical Partitioning
> @@ -157,7 +158,7 @@ config HOTPLUG_PCI_SGI
>  	  When in doubt, say N.
> 
>  config HOTPLUG_PCI_S390
> -	bool "System z PCI Hotplug Support"
> +	bool "IBM System z PCI Hotplug Support"
>  	depends on S390 && 64BIT
>  	help
>  	  Say Y here if you want to use the System z PCI Hotplug
> 

The rewording of the HOTPLUG_PCI_S390 entry is fine with me.
Acked-by: Martin Schwidefsky <schwidefsky@de.ibm.com>
Michael Ellerman Jan. 9, 2019, 12:37 p.m. UTC | #3
Hi Bjorn,

Bjorn Helgaas <helgaas@kernel.org> writes:
> Hi,
>
> I want to update the PCI Kconfig labels so they're more consistent and
> useful to users, something like the patch below.  IIUC, the items
> below are all IBM-related; please correct me if not.
>
> I'd also like to expand (or remove) "RPA" because Google doesn't find
> anything about "IBM RPA", except Robotic Process Automation, which I
> think must be something else.

Yeah I think just remove it, it's not a well known term and is unlikely
to help anyone these days.

It stands for "RISC Platform Architecture", which was some kind of
specification for Power machines back in the day, but from what I can
tell it was never used in marketing or manuals much (hence so few hits
on Google).

> Is there some text expansion of RPA that we could use that would be
> meaningful to a user, i.e., something he/she might find on a nameplate
> or in a user manual?

No I don't think so.

> Ideally the PCI Kconfig labels would match the terms used in
> arch/.../Kconfig, e.g.,
>
>   config PPC_POWERNV
>     bool "IBM PowerNV (Non-Virtualized) platform support"
>
>   config PPC_PSERIES
>     bool "IBM pSeries & new (POWER5-based) iSeries"

TBH these are pretty unhelpful too. PowerNV is not a marketing name and
so doesn't appear anywhere much in official manuals or brochures and
it's also used on non-IBM branded machines. And pSeries & iSeries were
marketing names but are no longer used.

We should probably update that text, but we can do that later, rather
than blocking this patch.

> diff --git a/drivers/pci/hotplug/Kconfig b/drivers/pci/hotplug/Kconfig
> index e9f78eb390d2..1c1d145bfd84 100644
> --- a/drivers/pci/hotplug/Kconfig
> +++ b/drivers/pci/hotplug/Kconfig
> @@ -112,7 +112,7 @@ config HOTPLUG_PCI_SHPC
>  	  When in doubt, say N.
>  
>  config HOTPLUG_PCI_POWERNV
> -	tristate "PowerPC PowerNV PCI Hotplug driver"
> +	tristate "IBM PowerNV PCI Hotplug driver"

This is used in non-IBM machines as well.

So perhaps: ?

	tristate "IBM/OpenPower PowerNV (bare metal) PCI Hotplug driver"

> @@ -125,10 +125,11 @@ config HOTPLUG_PCI_POWERNV
>  	  When in doubt, say N.
>  
>  config HOTPLUG_PCI_RPA
> -	tristate "RPA PCI Hotplug driver"
> +	tristate "IBM Power Systems RPA PCI Hotplug driver"

I think just drop RPA here.

>  	depends on PPC_PSERIES && EEH
>  	help
>  	  Say Y here if you have a RPA system that supports PCI Hotplug.

s/RPA/IBM Power Systems/

> +	  This includes the earlier pSeries and iSeries.

To be complete:
	  This includes the earlier System p, System i, pSeries and iSeries.

>  
>  	  To compile this driver as a module, choose M here: the
>  	  module will be called rpaphp.
> @@ -136,7 +137,7 @@ config HOTPLUG_PCI_RPA
>  	  When in doubt, say N.
>  
>  config HOTPLUG_PCI_RPA_DLPAR
> -	tristate "RPA Dynamic Logical Partitioning for I/O slots"
> +	tristate "IBM RPA Dynamic Logical Partitioning for I/O slots"

Again just drop RPA.


cheers
Tyrel Datwyler Jan. 10, 2019, 8:37 p.m. UTC | #4
On 01/09/2019 04:37 AM, Michael Ellerman wrote:
> Hi Bjorn,
> 
> Bjorn Helgaas <helgaas@kernel.org> writes:
>> Hi,
>>
>> I want to update the PCI Kconfig labels so they're more consistent and
>> useful to users, something like the patch below.  IIUC, the items
>> below are all IBM-related; please correct me if not.
>>
>> I'd also like to expand (or remove) "RPA" because Google doesn't find
>> anything about "IBM RPA", except Robotic Process Automation, which I
>> think must be something else.
> 
> Yeah I think just remove it, it's not a well known term and is unlikely
> to help anyone these days.
> 
> It stands for "RISC Platform Architecture", which was some kind of
> specification for Power machines back in the day, but from what I can
> tell it was never used in marketing or manuals much (hence so few hits
> on Google).

It is basically the predecessor to PAPR "Power Architecture Platform Reference".
Which the LoPAPR document is available through power.org. Not sure if there is
any desire to adopt PAPR in place of RPA. It is the platform reference doc that
outlines how we do DLPAR and PCI Hotplug.

> 
>> Is there some text expansion of RPA that we could use that would be
>> meaningful to a user, i.e., something he/she might find on a nameplate
>> or in a user manual?
> 
> No I don't think so.
> 
>> Ideally the PCI Kconfig labels would match the terms used in
>> arch/.../Kconfig, e.g.,
>>
>>   config PPC_POWERNV
>>     bool "IBM PowerNV (Non-Virtualized) platform support"
>>
>>   config PPC_PSERIES
>>     bool "IBM pSeries & new (POWER5-based) iSeries"
> 
> TBH these are pretty unhelpful too. PowerNV is not a marketing name and
> so doesn't appear anywhere much in official manuals or brochures and
> it's also used on non-IBM branded machines. And pSeries & iSeries were
> marketing names but are no longer used.

pseries is still used as a machine type for PAPR compliant qemu/kvm instances.

Again, just my 2 cents. I'm pretty open to whatever makes the most sense.

-Tyrel

> 
> We should probably update that text, but we can do that later, rather
> than blocking this patch.
> 
>> diff --git a/drivers/pci/hotplug/Kconfig b/drivers/pci/hotplug/Kconfig
>> index e9f78eb390d2..1c1d145bfd84 100644
>> --- a/drivers/pci/hotplug/Kconfig
>> +++ b/drivers/pci/hotplug/Kconfig
>> @@ -112,7 +112,7 @@ config HOTPLUG_PCI_SHPC
>>  	  When in doubt, say N.
>>  
>>  config HOTPLUG_PCI_POWERNV
>> -	tristate "PowerPC PowerNV PCI Hotplug driver"
>> +	tristate "IBM PowerNV PCI Hotplug driver"
> 
> This is used in non-IBM machines as well.
> 
> So perhaps: ?
> 
> 	tristate "IBM/OpenPower PowerNV (bare metal) PCI Hotplug driver"
> 
>> @@ -125,10 +125,11 @@ config HOTPLUG_PCI_POWERNV
>>  	  When in doubt, say N.
>>  
>>  config HOTPLUG_PCI_RPA
>> -	tristate "RPA PCI Hotplug driver"
>> +	tristate "IBM Power Systems RPA PCI Hotplug driver"
> 
> I think just drop RPA here.
> 
>>  	depends on PPC_PSERIES && EEH
>>  	help
>>  	  Say Y here if you have a RPA system that supports PCI Hotplug.
> 
> s/RPA/IBM Power Systems/
> 
>> +	  This includes the earlier pSeries and iSeries.
> 
> To be complete:
> 	  This includes the earlier System p, System i, pSeries and iSeries.
> 
>>  
>>  	  To compile this driver as a module, choose M here: the
>>  	  module will be called rpaphp.
>> @@ -136,7 +137,7 @@ config HOTPLUG_PCI_RPA
>>  	  When in doubt, say N.
>>  
>>  config HOTPLUG_PCI_RPA_DLPAR
>> -	tristate "RPA Dynamic Logical Partitioning for I/O slots"
>> +	tristate "IBM RPA Dynamic Logical Partitioning for I/O slots"
> 
> Again just drop RPA.
> 
> 
> cheers
>
Michael Ellerman Jan. 11, 2019, 6:06 a.m. UTC | #5
Tyrel Datwyler <tyreld@linux.vnet.ibm.com> writes:
> On 01/09/2019 04:37 AM, Michael Ellerman wrote:
>> Bjorn Helgaas <helgaas@kernel.org> writes:
>>> I want to update the PCI Kconfig labels so they're more consistent and
>>> useful to users, something like the patch below.  IIUC, the items
>>> below are all IBM-related; please correct me if not.
>>>
>>> I'd also like to expand (or remove) "RPA" because Google doesn't find
>>> anything about "IBM RPA", except Robotic Process Automation, which I
>>> think must be something else.
>> 
>> Yeah I think just remove it, it's not a well known term and is unlikely
>> to help anyone these days.
>> 
>> It stands for "RISC Platform Architecture", which was some kind of
>> specification for Power machines back in the day, but from what I can
>> tell it was never used in marketing or manuals much (hence so few hits
>> on Google).
>
> It is basically the predecessor to PAPR "Power Architecture Platform Reference".
> Which the LoPAPR document is available through power.org. Not sure if there is
> any desire to adopt PAPR in place of RPA. It is the platform reference doc that
> outlines how we do DLPAR and PCI Hotplug.

True. But a user is unlikely to know "PAPR" either, and it googles badly.

LoPAPR I guess is better, you can google for it, though I'm not entirely
sure if everything used by this code is actually in LoPAPR, because some
bits of PAPR were ripped out of LoPAPR.

>>> Ideally the PCI Kconfig labels would match the terms used in
>>> arch/.../Kconfig, e.g.,
>>>
>>>   config PPC_POWERNV
>>>     bool "IBM PowerNV (Non-Virtualized) platform support"
>>>
>>>   config PPC_PSERIES
>>>     bool "IBM pSeries & new (POWER5-based) iSeries"
>> 
>> TBH these are pretty unhelpful too. PowerNV is not a marketing name and
>> so doesn't appear anywhere much in official manuals or brochures and
>> it's also used on non-IBM branded machines. And pSeries & iSeries were
>> marketing names but are no longer used.
>
> pseries is still used as a machine type for PAPR compliant qemu/kvm instances.

Yeah so I guess it's helpful for someone configuring a kernel with that
in mind.

But if you've bought an IBM branded system the "pseries" name is not
used anywhere AFAIK.

cheers
Segher Boessenkool Jan. 11, 2019, 11:20 a.m. UTC | #6
On Fri, Jan 11, 2019 at 05:06:12PM +1100, Michael Ellerman wrote:
> Tyrel Datwyler <tyreld@linux.vnet.ibm.com> writes:
> > It is basically the predecessor to PAPR "Power Architecture Platform Reference".
> > Which the LoPAPR document is available through power.org. Not sure if there is
> > any desire to adopt PAPR in place of RPA. It is the platform reference doc that
> > outlines how we do DLPAR and PCI Hotplug.
> 
> True. But a user is unlikely to know "PAPR" either, and it googles badly.

Googling for "powerpc papr" works fine afais?  With a working link to a
pdf on the first page and all!


Segher
Michael Ellerman Jan. 14, 2019, 10:42 a.m. UTC | #7
Segher Boessenkool <segher@kernel.crashing.org> writes:

> On Fri, Jan 11, 2019 at 05:06:12PM +1100, Michael Ellerman wrote:
>> Tyrel Datwyler <tyreld@linux.vnet.ibm.com> writes:
>> > It is basically the predecessor to PAPR "Power Architecture Platform Reference".
>> > Which the LoPAPR document is available through power.org. Not sure if there is
>> > any desire to adopt PAPR in place of RPA. It is the platform reference doc that
>> > outlines how we do DLPAR and PCI Hotplug.
>> 
>> True. But a user is unlikely to know "PAPR" either, and it googles badly.
>
> Googling for "powerpc papr" works fine afais?  With a working link to a
> pdf on the first page and all!

True if you know to add "powerpc".

I only get a link to LoPAPR, which is similar but not identical. If
there's a link to PAPR then someone is in trouble :)

cheers
diff mbox series

Patch

diff --git a/drivers/pci/hotplug/Kconfig b/drivers/pci/hotplug/Kconfig
index e9f78eb390d2..1c1d145bfd84 100644
--- a/drivers/pci/hotplug/Kconfig
+++ b/drivers/pci/hotplug/Kconfig
@@ -112,7 +112,7 @@  config HOTPLUG_PCI_SHPC
 	  When in doubt, say N.
 
 config HOTPLUG_PCI_POWERNV
-	tristate "PowerPC PowerNV PCI Hotplug driver"
+	tristate "IBM PowerNV PCI Hotplug driver"
 	depends on PPC_POWERNV && EEH
 	select OF_DYNAMIC
 	help
@@ -125,10 +125,11 @@  config HOTPLUG_PCI_POWERNV
 	  When in doubt, say N.
 
 config HOTPLUG_PCI_RPA
-	tristate "RPA PCI Hotplug driver"
+	tristate "IBM Power Systems RPA PCI Hotplug driver"
 	depends on PPC_PSERIES && EEH
 	help
 	  Say Y here if you have a RPA system that supports PCI Hotplug.
+	  This includes the earlier pSeries and iSeries.
 
 	  To compile this driver as a module, choose M here: the
 	  module will be called rpaphp.
@@ -136,7 +137,7 @@  config HOTPLUG_PCI_RPA
 	  When in doubt, say N.
 
 config HOTPLUG_PCI_RPA_DLPAR
-	tristate "RPA Dynamic Logical Partitioning for I/O slots"
+	tristate "IBM RPA Dynamic Logical Partitioning for I/O slots"
 	depends on HOTPLUG_PCI_RPA
 	help
 	  Say Y here if your system supports Dynamic Logical Partitioning
@@ -157,7 +158,7 @@  config HOTPLUG_PCI_SGI
 	  When in doubt, say N.
 
 config HOTPLUG_PCI_S390
-	bool "System z PCI Hotplug Support"
+	bool "IBM System z PCI Hotplug Support"
 	depends on S390 && 64BIT
 	help
 	  Say Y here if you want to use the System z PCI Hotplug