2023-09-28 15:27:29

by Greenman, Gregory

Subject: [PATCH 16/18] wifi: cfg80211: wext: convert return value to kernel-doc

From: Johannes Berg <[email protected]>

Since I'm getting a warning here right now, fix the
kernel-doc to be "Returns:" rather than just writing
that out in the doc paragraph.

Signed-off-by: Johannes Berg <[email protected]>
Signed-off-by: Gregory Greenman <[email protected]>
---
net/wireless/wext-compat.c | 4 ++--
1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/net/wireless/wext-compat.c b/net/wireless/wext-compat.c
index d23ce088bffa..2371069f3c43 100644
--- a/net/wireless/wext-compat.c
+++ b/net/wireless/wext-compat.c
@@ -7,7 +7,7 @@
* we directly assign the wireless handlers of wireless interfaces.
*
* Copyright 2008-2009 Johannes Berg <[email protected]>
- * Copyright (C) 2019-2022 Intel Corporation
+ * Copyright (C) 2019-2023 Intel Corporation
*/

#include <linux/export.h>
@@ -227,7 +227,7 @@ EXPORT_WEXT_HANDLER(cfg80211_wext_giwrange);
* cfg80211_wext_freq - get wext frequency for non-"auto"
* @freq: the wext freq encoding
*
- * Returns a frequency, or a negative error code, or 0 for auto.
+ * Returns: a frequency, or a negative error code, or 0 for auto.
*/
int cfg80211_wext_freq(struct iw_freq *freq)
{
--
2.38.1

2023-09-30 11:11:29

by Jeff Johnson

Subject: Re: [PATCH 16/18] wifi: cfg80211: wext: convert return value to kernel-doc

On 9/28/2023 7:35 AM, [email protected] wrote:
> From: Johannes Berg <[email protected]>
>
> Since I'm getting a warning here right now, fix the
> kernel-doc to be "Returns:" rather than just writing
> that out in the doc paragraph.
>
> Signed-off-by: Johannes Berg <[email protected]>
> Signed-off-by: Gregory Greenman <[email protected]>
> ---
> net/wireless/wext-compat.c | 4 ++--
> 1 file changed, 2 insertions(+), 2 deletions(-)
>
> diff --git a/net/wireless/wext-compat.c b/net/wireless/wext-compat.c
> index d23ce088bffa..2371069f3c43 100644
> --- a/net/wireless/wext-compat.c
> +++ b/net/wireless/wext-compat.c
> @@ -7,7 +7,7 @@
> * we directly assign the wireless handlers of wireless interfaces.
> *
> * Copyright 2008-2009 Johannes Berg <[email protected]>
> - * Copyright (C) 2019-2022 Intel Corporation
> + * Copyright (C) 2019-2023 Intel Corporation
> */
>
> #include <linux/export.h>
> @@ -227,7 +227,7 @@ EXPORT_WEXT_HANDLER(cfg80211_wext_giwrange);
> * cfg80211_wext_freq - get wext frequency for non-"auto"
> * @freq: the wext freq encoding
> *
> - * Returns a frequency, or a negative error code, or 0 for auto.
> + * Returns: a frequency, or a negative error code, or 0 for auto.

again, shouldn't this be Return:

> */
> int cfg80211_wext_freq(struct iw_freq *freq)
> {