nl80211: fix kernel-doc warning in the new SAE attribute
authorJohannes Berg <johannes.berg@intel.com>
Tue, 10 Nov 2020 08:49:11 +0000 (09:49 +0100)
committerJohannes Berg <johannes.berg@intel.com>
Wed, 11 Nov 2020 07:39:13 +0000 (08:39 +0100)
Format the items as a definition list, to avoid the warning
from the rst parsing.

Fixes: 9f0ffa418483 ("cfg80211: Add support to configure SAE PWE value to drivers")
Link: https://lore.kernel.org/r/20201110094911.bb020e863aa0.I960caf90e2a8cc23f6bf9245d77524df6a4d8f37@changeid
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
include/net/cfg80211.h

index 4ff804a8bc1d5a4b83690fca74e36f5f39bd4fe4..9678d32dae83b9e623c549e22a417cd458266e2c 100644 (file)
@@ -1008,14 +1008,21 @@ struct survey_info {
  * @sae_pwd: password for SAE authentication (for devices supporting SAE
  *     offload)
  * @sae_pwd_len: length of SAE password (for devices supporting SAE offload)
- * @sae_pwe: The mechanisms allowed for SAE PWE derivation
- *     NL80211_SAE_PWE_UNSPECIFIED: Not-specified, used to indicate userspace
- *             did not specify any preference. The driver should follow its
- *             internal policy in such a scenario.
- *     NL80211_SAE_PWE_HUNT_AND_PECK: Allow hunting-and-pecking loop only
- *     NL80211_SAE_PWE_HASH_TO_ELEMENT: Allow hash-to-element only
- *     NL80211_SAE_PWE_BOTH: Allow either hunting-and-pecking loop
- *             or hash-to-element
+ * @sae_pwe: The mechanisms allowed for SAE PWE derivation:
+ *
+ *     NL80211_SAE_PWE_UNSPECIFIED
+ *       Not-specified, used to indicate userspace did not specify any
+ *       preference. The driver should follow its internal policy in
+ *       such a scenario.
+ *
+ *     NL80211_SAE_PWE_HUNT_AND_PECK
+ *       Allow hunting-and-pecking loop only
+ *
+ *     NL80211_SAE_PWE_HASH_TO_ELEMENT
+ *       Allow hash-to-element only
+ *
+ *     NL80211_SAE_PWE_BOTH
+ *       Allow either hunting-and-pecking loop or hash-to-element
  */
 struct cfg80211_crypto_settings {
        u32 wpa_versions;