netdev - Re: [PATCH net-next v3 2/3] net: ynl: add generated kdoc to UAPI headers

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

Message-ID: <aKrJAzMdgGcNiRUC@pengutronix.de>
Date: Sun, 24 Aug 2025 10:10:43 +0200
From: Oleksij Rempel <o.rempel@...gutronix.de>
To: ALOK TIWARI <alok.a.tiwari@...cle.com>
Cc: Andrew Lunn <andrew@...n.ch>, Heiner Kallweit <hkallweit1@...il.com>,
	"David S. Miller" <davem@...emloft.net>,
	Eric Dumazet <edumazet@...gle.com>,
	Jakub Kicinski <kuba@...nel.org>, Paolo Abeni <pabeni@...hat.com>,
	Rob Herring <robh@...nel.org>,
	Krzysztof Kozlowski <krzk+dt@...nel.org>,
	Florian Fainelli <f.fainelli@...il.com>,
	Maxime Chevallier <maxime.chevallier@...tlin.com>,
	Kory Maincent <kory.maincent@...tlin.com>,
	Lukasz Majewski <lukma@...x.de>, Jonathan Corbet <corbet@....net>,
	Donald Hunter <donald.hunter@...il.com>,
	Vadim Fedorenko <vadim.fedorenko@...ux.dev>,
	Jiri Pirko <jiri@...nulli.us>,
	Vladimir Oltean <vladimir.oltean@....com>,
	Alexei Starovoitov <ast@...nel.org>,
	Daniel Borkmann <daniel@...earbox.net>,
	Jesper Dangaard Brouer <hawk@...nel.org>,
	John Fastabend <john.fastabend@...il.com>, kernel@...gutronix.de,
	linux-kernel@...r.kernel.org, netdev@...r.kernel.org,
	Russell King <linux@...linux.org.uk>, Divya.Koppera@...rochip.com,
	Sabrina Dubroca <sd@...asysnail.net>,
	Stanislav Fomichev <sdf@...ichev.me>
Subject: Re: [PATCH net-next v3 2/3] net: ynl: add generated kdoc to UAPI
 headers

On Fri, Aug 22, 2025 at 07:41:39PM +0530, ALOK TIWARI wrote:
> 
> 
> On 8/20/2025 6:40 PM, Oleksij Rempel wrote:
> > Run the ynl regeneration script to apply the kdoc generation
> > support added in the previous commit.
> > 
> > This updates the generated UAPI headers for dpll, ethtool, team,
> > net_shaper, netdev, and ovpn with documentation parsed from their
> > respective YAML specifications.
> > 
> > Signed-off-by: Oleksij Rempel <o.rempel@...gutronix.de>
> > ---
> >   include/uapi/linux/dpll.h                     |  30 ++++
> >   .../uapi/linux/ethtool_netlink_generated.h    |  29 +++
> >   include/uapi/linux/if_team.h                  |  11 ++
> >   include/uapi/linux/net_shaper.h               |  50 ++++++
> >   include/uapi/linux/netdev.h                   | 165 ++++++++++++++++++
> >   include/uapi/linux/ovpn.h                     |  62 +++++++
> >   tools/include/uapi/linux/netdev.h             | 165 ++++++++++++++++++
> >   7 files changed, 512 insertions(+)
> > 
> > diff --git a/include/uapi/linux/dpll.h b/include/uapi/linux/dpll.h
> > index 37b438ce8efc..23a4e3598650 100644
> > --- a/include/uapi/linux/dpll.h
> > +++ b/include/uapi/linux/dpll.h
> > @@ -203,6 +203,18 @@ enum dpll_feature_state {
> >   	DPLL_FEATURE_STATE_ENABLE,
> >   };
> > +/**
> > + * enum dpll_dpll
> > + * @DPLL_A_CLOCK_QUALITY_LEVEL: Level of quality of a clock device. This mainly
> > + *   applies when the dpll lock-status is DPLL_LOCK_STATUS_HOLDOVER. This could
> > + *   be put to message multiple times to indicate possible parallel quality
> > + *   levels (e.g. one specified by ITU option 1 and another one specified by
> > + *   option 2).
> > + * @DPLL_A_PHASE_OFFSET_MONITOR: Receive or request state of phase offset
> > + *   monitor feature. If enabled, dpll device shall monitor and notify all
> > + *   currently available inputs for changes of their phase offset against the
> > + *   dpll device.
> > + */
> >   enum dpll_a {
> >   	DPLL_A_ID = 1,
> >   	DPLL_A_MODULE_NAME,
> > @@ -221,6 +233,24 @@ enum dpll_a {
> >   	DPLL_A_MAX = (__DPLL_A_MAX - 1)
> >   };
> > +/**
> > + * enum dpll_pin
> > + * @DPLL_A_PIN_FRACTIONAL_FREQUENCY_OFFSET: The FFO (Fractional Frequency
> > + *   Offset) between the RX and TX symbol rate on the media associated with the
> > + *   pin: (rx_frequency-tx_frequency)/rx_frequency Value is in PPM (parts per
> 
> spacing for clarity (rx_frequency - tx_frequency) / rx_frequency

Thank you for the review. The comments you refer to are autogenerated
from the YAML specs. Extending my patch to adjust or clean up those
generated comments would mean adding side-quests outside the scope of
the actual change. I’d rather keep this series focused, otherwise I risk
not being able to complete it.

Best Regards,
Oleksij
-- 
Pengutronix e.K.                           |                             |
Steuerwalder Str. 21                       | http://www.pengutronix.de/  |
31137 Hildesheim, Germany                  | Phone: +49-5121-206917-0    |
Amtsgericht Hildesheim, HRA 2686           | Fax:   +49-5121-206917-5555 |