netdev - Re: [PATCH] Documentation: Document the Netlink spec

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]

Date: Fri, 10 Nov 2023 09:23:50 +0000
From: Donald Hunter <donald.hunter@...il.com>
To: Jakub Kicinski <kuba@...nel.org>
Cc: Jonathan Corbet <corbet@....net>,  Breno Leitao <leitao@...ian.org>,
  linux-doc@...r.kernel.org,  netdev@...r.kernel.org,  pabeni@...hat.com,
  edumazet@...gle.com
Subject: Re: [PATCH] Documentation: Document the Netlink spec

Jakub Kicinski <kuba@...nel.org> writes:

> On Wed, 08 Nov 2023 13:27:28 -0700 Jonathan Corbet wrote:
>> I do have to wonder, though, whether a sphinx extension is the right way
>> to solve this problem.  You're essentially implementing a filter that
>> turns one YAML file into one RST file; might it be better to keep that
>> outside of sphinx as a standalone script, invoked by the Makefile?
>
> If we're considering other ways of generating the files - I'd also like
> to voice a weak preference towards removing the need for the "stub"
> files.
>
> Get all the docs rendered under Documentation/netlink/ with an
> auto-generated index.

FWIW the index could use a toctree glob pattern like we do in
Documentation/bpf/maps.rst then it wouldn't need to be auto-generated.

> This way newcomers won't have to remember to add a stub to get the doc
> rendered. One fewer thing to worry about during review.