Skip to contentSkip to conversation

rpadlpar_io:Add MODULE_DESCRIPTION entries to kernel modules

PATCH Applied Mamatha Inamdar 5 participants 7 messages Sep 24, 2020 – Feb 15, 2022

Subsystems (3)
lore
Share & tools
lore
#0 lore raw

PATCH 1/1 rpadlpar_io:Add MODULE_DESCRIPTION entries to kernel modules

This patch adds a brief MODULE_DESCRIPTION to rpadlpar_io kernel modules (descriptions taken from Kconfig file)

---
 drivers/pci/hotplug/rpadlpar_core.c |    1 +
 1 file changed, 1 insertion(+)
drivers/pci/hotplug/rpadlpar_core.c +1 -0
index f979b70..bac65ed 100644
@@ -478,3 +478,4 @@ static void __exit rpadlpar_io_exit(void)
 module_init(rpadlpar_io_init);
 module_exit(rpadlpar_io_exit);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("RPA Dynamic Logical Partitioning driver for I/O slots");
#1 lore raw
Quoted 14 lines · Mamatha Inamdar

This patch adds a brief MODULE_DESCRIPTION to rpadlpar_io kernel modules (descriptions taken from Kconfig file)

---
 drivers/pci/hotplug/rpadlpar_core.c |    1 +
 1 file changed, 1 insertion(+)
drivers/pci/hotplug/rpadlpar_core.c +0 -0
index f979b70..bac65ed 100644

drivers/pci/hotplug/rpadlpar_core.c static void __exit rpadlpar_io_exit(void) · line 481

Quoted 4 lines
drivers/pci/hotplug/rpadlpar_core.c +1 -0
@@ -478,3 +478,4 @@ static void __exit rpadlpar_io_exit(void)
 module_init(rpadlpar_io_init);
 module_exit(rpadlpar_io_exit);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("RPA Dynamic Logical Partitioning driver for I/O slots");

RPA as a spec was superseded by PAPR in the early 2000s. Can we rename this already?

The only potential problem I can see is scripts doing: modprobe rpadlpar_io or similar

However, we should be able to fix that with a module alias.

Oliver

#2 lore raw
Quoted 24 lines · Oliver O'Halloran
Quoted 14 lines · Mamatha Inamdar

This patch adds a brief MODULE_DESCRIPTION to rpadlpar_io kernel modules (descriptions taken from Kconfig file)

---
 drivers/pci/hotplug/rpadlpar_core.c |    1 +
 1 file changed, 1 insertion(+)
drivers/pci/hotplug/rpadlpar_core.c +0 -0
index f979b70..bac65ed 100644

drivers/pci/hotplug/rpadlpar_core.c static void __exit rpadlpar_io_exit(void) · line 481

Quoted 4 lines
drivers/pci/hotplug/rpadlpar_core.c +1 -0
@@ -478,3 +478,4 @@ static void __exit rpadlpar_io_exit(void)
 module_init(rpadlpar_io_init);
 module_exit(rpadlpar_io_exit);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("RPA Dynamic Logical Partitioning driver for I/O slots");

RPA as a spec was superseded by PAPR in the early 2000s. Can we rename this already?

Quoted 4 lines

The only potential problem I can see is scripts doing: modprobe rpadlpar_io or similar

However, we should be able to fix that with a module alias.

Is MODULE_DESCRIPTION() connected with how modprobe works?

If this patch just improves documentation, without breaking users of modprobe, I'm fine with it, even if it would be nice to rename to PAPR or something in the future.

But, please use "git log --oneline drivers/pci/hotplug/rpadlpar*" and match the style, and also look through the rest of drivers/pci/ to see if we should do the same thing to any other modules.

Bjorn

#3 lore raw
Quoted 26 lines · Bjorn Helgaas
Quoted 24 lines · Oliver O'Halloran
Quoted 14 lines · Mamatha Inamdar

This patch adds a brief MODULE_DESCRIPTION to rpadlpar_io kernel modules (descriptions taken from Kconfig file)

---
 drivers/pci/hotplug/rpadlpar_core.c |    1 +
 1 file changed, 1 insertion(+)
drivers/pci/hotplug/rpadlpar_core.c +0 -0
index f979b70..bac65ed 100644

drivers/pci/hotplug/rpadlpar_core.c static void __exit rpadlpar_io_exit(void) · line 481

Quoted 4 lines
drivers/pci/hotplug/rpadlpar_core.c +1 -0
@@ -478,3 +478,4 @@ static void __exit rpadlpar_io_exit(void)
 module_init(rpadlpar_io_init);
 module_exit(rpadlpar_io_exit);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("RPA Dynamic Logical Partitioning driver for I/O slots");

