From: Hangbin Liu <liuhangbin@gmail.com>
To: Jakub Kicinski <kuba@kernel.org>
Cc: netdev@vger.kernel.org, "David S . Miller" <davem@davemloft.net>,
David Ahern <dsahern@kernel.org>,
Eric Dumazet <edumazet@google.com>,
Paolo Abeni <pabeni@redhat.com>, Ido Schimmel <idosch@idosch.org>,
Nikolay Aleksandrov <razor@blackwall.org>,
Roopa Prabhu <roopa@nvidia.com>,
Stephen Hemminger <stephen@networkplumber.org>,
Florian Westphal <fw@strlen.de>, Andrew Lunn <andrew@lunn.ch>,
Florian Fainelli <f.fainelli@gmail.com>,
Vladimir Oltean <olteanv@gmail.com>,
Jiri Pirko <jiri@resnulli.us>,
Marc Muehlfeld <mmuehlfe@redhat.com>
Subject: Re: [PATCH net-next 01/10] net: bridge: add document for IFLA_BR enum
Date: Thu, 23 Nov 2023 22:07:47 +0800 [thread overview]
Message-ID: <ZV9cs96B4j0YEbYN@Laptop-X1> (raw)
In-Reply-To: <20231121082127.62a3a478@kernel.org>
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
next prev parent reply other threads:[~2023-11-23 14:07 UTC|newest]
Thread overview: 27+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-17 9:31 [PATCH net-next 00/10] Doc: update bridge doc Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 01/10] net: bridge: add document for IFLA_BR enum Hangbin Liu
2023-11-18 17:45 ` Jakub Kicinski
2023-11-21 3:28 ` Hangbin Liu
2023-11-21 16:21 ` Jakub Kicinski
2023-11-23 14:07 ` Hangbin Liu [this message]
2023-11-19 16:46 ` Vladimir Oltean
2023-11-19 18:21 ` Andrew Lunn
2023-11-21 3:10 ` Hangbin Liu
2023-11-21 3:06 ` Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 02/10] net: bridge: add document for IFLA_BRPORT enum Hangbin Liu
2023-11-20 11:31 ` Vladimir Oltean
2023-11-21 3:10 ` Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 03/10] net: bridge: add document for bridge sysfs attribute Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 04/10] docs: bridge: Add kAPI/uAPI fields Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 05/10] docs: bridge: add STP doc Hangbin Liu
2023-11-20 11:39 ` Vladimir Oltean
2023-11-21 3:02 ` Hangbin Liu
2023-11-24 13:18 ` Nikolay Aleksandrov
2023-11-24 14:01 ` Hangbin Liu
2023-12-03 20:12 ` Stephen Hemminger
2023-11-17 9:31 ` [PATCH net-next 06/10] docs: bridge: add VLAN doc Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 07/10] docs: bridge: add multicast doc Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 08/10] docs: bridge: add switchdev doc Hangbin Liu
2023-11-20 11:56 ` Vladimir Oltean
2023-11-17 9:31 ` [PATCH net-next 09/10] docs: bridge: add netfilter doc Hangbin Liu
2023-11-17 9:31 ` [PATCH net-next 10/10] docs: bridge: add other features Hangbin Liu
Reply instructions:
You may reply publicly to this message via plain-text email
using any one of the following methods:
* Save the following mbox file, import it into your mail client,
and reply-to-all from there: mbox
Avoid top-posting and favor interleaved quoting:
https://en.wikipedia.org/wiki/Posting_style#Interleaved_style
* Reply using the --to, --cc, and --in-reply-to
switches of git-send-email(1):
git send-email \
--in-reply-to=ZV9cs96B4j0YEbYN@Laptop-X1 \
--to=liuhangbin@gmail.com \
--cc=andrew@lunn.ch \
--cc=davem@davemloft.net \
--cc=dsahern@kernel.org \
--cc=edumazet@google.com \
--cc=f.fainelli@gmail.com \
--cc=fw@strlen.de \
--cc=idosch@idosch.org \
--cc=jiri@resnulli.us \
--cc=kuba@kernel.org \
--cc=mmuehlfe@redhat.com \
--cc=netdev@vger.kernel.org \
--cc=olteanv@gmail.com \
--cc=pabeni@redhat.com \
--cc=razor@blackwall.org \
--cc=roopa@nvidia.com \
--cc=stephen@networkplumber.org \
/path/to/YOUR_REPLY
https://kernel.org/pub/software/scm/git/docs/git-send-email.html
* If your mail client supports setting the In-Reply-To header
via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line
before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.