[07/34] net: cadence: macb_ptp: Demote non-compliant kernel-doc headers
diff mbox series

Message ID 1621076039-53986-8-git-send-email-shenyang39@huawei.com
State New, archived
Headers show
Series
  • Rid W=1 warnings in net
Related show

Commit Message

Yang Shen May 15, 2021, 10:53 a.m. UTC
Fixes the following W=1 kernel build warning(s):

 drivers/net/ethernet/cadence/macb_ptp.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst

Cc: Nicolas Ferre <nicolas.ferre@microchip.com>
Cc: Claudiu Beznea <claudiu.beznea@microchip.com>
Signed-off-by: Yang Shen <shenyang39@huawei.com>
---
 drivers/net/ethernet/cadence/macb_ptp.c | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Nicolas Ferre May 15, 2021, 12:46 p.m. UTC | #1
On 15/05/2021 at 12:53, Yang Shen wrote:
> Fixes the following W=1 kernel build warning(s):
> 
>   drivers/net/ethernet/cadence/macb_ptp.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
> 
> Cc: Nicolas Ferre <nicolas.ferre@microchip.com>

Ok, if it raises a warning.

But I would prefer that you add drivers/net/ethernet/cadence/macb_pci.c 
with same change to a combined patch.

Regards,
   Nicolas


> Cc: Claudiu Beznea <claudiu.beznea@microchip.com>
> Signed-off-by: Yang Shen <shenyang39@huawei.com>
> ---
>   drivers/net/ethernet/cadence/macb_ptp.c | 2 +-
>   1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/drivers/net/ethernet/cadence/macb_ptp.c b/drivers/net/ethernet/cadence/macb_ptp.c
> index 283918a..5c368a9 100644
> --- a/drivers/net/ethernet/cadence/macb_ptp.c
> +++ b/drivers/net/ethernet/cadence/macb_ptp.c
> @@ -1,5 +1,5 @@
>   // SPDX-License-Identifier: GPL-2.0-only
> -/**
> +/*
>    * 1588 PTP support for Cadence GEM device.
>    *
>    * Copyright (C) 2017 Cadence Design Systems - https://www.cadence.com
> --
> 2.7.4
>
Yang Shen May 17, 2021, 1:48 a.m. UTC | #2
On 2021/5/15 20:46, Nicolas.Ferre@microchip.com wrote:
> On 15/05/2021 at 12:53, Yang Shen wrote:
>> Fixes the following W=1 kernel build warning(s):
>>
>>   drivers/net/ethernet/cadence/macb_ptp.c:3: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
>>
>> Cc: Nicolas Ferre <nicolas.ferre@microchip.com>
>
> Ok, if it raises a warning.
>
> But I would prefer that you add drivers/net/ethernet/cadence/macb_pci.c
> with same change to a combined patch.
>
> Regards,
>    Nicolas
>

OKļ¼ŒThe compiler missed this warning at 
drivers/net/ethernet/cadence/macb_pci.c.
I'll fix this in the next version.

Thanks,
     Yang

>
>> Cc: Claudiu Beznea <claudiu.beznea@microchip.com>
>> Signed-off-by: Yang Shen <shenyang39@huawei.com>
>> ---
>>   drivers/net/ethernet/cadence/macb_ptp.c | 2 +-
>>   1 file changed, 1 insertion(+), 1 deletion(-)
>>
>> diff --git a/drivers/net/ethernet/cadence/macb_ptp.c b/drivers/net/ethernet/cadence/macb_ptp.c
>> index 283918a..5c368a9 100644
>> --- a/drivers/net/ethernet/cadence/macb_ptp.c
>> +++ b/drivers/net/ethernet/cadence/macb_ptp.c
>> @@ -1,5 +1,5 @@
>>   // SPDX-License-Identifier: GPL-2.0-only
>> -/**
>> +/*
>>    * 1588 PTP support for Cadence GEM device.
>>    *
>>    * Copyright (C) 2017 Cadence Design Systems - https://www.cadence.com
>> --
>> 2.7.4
>>
>
>

Patch
diff mbox series

diff --git a/drivers/net/ethernet/cadence/macb_ptp.c b/drivers/net/ethernet/cadence/macb_ptp.c
index 283918a..5c368a9 100644
--- a/drivers/net/ethernet/cadence/macb_ptp.c
+++ b/drivers/net/ethernet/cadence/macb_ptp.c
@@ -1,5 +1,5 @@ 
 // SPDX-License-Identifier: GPL-2.0-only
-/**
+/*
  * 1588 PTP support for Cadence GEM device.
  *
  * Copyright (C) 2017 Cadence Design Systems - https://www.cadence.com