netdev - Re: [PATCH net-next v2 7/8] ethtool: remove the comments that are not gonna be generated

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: <20241115152840.2153afb7@kernel.org>
Date: Fri, 15 Nov 2024 15:28:40 -0800
From: Jakub Kicinski <kuba@...nel.org>
To: Stanislav Fomichev <stfomichev@...il.com>
Cc: Stanislav Fomichev <sdf@...ichev.me>, netdev@...r.kernel.org,
 davem@...emloft.net, edumazet@...gle.com, pabeni@...hat.com,
 linux-kernel@...r.kernel.org, linux-doc@...r.kernel.org,
 donald.hunter@...il.com, horms@...nel.org, corbet@....net,
 andrew+netdev@...n.ch, kory.maincent@...tlin.com
Subject: Re: [PATCH net-next v2 7/8] ethtool: remove the comments that are
 not gonna be generated

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.