From: Jakub Kicinski <kuba@kernel.org>
To: Stanislav Fomichev <stfomichev@gmail.com>
Cc: Stanislav Fomichev <sdf@fomichev.me>,
netdev@vger.kernel.org, davem@davemloft.net, edumazet@google.com,
pabeni@redhat.com, linux-kernel@vger.kernel.org,
linux-doc@vger.kernel.org, donald.hunter@gmail.com,
horms@kernel.org, corbet@lwn.net, andrew+netdev@lunn.ch,
kory.maincent@bootlin.com
Subject: Re: [PATCH net-next v2 7/8] ethtool: remove the comments that are not gonna be generated
Date: Fri, 15 Nov 2024 15:28:40 -0800 [thread overview]
Message-ID: <20241115152840.2153afb7@kernel.org> (raw)
In-Reply-To: <ZzfTVtxjgXR-L8my@mini-arch>
On Fri, 15 Nov 2024 15:03:50 -0800 Stanislav Fomichev wrote:
> > > Absolutely, I did port these (and the rest of the comments that I removed)
> > > over as doc: (see patch 4).
> >
> > Ah, I was looking for them re-appearing in patch 8. All good then.
>
> AFAICT, only enum docs are rendered. We don't have support for the rest.
> I can try to follow up separately..
Right but they will get rendered as HTML in
https://docs.kernel.org/next/networking/netlink_spec/ethtool.html
Up to you if you want to follow up, I think I mostly added
the inline enum docs for the benefit of DPLL, because those
guys were adding a family at the same time the specs were
first merged, and I wanted to match what they had.
No strong opinion if uAPI headers need to duplicate doc info
or HTML + reading YAML directly is enough.
next prev parent reply other threads:[~2024-11-15 23:28 UTC|newest]
Thread overview: 21+ messages / expand[flat|nested] mbox.gz Atom feed top
2024-11-15 19:36 [PATCH net-next v2 0/8] ethtool: generate uapi header from the spec Stanislav Fomichev
2024-11-15 19:36 ` [PATCH net-next v2 1/8] ynl: support enum-cnt-name attribute in legacy definitions Stanislav Fomichev
2024-11-15 19:36 ` [PATCH net-next v2 2/8] ynl: skip rendering attributes with header property in uapi mode Stanislav Fomichev
2024-11-15 19:36 ` [PATCH net-next v2 3/8] ynl: support directional specs in ynl-gen-c.py Stanislav Fomichev
2024-11-15 21:32 ` Jakub Kicinski
2024-11-15 21:55 ` Stanislav Fomichev
2024-11-15 22:38 ` Jakub Kicinski
2024-11-15 19:36 ` [PATCH net-next v2 4/8] ynl: add missing pieces to ethtool spec to better match uapi header Stanislav Fomichev
2024-11-15 19:36 ` [PATCH net-next v2 5/8] ynl: include uapi header after all dependencies Stanislav Fomichev
2024-11-15 19:36 ` [PATCH net-next v2 6/8] ethtool: separate definitions that are gonna be generated Stanislav Fomichev
2024-11-15 19:36 ` [PATCH net-next v2 7/8] ethtool: remove the comments that are not " Stanislav Fomichev
2024-11-15 21:40 ` Jakub Kicinski
2024-11-15 21:54 ` Stanislav Fomichev
2024-11-15 22:37 ` Jakub Kicinski
2024-11-15 23:03 ` Stanislav Fomichev
2024-11-15 23:28 ` Jakub Kicinski [this message]
2024-11-15 19:36 ` [PATCH net-next v2 8/8] ethtool: regenerate uapi header from the spec Stanislav Fomichev
2024-11-15 21:28 ` Jakub Kicinski
2024-11-15 21:56 ` Stanislav Fomichev
2024-11-15 23:01 ` Jakub Kicinski
2024-11-15 23:06 ` Stanislav Fomichev
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=20241115152840.2153afb7@kernel.org \
--to=kuba@kernel.org \
--cc=andrew+netdev@lunn.ch \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=donald.hunter@gmail.com \
--cc=edumazet@google.com \
--cc=horms@kernel.org \
--cc=kory.maincent@bootlin.com \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=sdf@fomichev.me \
--cc=stfomichev@gmail.com \
/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.