Received-SPF: pass (google.com: domain of linux-wireless-owner@vger.kernel.org designates 2620:137:e000::3:6 as permitted sender) client-ip=2620:137:e000::3:6;
Message-ID: <7877b596-6124-4028-8293-147a66a51ebf@quicinc.com>
Date:   Thu, 28 Sep 2023 17:00:53 -0700
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 16/18] wifi: cfg80211: wext: convert return value to
 kernel-doc
Content-Language: en-US
To:     <gregory.greenman@intel.com>, <johannes@sipsolutions.net>
CC:     <linux-wireless@vger.kernel.org>,
        Johannes Berg <johannes.berg@intel.com>
References: <20230928143539.1037500-1-gregory.greenman@intel.com>
 <20230928172905.ab3b9274bf07.If263f9f6726d6ad4661f8603e6a4485e0385d67f@changeid>
From:   Jeff Johnson <quic_jjohnson@quicinc.com>
In-Reply-To: <20230928172905.ab3b9274bf07.If263f9f6726d6ad4661f8603e6a4485e0385d67f@changeid>
Content-Type: text/plain; charset="UTF-8"; format=flowed
Content-Transfer-Encoding: 7bit
Precedence: bulk

On 9/28/2023 7:35 AM, gregory.greenman@intel.com wrote:
> From: Johannes Berg <johannes.berg@intel.com>
> 
> 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 <johannes.berg@intel.com>
> Signed-off-by: Gregory Greenman <gregory.greenman@intel.com>
> ---
>   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 <johannes@sipsolutions.net>
> - * 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)
>   {