Re: [PATCH] wifi: ath11k: document HAL_RX_BUF_RBM_SW4_BM

[Kalle Valo]

Jeff Johnson <quic_jjohnson@xxxxxxxxxxx> writes:

> On 1/26/2024 8:58 AM, Kalle Valo wrote:
>> Jeff Johnson <quic_jjohnson@xxxxxxxxxxx> writes:
>>> They have the same problem I'm trying to fix ;)
>>> % scripts/kernel-doc -Werror -none \
>>> 	$(find drivers/net/wireless/intel/iwlwifi -name '*.[ch]')
>>> ...
>>> 322 warnings as Errors
>>> %
>> 
>> Ouch. But I'm surprised why nobody has reported these before? Are the
>> kernel-doc warnings ignored by everyone?
>
> There are folks who use the kernel 'make' command to build the
> documentation, and report issues from that. But my understanding is that
> 'make' only processes the source files that are referenced by the
> kernel's .rst files. So if a source file has documentation, but that
> source file is not included by one of the .rst files, it won't normally
> be processed.
>
> It is only by running kernel-doc directly against the sources that you
> can spot these issues.

Ah, thanks for the explanation.

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

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