Thread (14 messages) 14 messages, 2 authors, 2020-02-21

Re: [PATCH 09/10] cfg80211: align documentation style of ieee80211_iface_combination

From: Jérôme Pouiller <Jerome.Pouiller@silabs.com>
Date: 2020-02-21 12:49:28
Also in: linux-wireless, lkml

On Friday 21 February 2020 13:41:34 CET Johannes Berg wrote:
CAUTION: This email originated from outside of the organization. Do not click links or open attachments unless you recognize the sender and know the content is safe.


On Fri, 2020-02-21 at 12:38 +0000, Jérôme Pouiller wrote:
quoted
quoted
quoted
-      * = 0
-      *   all beacon intervals for different interface must be same.
-      * > 0
-      *   any beacon interval for the interface part of this combination AND
-      *   GCD of all beacon intervals from beaconing interfaces of this
-      *   combination must be greater or equal to this value.
This generates the nicer output, not with bullets but as a definition
list or something.
Indeed.

Unfortunately, I hasn't been able to use the same syntax in struct
description: if sphinx find a blank line, it considers that the rest of
the input is the long description of the struct.
So let's just leave it as is. I don't consider using the same style
(inline or header) everywhere to be even nearly as important as the
output :)
Ok.

Alternatively, the following syntax generate an output close to the
original:

    *   intervals:
    *       := 0: all beacon intervals for different interface must be same.
    *       :> 0: any beacon interval for the interface part of this
    *         combination AND GCD of all beacon intervals from beaconing
    *         interfaces of this combination must be greater or equal to this
    *         value.

-- 
Jérôme Pouiller
Keyboard shortcuts
hback out one level
jnext message in thread
kprevious message in thread
ldrill in
Escclose help / fold thread tree
?toggle this help