| Message ID | 20231208220945.20628-1-rdunlap@infradead.org |
|---|---|
| State | New |
| Headers | show |
| Series | wifi: iwlwifi: fw/dbg: fix all kernel-doc warnings | expand |
On Fri, Dec 08, 2023 at 02:09:45PM -0800, Randy Dunlap wrote: > kernel test robot reports: > drivers/net/wireless/intel/iwlwifi/fw/dbg.c:86: warning: Excess struct/union/enum/typedef member 'trans_len' description in 'iwl_fw_dump_ptrs' > > scripts/kernel-doc no longer emits the warning that is reported by > the 0-day kernel test robot, but the reported struct does contain the > Excess line, so remove that line as well as fix other kernel-doc > warnings in this source file: > > dbg.c:1732: warning: contents before sections > dbg.c:1736: warning: No description found for return value of 'mask_apply_and_normalize' > dbg.c:2202: warning: missing initial short description on line: > * iwl_dump_ini_mem > dbg.c:2207: warning: contents before sections > dbg.c:2215: warning: No description found for return value of 'iwl_dump_ini_mem' > > Signed-off-by: Randy Dunlap <rdunlap@infradead.org> > Reported-by: kernel test robot <lkp@intel.com> > Closes: https://lore.kernel.org/oe-kbuild-all/202311250305.tf8Cus1Y-lkp@intel.com/ > Closes: https://lore.kernel.org/oe-kbuild-all/202312060810.QT9zourt-lkp@intel.com/ > Cc: Gregory Greenman <gregory.greenman@intel.com> > Cc: Miri Korenblit <miriam.rachel.korenblit@intel.com> > Cc: linux-wireless@vger.kernel.org > Cc: Kalle Valo <kvalo@kernel.org> > Cc: Johannes Berg <johannes@sipsolutions.net> Thanks Randy, I'm unable to reproduce the "other warnings". But these changes do look good to me. Reviewed-by: Simon Horman <horms@kernel.org> ...
diff -- a/drivers/net/wireless/intel/iwlwifi/fw/dbg.c b/drivers/net/wireless/intel/iwlwifi/fw/dbg.c --- a/drivers/net/wireless/intel/iwlwifi/fw/dbg.c +++ b/drivers/net/wireless/intel/iwlwifi/fw/dbg.c @@ -19,7 +19,6 @@ * @fwrt_ptr: pointer to the buffer coming from fwrt * @trans_ptr: pointer to struct %iwl_trans_dump_data which contains the * transport's data. - * @trans_len: length of the valid data in trans_ptr * @fwrt_len: length of the valid data in fwrt_ptr */ struct iwl_fw_dump_ptrs { @@ -1726,12 +1725,13 @@ iwl_dump_ini_mem_fill_header(struct iwl_ } /** - * mask_apply_and_normalize - applies mask on val and normalize the result + * mask_apply_and_normalize - applies mask on val and normalizes the result + * @val: value + * @mask: mask to apply and to normalize with * * The normalization is based on the first set bit in the mask * - * @val: value - * @mask: mask to apply and to normalize with + * Returns: the masked, normalized value */ static u32 mask_apply_and_normalize(u32 val, u32 mask) { @@ -2200,15 +2200,15 @@ struct iwl_dump_ini_mem_ops { }; /** - * iwl_dump_ini_mem - * - * Creates a dump tlv and copy a memory region into it. - * Returns the size of the current dump tlv or 0 if failed - * + * iwl_dump_ini_mem - copy ini memory region to a dump tlv * @fwrt: fw runtime struct * @list: list to add the dump tlv to * @reg_data: memory region * @ops: memory dump operations + * + * Creates a dump tlv and copies a memory region into it. + * + * Returns: the size of the current dump tlv or %0 if failed */ static u32 iwl_dump_ini_mem(struct iwl_fw_runtime *fwrt, struct list_head *list, struct iwl_dump_ini_region_data *reg_data,
kernel test robot reports: drivers/net/wireless/intel/iwlwifi/fw/dbg.c:86: warning: Excess struct/union/enum/typedef member 'trans_len' description in 'iwl_fw_dump_ptrs' scripts/kernel-doc no longer emits the warning that is reported by the 0-day kernel test robot, but the reported struct does contain the Excess line, so remove that line as well as fix other kernel-doc warnings in this source file: dbg.c:1732: warning: contents before sections dbg.c:1736: warning: No description found for return value of 'mask_apply_and_normalize' dbg.c:2202: warning: missing initial short description on line: * iwl_dump_ini_mem dbg.c:2207: warning: contents before sections dbg.c:2215: warning: No description found for return value of 'iwl_dump_ini_mem' Signed-off-by: Randy Dunlap <rdunlap@infradead.org> Reported-by: kernel test robot <lkp@intel.com> Closes: https://lore.kernel.org/oe-kbuild-all/202311250305.tf8Cus1Y-lkp@intel.com/ Closes: https://lore.kernel.org/oe-kbuild-all/202312060810.QT9zourt-lkp@intel.com/ Cc: Gregory Greenman <gregory.greenman@intel.com> Cc: Miri Korenblit <miriam.rachel.korenblit@intel.com> Cc: linux-wireless@vger.kernel.org Cc: Kalle Valo <kvalo@kernel.org> Cc: Johannes Berg <johannes@sipsolutions.net> --- drivers/net/wireless/intel/iwlwifi/fw/dbg.c | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-)