diff mbox series

[2/4] PCI/AER: Correct function names in the header

Message ID 20210325075144.180030-3-wangxiongfeng2@huawei.com (mailing list archive)
State Changes Requested, archived
Headers show
Series PCI: Correct function names in the header | expand

Commit Message

Xiongfeng Wang March 25, 2021, 7:51 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/pci/pcie/aer.c:138: warning: expecting prototype for enable_ercr_checking(). Prototype was for enable_ecrc_checking() instead
 drivers/pci/pcie/aer.c:162: warning: expecting prototype for disable_ercr_checking(). Prototype was for disable_ecrc_checking() instead
 drivers/pci/pcie/aer.c:1450: warning: expecting prototype for aer_service_init(). Prototype was for pcie_aer_init() instead

Reported-by: Hulk Robot <hulkci@huawei.com>
Signed-off-by: Xiongfeng Wang <wangxiongfeng2@huawei.com>
---
 drivers/pci/pcie/aer.c | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

Comments

Rafael J. Wysocki March 25, 2021, 5:30 p.m. UTC | #1
On Thu, Mar 25, 2021 at 8:50 AM Xiongfeng Wang
<wangxiongfeng2@huawei.com> wrote:
>
> Fixes the following W=1 kernel build warning(s):
>
>  drivers/pci/pcie/aer.c:138: warning: expecting prototype for enable_ercr_checking(). Prototype was for enable_ecrc_checking() instead
>  drivers/pci/pcie/aer.c:162: warning: expecting prototype for disable_ercr_checking(). Prototype was for disable_ecrc_checking() instead
>  drivers/pci/pcie/aer.c:1450: warning: expecting prototype for aer_service_init(). Prototype was for pcie_aer_init() instead
>
> Reported-by: Hulk Robot <hulkci@huawei.com>
> Signed-off-by: Xiongfeng Wang <wangxiongfeng2@huawei.com>

The subject is somewhat inaccurate, because you're fixing function
names in kerneldoc comments.

If you say "a header", people may think that this is about a header file.

> ---
>  drivers/pci/pcie/aer.c | 6 +++---
>  1 file changed, 3 insertions(+), 3 deletions(-)
>
> diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c
> index ba22388342d1..ec943cee5ecc 100644
> --- a/drivers/pci/pcie/aer.c
> +++ b/drivers/pci/pcie/aer.c
> @@ -129,7 +129,7 @@ static const char * const ecrc_policy_str[] = {
>  };
>
>  /**
> - * enable_ercr_checking - enable PCIe ECRC checking for a device
> + * enable_ecrc_checking - enable PCIe ECRC checking for a device
>   * @dev: the PCI device
>   *
>   * Returns 0 on success, or negative on failure.
> @@ -153,7 +153,7 @@ static int enable_ecrc_checking(struct pci_dev *dev)
>  }
>
>  /**
> - * disable_ercr_checking - disables PCIe ECRC checking for a device
> + * disable_ecrc_checking - disables PCIe ECRC checking for a device
>   * @dev: the PCI device
>   *
>   * Returns 0 on success, or negative on failure.
> @@ -1442,7 +1442,7 @@ static struct pcie_port_service_driver aerdriver = {
>  };
>
>  /**
> - * aer_service_init - register AER root service driver
> + * pcie_aer_init - register AER root service driver
>   *
>   * Invoked when AER root service driver is loaded.
>   */
> --
> 2.20.1
>
Xiongfeng Wang March 26, 2021, 12:58 a.m. UTC | #2
Hi Rafael,

On 2021/3/26 1:30, Rafael J. Wysocki wrote:
> On Thu, Mar 25, 2021 at 8:50 AM Xiongfeng Wang
> <wangxiongfeng2@huawei.com> wrote:
>>
>> Fixes the following W=1 kernel build warning(s):
>>
>>  drivers/pci/pcie/aer.c:138: warning: expecting prototype for enable_ercr_checking(). Prototype was for enable_ecrc_checking() instead
>>  drivers/pci/pcie/aer.c:162: warning: expecting prototype for disable_ercr_checking(). Prototype was for disable_ecrc_checking() instead
>>  drivers/pci/pcie/aer.c:1450: warning: expecting prototype for aer_service_init(). Prototype was for pcie_aer_init() instead
>>
>> Reported-by: Hulk Robot <hulkci@huawei.com>
>> Signed-off-by: Xiongfeng Wang <wangxiongfeng2@huawei.com>
> 
> The subject is somewhat inaccurate, because you're fixing function
> names in kerneldoc comments.
> 
> If you say "a header", people may think that this is about a header file.

Thanks a lot ! I will change it in the next version.

Thanks,
Xiongfeng

> 
>> ---
>>  drivers/pci/pcie/aer.c | 6 +++---
>>  1 file changed, 3 insertions(+), 3 deletions(-)
>>
>> diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c
>> index ba22388342d1..ec943cee5ecc 100644
>> --- a/drivers/pci/pcie/aer.c
>> +++ b/drivers/pci/pcie/aer.c
>> @@ -129,7 +129,7 @@ static const char * const ecrc_policy_str[] = {
>>  };
>>
>>  /**
>> - * enable_ercr_checking - enable PCIe ECRC checking for a device
>> + * enable_ecrc_checking - enable PCIe ECRC checking for a device
>>   * @dev: the PCI device
>>   *
>>   * Returns 0 on success, or negative on failure.
>> @@ -153,7 +153,7 @@ static int enable_ecrc_checking(struct pci_dev *dev)
>>  }
>>
>>  /**
>> - * disable_ercr_checking - disables PCIe ECRC checking for a device
>> + * disable_ecrc_checking - disables PCIe ECRC checking for a device
>>   * @dev: the PCI device
>>   *
>>   * Returns 0 on success, or negative on failure.
>> @@ -1442,7 +1442,7 @@ static struct pcie_port_service_driver aerdriver = {
>>  };
>>
>>  /**
>> - * aer_service_init - register AER root service driver
>> + * pcie_aer_init - register AER root service driver
>>   *
>>   * Invoked when AER root service driver is loaded.
>>   */
>> --
>> 2.20.1
>>
> .
>
diff mbox series

Patch

diff --git a/drivers/pci/pcie/aer.c b/drivers/pci/pcie/aer.c
index ba22388342d1..ec943cee5ecc 100644
--- a/drivers/pci/pcie/aer.c
+++ b/drivers/pci/pcie/aer.c
@@ -129,7 +129,7 @@  static const char * const ecrc_policy_str[] = {
 };
 
 /**
- * enable_ercr_checking - enable PCIe ECRC checking for a device
+ * enable_ecrc_checking - enable PCIe ECRC checking for a device
  * @dev: the PCI device
  *
  * Returns 0 on success, or negative on failure.
@@ -153,7 +153,7 @@  static int enable_ecrc_checking(struct pci_dev *dev)
 }
 
 /**
- * disable_ercr_checking - disables PCIe ECRC checking for a device
+ * disable_ecrc_checking - disables PCIe ECRC checking for a device
  * @dev: the PCI device
  *
  * Returns 0 on success, or negative on failure.
@@ -1442,7 +1442,7 @@  static struct pcie_port_service_driver aerdriver = {
 };
 
 /**
- * aer_service_init - register AER root service driver
+ * pcie_aer_init - register AER root service driver
  *
  * Invoked when AER root service driver is loaded.
  */