Received-SPF: pass (google.com: domain of linux-wireless-owner@vger.kernel.org designates 23.128.96.36 as permitted sender) client-ip=23.128.96.36;
Message-ID: <ae8e358d-3d02-4167-9232-5da8a2ec3d1c@quicinc.com>
Date:   Thu, 28 Sep 2023 16:54:47 -0700
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
Subject: Re: [PATCH 08/18] wifi: mac80211: mesh: fix some kdoc warnings
Content-Language: en-US
To:     <gregory.greenman@intel.com>, <johannes@sipsolutions.net>
CC:     <linux-wireless@vger.kernel.org>,
        Benjamin Berg <benjamin.berg@intel.com>
References: <20230928143539.1037500-1-gregory.greenman@intel.com>
 <20230928172905.33fea2968c62.I41d197b570370ab7cad1405518512fdd36e08717@changeid>
From:   Jeff Johnson <quic_jjohnson@quicinc.com>
In-Reply-To: <20230928172905.33fea2968c62.I41d197b570370ab7cad1405518512fdd36e08717@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: Benjamin Berg <benjamin.berg@intel.com>
> 
> These were mostly missing or incorrectly tagged return values.
> 
> Signed-off-by: Benjamin Berg <benjamin.berg@intel.com>
> Signed-off-by: Gregory Greenman <gregory.greenman@intel.com>
> ---
>   net/mac80211/mesh.c         |  8 ++++++--
>   net/mac80211/mesh_hwmp.c    |  2 ++
>   net/mac80211/mesh_pathtbl.c | 20 +++++++++++++-------
>   net/mac80211/mesh_plink.c   |  6 +++++-
>   net/mac80211/mesh_ps.c      |  6 +++++-
>   net/mac80211/mesh_sync.c    |  4 +++-
>   6 files changed, 34 insertions(+), 12 deletions(-)
> 
> diff --git a/net/mac80211/mesh.c b/net/mac80211/mesh.c
> index 0d0fbae51b61..9b1fd43df6ef 100644
> --- a/net/mac80211/mesh.c
> +++ b/net/mac80211/mesh.c
> @@ -56,6 +56,8 @@ static void ieee80211_mesh_housekeeping_timer(struct timer_list *t)
>    *
>    * This function checks if the mesh configuration of a mesh point matches the
>    * local mesh configuration, i.e. if both nodes belong to the same mesh network.
> + *
> + * Returns: %true if both nodes belong to the same mesh

I thought kdoc used Return: not Returns:

<https://static.lwn.net/kerneldoc/doc-guide/kernel-doc.html#function-documentation>