wifi: mac80211: use bullet list for amsdu_mesh_control formats list
authorBagas Sanjaya <bagasdotme@gmail.com>
Thu, 23 Mar 2023 09:24:54 +0000 (16:24 +0700)
committerJohannes Berg <johannes.berg@intel.com>
Fri, 24 Mar 2023 09:56:23 +0000 (10:56 +0100)
Commit fe4a6d2db3ba ("wifi: mac80211: implement support for yet
another mesh A-MSDU format") expands amsdu_mesh_control list to
multi-line list. However, the expansion triggers Sphinx warning:

Documentation/driver-api/80211/mac80211-advanced:214: ./net/mac80211/sta_info.h:628: WARNING: Unexpected indentation.

Use bullet list instead to fix the warning.

Link: https://lore.kernel.org/linux-next/20230323141548.659479ef@canb.auug.org.au/
Fixes: fe4a6d2db3bad4 ("wifi: mac80211: implement support for yet another mesh A-MSDU format")
Reported-by: Stephen Rothwell <sfr@canb.auug.org.au>
Signed-off-by: Bagas Sanjaya <bagasdotme@gmail.com>
Reviewed-by: Simon Horman <simon.horman@corigine.com>
Signed-off-by: Johannes Berg <johannes.berg@intel.com>
net/mac80211/sta_info.h

index f354d470e1740c390b24580e5f766e201322ecc6..195b563132d6c5ffc156f61f56351a67a8ba968e 100644 (file)
@@ -622,11 +622,13 @@ struct link_sta_info {
  *     taken from HT/VHT capabilities or VHT operating mode notification
  * @cparams: CoDel parameters for this station.
  * @reserved_tid: reserved TID (if any, otherwise IEEE80211_TID_UNRESERVED)
- * @amsdu_mesh_control: track the mesh A-MSDU format used by the peer
- *     (-1: not yet known,
- *       0: non-mesh A-MSDU length field
- *       1: big-endian mesh A-MSDU length field
- *       2: little-endian mesh A-MSDU length field)
+ * @amsdu_mesh_control: track the mesh A-MSDU format used by the peer:
+ *
+ *       * -1: not yet known
+ *       * 0: non-mesh A-MSDU length field
+ *       * 1: big-endian mesh A-MSDU length field
+ *       * 2: little-endian mesh A-MSDU length field
+ *
  * @fast_tx: TX fastpath information
  * @fast_rx: RX fastpath information
  * @tdls_chandef: a TDLS peer can have a wider chandef that is compatible to