Re: [PATCH 0/3] wifi: nl80211: fix nl80211 UAPI kernel-doc

[Kalle Valo]

Jeff Johnson <quic_jjohnson@xxxxxxxxxxx> writes:

> 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

Thanks. So my plan is to run this in my check script:

scripts/kernel-doc -none \
include/linux/ieee80211.h \
include/net/cfg80211.h \
include/net/ieee80211_radiotap.h \
include/net/iw_handler.h \
include/net/wext.h \
include/uapi/linux/nl80211.h \
include/uapi/linux/wireless.h \
include/net/mac80211.h \
include/linux/rfkill.h \
include/uapi/linux/rfkill.h

Did I miss anything important?

Although include/linux/rfkill.h has three warnings:

include/linux/rfkill.h:104: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * rfkill_pause_polling(struct rfkill *rfkill)
include/linux/rfkill.h:114: warning: This comment starts with '/**', but isn't a kernel-doc comment. Refer Documentation/doc-guide/kernel-doc.rst
 * rfkill_resume_polling(struct rfkill *rfkill)
include/linux/rfkill.h:331: warning: Function parameter or struct member 'rfkill' not described in 'rfkill_get_led_trigger_name'

Any volunteers to fix those? :)

-- 
https://patchwork.kernel.org/project/linux-wireless/list/

https://wireless.wiki.kernel.org/en/developers/documentation/submittingpatches