netdev - Re: [PATCH net-next 01/10] net: bridge: add document for IFLA

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] [thread-next>] [day] [month] [year] [list]

Date: Thu, 23 Nov 2023 22:07:47 +0800
From: Hangbin Liu <liuhangbin@...il.com>
To: Jakub Kicinski <kuba@...nel.org>
Cc: netdev@...r.kernel.org, "David S . Miller" <davem@...emloft.net>,
	David Ahern <dsahern@...nel.org>,
	Eric Dumazet <edumazet@...gle.com>, Paolo Abeni <pabeni@...hat.com>,
	Ido Schimmel <idosch@...sch.org>,
	Nikolay Aleksandrov <razor@...ckwall.org>,
	Roopa Prabhu <roopa@...dia.com>,
	Stephen Hemminger <stephen@...workplumber.org>,
	Florian Westphal <fw@...len.de>, Andrew Lunn <andrew@...n.ch>,
	Florian Fainelli <f.fainelli@...il.com>,
	Vladimir Oltean <olteanv@...il.com>, Jiri Pirko <jiri@...nulli.us>,
	Marc Muehlfeld <mmuehlfe@...hat.com>
Subject: Re: [PATCH net-next 01/10] net: bridge: add document for IFLA_BR enum

On Tue, Nov 21, 2023 at 08:21:27AM -0800, Jakub Kicinski wrote:
> On Tue, 21 Nov 2023 11:28:30 +0800 Hangbin Liu wrote:
> > Thanks for this info. Will the YAML spec be build by the document team?
> > I'd prefer all the doc shows in https://www.kernel.org/doc/html/latest/
> > so users could find the doc easily.
> 
> That's the plan, it will render under ${base}/networking/netlink_spec/
> 
> > It would be good if there is an example in Documentation/netlink/specs/ (when
> > the patch applied) so I can take as a reference :)
> 
> All the operations, attributes etc in the spec accept a "doc" property.
> The html output is just a rendering of those doc strings.
> So the existing specs are already kind of examples, although they don't
> have doc strings in very many places so the output looks a bit empty :(

Thanks, I will investigate how to convert the bridge yaml. But next week
I will be in vacation. So I may post another patch after vacation.

Regards
Hangbin