Re: [PATCH 01/29] iwlwifi: dvm: Demote non-compliant kernel-doc headers

From: Kalle Valo
Date: Thu Oct 08 2020 - 06:44:43 EST


Lee Jones <lee.jones@xxxxxxxxxx> wrote:

> None of these headers attempt to document any function parameters.
>
> Fixes the following W=1 kernel build warning(s):
>
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:388: warning: Function parameter or member 't' not described in 'iwl_bg_statistics_periodic'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:545: warning: Function parameter or member 't' not described in 'iwl_bg_ucode_trace'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:771: warning: Function parameter or member 'priv' not described in 'iwl_alive_start'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'priv' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'start_idx' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'num_events' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'mode' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'pos' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'buf' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1692: warning: Function parameter or member 'bufsz' not described in 'iwl_print_event_log'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'priv' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'capacity' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'num_wraps' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'next_entry' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'size' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'mode' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'pos' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'buf' not described in 'iwl_print_last_event_logs'
> drivers/net/wireless/intel/iwlwifi/dvm/main.c:1772: warning: Function parameter or member 'bufsz' not described in 'iwl_print_last_event_logs'
>
> Cc: Johannes Berg <johannes.berg@xxxxxxxxx>
> Cc: Emmanuel Grumbach <emmanuel.grumbach@xxxxxxxxx>
> Cc: Luca Coelho <luciano.coelho@xxxxxxxxx>
> Cc: Intel Linux Wireless <linuxwifi@xxxxxxxxx>
> Cc: Kalle Valo <kvalo@xxxxxxxxxxxxxx>
> Cc: "David S. Miller" <davem@xxxxxxxxxxxxx>
> Cc: Jakub Kicinski <kuba@xxxxxxxxxx>
> Cc: linux-wireless@xxxxxxxxxxxxxxx
> Cc: netdev@xxxxxxxxxxxxxxx
> Signed-off-by: Lee Jones <lee.jones@xxxxxxxxxx>

14 patches applied to wireless-drivers-next.git, thanks.

7cb391ffdf3c iwlwifi: dvm: Demote non-compliant kernel-doc headers
b392eabc6abe iwlwifi: rs: Demote non-compliant kernel-doc headers
229b5582deb5 iwlwifi: dvm: tx: Demote non-compliant kernel-doc headers
c8a11a84671e iwlwifi: dvm: lib: Demote non-compliant kernel-doc headers
7619ccceae49 iwlwifi: calib: Demote seemingly unintentional kerneldoc header
8f7ed7bf1384 iwlwifi: dvm: sta: Demote a bunch of nonconformant kernel-doc headers
707c528a8d51 iwlwifi: mvm: ops: Remove unused static struct 'iwl_mvm_debug_names'
108285ec6851 iwlwifi: dvm: Demote a couple of nonconformant kernel-doc headers
7b37b874fce3 iwlwifi: mvm: utils: Fix some doc-rot
de00105cf0dc iwlwifi: dvm: scan: Demote a few nonconformant kernel-doc headers
3a7d806926bb iwlwifi: dvm: rxon: Demote non-conformant kernel-doc headers
91b4780fbae7 iwlwifi: mvm: tx: Demote misuse of kernel-doc headers
6806fc7fcfb2 iwlwifi: dvm: devices: Fix function documentation formatting issues
7d4ced86997f iwlwifi: iwl-drv: Provide descriptions debugfs dentries

--
https://patchwork.kernel.org/patch/11766851/

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