As part of my review of patches coming from the Qualcomm Innovation
Center I check to make sure that no checkpatch or kernel-doc issues
are introduced. An upcoming patch will propose a modification to
include/uapi/linux/nl80211.h. My review process flagged both
checkpatch and kernel-doc issues in the file, but these are
pre-existing issues. So this series fixes those pre-existing issues.
---
Jeff Johnson (3):
wifi: nl80211: rename enum plink_actions
wifi: nl80211: fix nl80211 uapi comment style issues
wifi: nl80211: cleanup nl80211.h kernel-doc
include/uapi/linux/nl80211.h | 236 +++++++++++++++++++++++--------------------
1 file changed, 124 insertions(+), 112 deletions(-)
---
base-commit: f8c0799b2428a2599a540b0ba1e180a6e3460699
change-id: 20240318-kdoc-nl80211-f61bef659055
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 <[email protected]>
---
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
On Tue, 2024-03-19 at 11:26 -0700, Jeff Johnson wrote:
> As part of my review of patches coming from the Qualcomm Innovation
> Center I check to make sure that no checkpatch or kernel-doc issues
> are introduced. An upcoming patch will propose a modification to
> include/uapi/linux/nl80211.h. My review process flagged both
> checkpatch and kernel-doc issues in the file, but these are
> pre-existing issues. So this series fixes those pre-existing issues.
>
Thanks Jeff.
Can you say what you're running for this? I've been running kernel-doc
and builds with W=1 for a long time, and not seen issues. Is this
perhaps checks from a newer kernel (we're currently on 6.8-rc1 for
$reasons)?
Thanks,
johannes
On 3/20/2024 12:07 AM, Johannes Berg wrote:
> On Tue, 2024-03-19 at 11:26 -0700, Jeff Johnson wrote:
>> As part of my review of patches coming from the Qualcomm Innovation
>> Center I check to make sure that no checkpatch or kernel-doc issues
>> are introduced. An upcoming patch will propose a modification to
>> include/uapi/linux/nl80211.h. My review process flagged both
>> checkpatch and kernel-doc issues in the file, but these are
>> pre-existing issues. So this series fixes those pre-existing issues.
>>
>
> Thanks Jeff.
>
> Can you say what you're running for this? I've been running kernel-doc
> and builds with W=1 for a long time, and not seen issues. Is this
> perhaps checks from a newer kernel (we're currently on 6.8-rc1 for
> $reasons)?
files=$(git diff --name-only $base HEAD)
scripts/kernel-doc -Werror -none $files
scripts/checkpatch.pl --file $files