linux-kernel - Re: [PATCH 09/10] cfg80211: align documentation style of ieee80211_iface

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [day] [month] [year] [list]

Message-ID: <35962489.2oEhloAINf@pc-42>
Date:   Fri, 21 Feb 2020 12:49:21 +0000
From:   Jérôme Pouiller <Jerome.Pouiller@...abs.com>
To:     Johannes Berg <johannes@...solutions.net>
CC:     "linux-wireless@...r.kernel.org" <linux-wireless@...r.kernel.org>,
        "netdev@...r.kernel.org" <netdev@...r.kernel.org>,
        "linux-kernel@...r.kernel.org" <linux-kernel@...r.kernel.org>,
        Jakub Kicinski <kuba@...nel.org>,
        "David S . Miller" <davem@...emloft.net>
Subject: Re: [PATCH 09/10] cfg80211: align documentation style of
 ieee80211_iface_combination

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:
> >
> > > > -      * = 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