| Message ID | 1434628020-4143-1-git-send-email-wangyijing@huawei.com (mailing list archive) |
|---|---|
| State | New, archived |
| Delegated to: | Bjorn Helgaas |
| Headers | show |
Hi Yijing, The subject should start with a verb, e.g., "Fix DocBook comments". On Thu, Jun 18, 2015 at 07:47:00PM +0800, Yijing Wang wrote: This needs a changelog, even if it's a trivial one. > Signed-off-by: Yijing Wang <wangyijing@huawei.com> > --- > drivers/pci/hotplug/pci_hotplug_core.c | 6 +++--- > 1 files changed, 3 insertions(+), 3 deletions(-) > > diff --git a/drivers/pci/hotplug/pci_hotplug_core.c b/drivers/pci/hotplug/pci_hotplug_core.c > index 56d8486..117c8f9 100644 > --- a/drivers/pci/hotplug/pci_hotplug_core.c > +++ b/drivers/pci/hotplug/pci_hotplug_core.c > @@ -408,8 +408,8 @@ static struct hotplug_slot *get_slot_from_name(const char *name) > > /** > * __pci_hp_register - register a hotplug_slot with the PCI hotplug subsystem > - * @bus: bus this slot is on > * @slot: pointer to the &struct hotplug_slot to register > + * @bus: bus this slot is on > * @devnr: device number > * @name: name registered with kobject core > * @owner: caller module owner > @@ -469,7 +469,7 @@ EXPORT_SYMBOL_GPL(__pci_hp_register); > * pci_hp_deregister - deregister a hotplug_slot with the PCI hotplug subsystem > * @hotplug: pointer to the &struct hotplug_slot to deregister > * > - * The @slot must have been registered with the pci hotplug subsystem > + * The @hotplug must have been registered with the pci hotplug subsystem This doesn't read like English because "hotplug" is not a noun. Please extend your patch so the entire file consistently uses "slot" for a struct hotplug_slot, and "pci_slot" for a struct pci_slot. Right now, the file is a mix of random names, which is confusing and leads to errors. You might need to do this with more than one patch to make it possible to review it. > * previously with a call to pci_hp_register(). > * > * Returns 0 if successful, anything else for an error. > @@ -509,7 +509,7 @@ EXPORT_SYMBOL_GPL(pci_hp_deregister); > * @hotplug: pointer to the slot whose info has changed > * @info: pointer to the info copy into the slot's info structure > * > - * @slot must have been registered with the pci > + * @hotplug must have been registered with the pci > * hotplug subsystem previously with a call to pci_hp_register(). > * > * Returns 0 if successful, anything else for an error. > -- > 1.7.1 > -- 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
On 2015/6/19 0:24, Bjorn Helgaas wrote: > Hi Yijing, > > The subject should start with a verb, e.g., "Fix DocBook comments". > > On Thu, Jun 18, 2015 at 07:47:00PM +0800, Yijing Wang wrote: > > This needs a changelog, even if it's a trivial one. OK. > >> Signed-off-by: Yijing Wang <wangyijing@huawei.com> >> --- >> drivers/pci/hotplug/pci_hotplug_core.c | 6 +++--- >> 1 files changed, 3 insertions(+), 3 deletions(-) >> >> diff --git a/drivers/pci/hotplug/pci_hotplug_core.c b/drivers/pci/hotplug/pci_hotplug_core.c >> index 56d8486..117c8f9 100644 >> --- a/drivers/pci/hotplug/pci_hotplug_core.c >> +++ b/drivers/pci/hotplug/pci_hotplug_core.c >> @@ -408,8 +408,8 @@ static struct hotplug_slot *get_slot_from_name(const char *name) >> >> /** >> * __pci_hp_register - register a hotplug_slot with the PCI hotplug subsystem >> - * @bus: bus this slot is on >> * @slot: pointer to the &struct hotplug_slot to register >> + * @bus: bus this slot is on >> * @devnr: device number >> * @name: name registered with kobject core >> * @owner: caller module owner >> @@ -469,7 +469,7 @@ EXPORT_SYMBOL_GPL(__pci_hp_register); >> * pci_hp_deregister - deregister a hotplug_slot with the PCI hotplug subsystem >> * @hotplug: pointer to the &struct hotplug_slot to deregister >> * >> - * The @slot must have been registered with the pci hotplug subsystem >> + * The @hotplug must have been registered with the pci hotplug subsystem > > This doesn't read like English because "hotplug" is not a noun. > > Please extend your patch so the entire file consistently uses "slot" for a > struct hotplug_slot, and "pci_slot" for a struct pci_slot. Right now, the > file is a mix of random names, which is confusing and leads to errors. > > You might need to do this with more than one patch to make it possible to > review it. I rework this patch and rename struct hotplug_slot to slot, and rename struct pci_slot to pci_slot, so we could distinguish them easily. Also I would update the comment in that patch. Thanks! Yijing. > >> * previously with a call to pci_hp_register(). >> * >> * Returns 0 if successful, anything else for an error. >> @@ -509,7 +509,7 @@ EXPORT_SYMBOL_GPL(pci_hp_deregister); >> * @hotplug: pointer to the slot whose info has changed >> * @info: pointer to the info copy into the slot's info structure >> * >> - * @slot must have been registered with the pci >> + * @hotplug must have been registered with the pci >> * hotplug subsystem previously with a call to pci_hp_register(). >> * >> * Returns 0 if successful, anything else for an error. >> -- >> 1.7.1 >> > >
diff --git a/drivers/pci/hotplug/pci_hotplug_core.c b/drivers/pci/hotplug/pci_hotplug_core.c index 56d8486..117c8f9 100644 --- a/drivers/pci/hotplug/pci_hotplug_core.c +++ b/drivers/pci/hotplug/pci_hotplug_core.c @@ -408,8 +408,8 @@ static struct hotplug_slot *get_slot_from_name(const char *name) /** * __pci_hp_register - register a hotplug_slot with the PCI hotplug subsystem - * @bus: bus this slot is on * @slot: pointer to the &struct hotplug_slot to register + * @bus: bus this slot is on * @devnr: device number * @name: name registered with kobject core * @owner: caller module owner @@ -469,7 +469,7 @@ EXPORT_SYMBOL_GPL(__pci_hp_register); * pci_hp_deregister - deregister a hotplug_slot with the PCI hotplug subsystem * @hotplug: pointer to the &struct hotplug_slot to deregister * - * The @slot must have been registered with the pci hotplug subsystem + * The @hotplug must have been registered with the pci hotplug subsystem * previously with a call to pci_hp_register(). * * Returns 0 if successful, anything else for an error. @@ -509,7 +509,7 @@ EXPORT_SYMBOL_GPL(pci_hp_deregister); * @hotplug: pointer to the slot whose info has changed * @info: pointer to the info copy into the slot's info structure * - * @slot must have been registered with the pci + * @hotplug must have been registered with the pci * hotplug subsystem previously with a call to pci_hp_register(). * * Returns 0 if successful, anything else for an error.
Signed-off-by: Yijing Wang <wangyijing@huawei.com> --- drivers/pci/hotplug/pci_hotplug_core.c | 6 +++--- 1 files changed, 3 insertions(+), 3 deletions(-)