RPA as a spec was superseded by PAPR in the early 2000s. Can we rename this already?

Quoted 6 lines
Quoted 4 lines

The only potential problem I can see is scripts doing: modprobe rpadlpar_io or similar

However, we should be able to fix that with a module alias.

Is MODULE_DESCRIPTION() connected with how modprobe works?

I don't think so. The description is just there as an FYI.

Quoted 3 lines

If this patch just improves documentation, without breaking users of modprobe, I'm fine with it, even if it would be nice to rename to PAPR or something in the future.

Right, the change in this patch is just a documentation fix and shouldn't cause any problems.

I was suggesting renaming the module itself since the term "RPA" is only used in this hotplug driver and some of the corresponding PHB add / remove handling in arch/powerpc/platforms/pseries/. We can make that change in a follow up though.

Quoted 5 lines

But, please use "git log --oneline drivers/pci/hotplug/rpadlpar*" and match the style, and also look through the rest of drivers/pci/ to see if we should do the same thing to any other modules.

Bjorn

maintainer
#4 lore raw
In reply to Oliver O'Halloran
Quoted 11 lines · Oliver O'Halloran
Quoted 9 lines · Mamatha Inamdar

This patch adds a brief MODULE_DESCRIPTION to rpadlpar_io kernel modules (descriptions taken from Kconfig file)

---
 drivers/pci/hotplug/rpadlpar_core.c |    1 +
 1 file changed, 1 insertion(+)
Quoted 12 lines

drivers/pci/hotplug/rpadlpar_core.c static void __exit rpadlpar_io_exit(void) · line 481

Quoted 9 lines
drivers/pci/hotplug/rpadlpar_core.c +1 -0
index f979b70..bac65ed 100644
@@ -478,3 +478,4 @@ static void __exit rpadlpar_io_exit(void)
 module_init(rpadlpar_io_init);
 module_exit(rpadlpar_io_exit);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("RPA Dynamic Logical Partitioning driver for I/O slots");

RPA as a spec was superseded by PAPR in the early 2000s. Can we rename this already?

I seem to recall Michael and I discussed the naming briefly when I added the maintainer entries for the drivers and that the PAPR acronym is almost as meaningless to most as the original RPA. While, IBM no longer uses the term pseries for Power hardware marketing it is the defacto platform identifier in the Linux kernel tree for what we would call PAPR compliant. All in all I have no problem with renaming, but maybe we should consider pseries_dlpar or even simpler ibmdlpar.

Quoted 5 lines

The only potential problem I can see is scripts doing: modprobe rpadlpar_io or similar

However, we should be able to fix that with a module alias.

Agreed.

-Tyrel

Quoted 3 lines

Oliver

#5 lore raw
Quoted 26 lines · Tyrel Datwyler
Quoted 11 lines · Oliver O'Halloran
Quoted 9 lines · Mamatha Inamdar

This patch adds a brief MODULE_DESCRIPTION to rpadlpar_io kernel modules (descriptions taken from Kconfig file)

---
 drivers/pci/hotplug/rpadlpar_core.c |    1 +
 1 file changed, 1 insertion(+)
Quoted 12 lines

drivers/pci/hotplug/rpadlpar_core.c static void __exit rpadlpar_io_exit(void) · line 481

Quoted 9 lines
drivers/pci/hotplug/rpadlpar_core.c +1 -0
index f979b70..bac65ed 100644
@@ -478,3 +478,4 @@ static void __exit rpadlpar_io_exit(void)
 module_init(rpadlpar_io_init);
 module_exit(rpadlpar_io_exit);
 MODULE_LICENSE("GPL");
+MODULE_DESCRIPTION("RPA Dynamic Logical Partitioning driver for I/O slots");

RPA as a spec was superseded by PAPR in the early 2000s. Can we rename this already?

Quoted 7 lines

I seem to recall Michael and I discussed the naming briefly when I added the maintainer entries for the drivers and that the PAPR acronym is almost as meaningless to most as the original RPA. While, IBM no longer uses the term pseries for Power hardware marketing it is the defacto platform identifier in the Linux kernel tree for what we would call PAPR compliant. All in all I have no problem with renaming, but maybe we should consider pseries_dlpar or even simpler ibmdlpar.

I'm not too bothered by what we call it so long as it's consistent with *something* else in the tree. Using pseries rather than ibm as a prefix would probably be better since the legacy ibmphp driver is in the same directory.