linux-wireless.vger.kernel.org archive mirror
 help / color / mirror / Atom feed
From: Jeff Johnson <quic_jjohnson@quicinc.com>
To: Johannes Berg <johannes@sipsolutions.net>
Cc: <linux-wireless@vger.kernel.org>, <linux-kernel@vger.kernel.org>,
	"Jeff Johnson" <quic_jjohnson@quicinc.com>
Subject: [PATCH 1/3] wifi: nl80211: rename enum plink_actions
Date: Tue, 19 Mar 2024 11:26:23 -0700	[thread overview]
Message-ID: <20240319-kdoc-nl80211-v1-1-549e09d52866@quicinc.com> (raw)
In-Reply-To: <20240319-kdoc-nl80211-v1-0-549e09d52866@quicinc.com>

kernel-doc flagged the following issue:
include/uapi/linux/nl80211.h:6081: warning: expecting prototype for enum nl80211_plink_action. Prototype was for enum plink_actions instead

This is because the documentation doesn't match the code. Normally the
correct fix for such an issue is to modify the documentation to match
the code. However, in this case, since the actual name plink_actions
is not referenced by any code, rename it to nl80211_plink_action to
give it a proper prefix and match the documentation.

Signed-off-by: Jeff Johnson <quic_jjohnson@quicinc.com>
---
 include/uapi/linux/nl80211.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

diff --git a/include/uapi/linux/nl80211.h b/include/uapi/linux/nl80211.h
index f23ecbdd84a2..9397c61a48dc 100644
--- a/include/uapi/linux/nl80211.h
+++ b/include/uapi/linux/nl80211.h
@@ -6077,7 +6077,7 @@ enum nl80211_plink_state {
  * @NL80211_PLINK_ACTION_BLOCK: block traffic from this mesh peer
  * @NUM_NL80211_PLINK_ACTIONS: number of possible actions
  */
-enum plink_actions {
+enum nl80211_plink_action {
 	NL80211_PLINK_ACTION_NO_ACTION,
 	NL80211_PLINK_ACTION_OPEN,
 	NL80211_PLINK_ACTION_BLOCK,

-- 
2.42.0


  reply	other threads:[~2024-03-19 18:26 UTC|newest]

Thread overview: 8+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2024-03-19 18:26 [PATCH 0/3] wifi: nl80211: fix nl80211 UAPI kernel-doc Jeff Johnson
2024-03-19 18:26 ` Jeff Johnson [this message]
2024-03-19 18:26 ` [PATCH 2/3] wifi: nl80211: fix nl80211 uapi comment style issues Jeff Johnson
2024-03-19 18:26 ` [PATCH 3/3] wifi: nl80211: cleanup nl80211.h kernel-doc Jeff Johnson
2024-03-20  7:07 ` [PATCH 0/3] wifi: nl80211: fix nl80211 UAPI kernel-doc Johannes Berg
2024-03-20  9:18   ` Kalle Valo
2024-03-20 17:16   ` Jeff Johnson
2024-03-25 15:16     ` Kalle Valo

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=20240319-kdoc-nl80211-v1-1-549e09d52866@quicinc.com \
    --to=quic_jjohnson@quicinc.com \
    --cc=johannes@sipsolutions.net \
    --cc=linux-kernel@vger.kernel.org \
    --cc=linux-wireless@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).