netdev - Re: [RFC Draft PATCH net-next 0/1] Bridge doc update

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 for Android: free password hash cracker in your pocket

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

Message-ID: <ZQq5NDqPAbwi98yU@Laptop-X1>
Date: Wed, 20 Sep 2023 17:19:48 +0800
From: Hangbin Liu <liuhangbin@...il.com>
To: Nikolay Aleksandrov <razor@...ckwall.org>,
	Roopa Prabhu <roopa@...dia.com>
Cc: "David S . Miller" <davem@...emloft.net>, netdev@...r.kernel.org,
	David Ahern <dsahern@...nel.org>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
	Ido Schimmel <idosch@...sch.org>,
	Stephen Hemminger <stephen@...workplumber.org>
Subject: Re: [RFC Draft PATCH net-next 0/1] Bridge doc update

Hi Nikolay, Roopa,

Do you have any comments for this RFC?

Thanks
Hangbin
On Wed, Sep 13, 2023 at 05:28:52PM +0800, Hangbin Liu wrote:
> Hi,
> 
> After a long busy period. I got time to check how to update the bridge doc.
> Here is the previous discussion we made[1].
> 
> In this update. I plan to convert all the bridge description/comments to
> the kernel headers. And add sphinx identifiers in the doc to show them
> directly. At the same time, I wrote a script to convert the description
> in kernel header file to iproute2 man doc. With this, there is no need
> to maintain the doc in 2 places.
> 
> For the script. I use python docutils to read the rst comments. When dump
> the man page. I do it manually to match the current ip link man page style.
> I tried rst2man, but the generated man doc will break the current style.
> If you have any other better way, please tell me.
> 
> [1] https://lore.kernel.org/netdev/5ddac447-c268-e559-a8dc-08ae3d124352@blackwall.org/
> 
> 
> Hangbin Liu (1):
>   Doc: update bridge doc
> 
>  Documentation/networking/bridge.rst |  85 ++++++++++--
>  include/uapi/linux/if_bridge.h      |  24 ++++
>  include/uapi/linux/if_link.h        | 194 ++++++++++++++++++++++++++++
>  3 files changed, 293 insertions(+), 10 deletions(-)
> 
> -- 
> 2.41.0
>