linux-kernel - Re: [PATCH v3] Documentation: Document each netlink family

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: <d8bce254-74a8-4d4e-8739-2d96a697782d@gmail.com>
Date: Sat, 10 Feb 2024 08:20:07 +0900
From: Akira Yokosawa <akiyks@...il.com>
To: vegard.nossum@...cle.com
Cc: corbet@....net, davem@...emloft.net, edumazet@...gle.com,
 jani.nikula@...ux.intel.com, kuba@...nel.org, leitao@...ian.org,
 linux-doc@...r.kernel.org, linux-kernel@...r.kernel.org,
 netdev@...r.kernel.org, pabeni@...hat.com
Subject: Re: [PATCH v3] Documentation: Document each netlink family

Hi,

On Fri, 9 Feb 2024 15:47:16 +0100, Vegard Nossum wrote:
> On 30/01/2024 17:23, Vegard Nossum wrote:
>> We should still fix the writing of .rst to $(srctree), though -- our
>> use of parse-headers.pl seems to sidestep this by writing the 
>> intermediate .rst output to Documentation/output/, I'll have to look
>> a bit more closely.
> 
> I have now spent quite a bit of time investigating this.
> 
> The main result is that Sphinx really does NOT like it when documents
> are located outside of the source root.

There is a hack extension named "kernel_include".
See Documentation/sphinx/kernel_include.py (no, I'm not saying
I understand it.)

The "kernel-include::" directive is exploited only in
Documentation/userspace-api/media/dvb/headers.rst.

I have no idea if Jon is happy to see another subsystem
to start exploiting this extension.

And you should be interested in seeing
Documentation/userspace-api/media/Makefile and how it is integrated
into Documentation/Makefile.

I think media people are doing similar things you'd like to do.

HTH, Akira