| Message ID | 20250319-iwl_power_scheme-kdoc-v1-1-2033ae38b178@oss.qualcomm.com |
|---|---|
| State | New |
| Headers | show |
| Series | wifi: iwlwifi: Add short description to enum iwl_power_scheme | expand |
> -----Original Message----- > From: Jeff Johnson <jeff.johnson@oss.qualcomm.com> > Sent: Wednesday, 19 March 2025 16:38 > To: Korenblit, Miriam Rachel <miriam.rachel.korenblit@intel.com> > Cc: linux-wireless@vger.kernel.org; linux-kernel@vger.kernel.org; Jeff Johnson > <jeff.johnson@oss.qualcomm.com> > Subject: [PATCH] wifi: iwlwifi: Add short description to enum iwl_power_scheme > > The kernel-doc script flagged the following: > > drivers/net/wireless/intel/iwlwifi/mvm/mvm.h:130: warning: missing initial short > description on line: > * enum iwl_power_scheme > 1 warnings as Errors > > Add a short description to address this warning. > > Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com> > --- > drivers/net/wireless/intel/iwlwifi/mvm/mvm.h | 2 +- > 1 file changed, 1 insertion(+), 1 deletion(-) > > diff --git a/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h > b/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h > index f6391c7a3e29..59483fbaaab0 100644 > --- a/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h > +++ b/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h > @@ -126,7 +126,7 @@ struct iwl_mvm_time_event_data { > /* Power management */ > > /** > - * enum iwl_power_scheme > + * enum iwl_power_scheme - iwl power schemes > * @IWL_POWER_SCHEME_CAM: Continuously Active Mode > * @IWL_POWER_SCHEME_BPS: Balanced Power Save (default) > * @IWL_POWER_SCHEME_LP: Low Power > > --- > base-commit: 3fd552b2658eb6bf2a3b531553fe563340d37fdf > change-id: 20250319-iwl_power_scheme-kdoc-89cf83bd121a Acked-by: Miri Korenblit <miriam.rachel.korenblit@intel.com>
diff --git a/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h b/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h index f6391c7a3e29..59483fbaaab0 100644 --- a/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h +++ b/drivers/net/wireless/intel/iwlwifi/mvm/mvm.h @@ -126,7 +126,7 @@ struct iwl_mvm_time_event_data { /* Power management */ /** - * enum iwl_power_scheme + * enum iwl_power_scheme - iwl power schemes * @IWL_POWER_SCHEME_CAM: Continuously Active Mode * @IWL_POWER_SCHEME_BPS: Balanced Power Save (default) * @IWL_POWER_SCHEME_LP: Low Power
The kernel-doc script flagged the following: drivers/net/wireless/intel/iwlwifi/mvm/mvm.h:130: warning: missing initial short description on line: * enum iwl_power_scheme 1 warnings as Errors Add a short description to address this warning. Signed-off-by: Jeff Johnson <jeff.johnson@oss.qualcomm.com> --- drivers/net/wireless/intel/iwlwifi/mvm/mvm.h | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) --- base-commit: 3fd552b2658eb6bf2a3b531553fe563340d37fdf change-id: 20250319-iwl_power_scheme-kdoc-89cf83bd121a