From: Jakub Kicinski <kuba@kernel.org>
To: Hangbin Liu <liuhangbin@gmail.com>
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: Tue, 21 Nov 2023 08:21:27 -0800 [thread overview]
Message-ID: <20231121082127.62a3a478@kernel.org> (raw)
In-Reply-To: <ZVwj3kb/3BdvKblG@Laptop-X1>
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 :(
next prev parent reply other threads:[~2023-11-21 16:21 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 [this message]
2023-11-23 14:07 ` Hangbin Liu
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=20231121082127.62a3a478@kernel.org \
--to=kuba@kernel.org \
--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=liuhangbin@gmail.com \
--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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).