From: Akira Yokosawa <akiyks@gmail.com>
To: vegard.nossum@oracle.com
Cc: corbet@lwn.net, davem@davemloft.net, edumazet@google.com,
jani.nikula@linux.intel.com, kuba@kernel.org, leitao@debian.org,
linux-doc@vger.kernel.org, linux-kernel@vger.kernel.org,
netdev@vger.kernel.org, pabeni@redhat.com
Subject: Re: [PATCH v3] Documentation: Document each netlink family
Date: Sat, 10 Feb 2024 08:20:07 +0900 [thread overview]
Message-ID: <d8bce254-74a8-4d4e-8739-2d96a697782d@gmail.com> (raw)
In-Reply-To: <2d3359b3-f124-4ddc-97e0-cd56d0e7b966@oracle.com>
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
prev parent reply other threads:[~2024-02-09 23:20 UTC|newest]
Thread overview: 11+ messages / expand[flat|nested] mbox.gz Atom feed top
2023-11-21 11:48 [PATCH v3] Documentation: Document each netlink family Breno Leitao
2023-11-21 16:15 ` Jakub Kicinski
2023-11-24 1:20 ` patchwork-bot+netdevbpf
2024-01-30 9:43 ` Jani Nikula
2024-01-30 14:22 ` Jonathan Corbet
2024-01-30 15:03 ` Jani Nikula
2024-01-30 16:06 ` Breno Leitao
2024-01-30 16:23 ` Vegard Nossum
2024-01-30 17:29 ` Breno Leitao
2024-02-09 14:47 ` Vegard Nossum
2024-02-09 23:20 ` Akira Yokosawa [this message]
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=d8bce254-74a8-4d4e-8739-2d96a697782d@gmail.com \
--to=akiyks@gmail.com \
--cc=corbet@lwn.net \
--cc=davem@davemloft.net \
--cc=edumazet@google.com \
--cc=jani.nikula@linux.intel.com \
--cc=kuba@kernel.org \
--cc=leitao@debian.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=netdev@vger.kernel.org \
--cc=pabeni@redhat.com \
--cc=vegard.nossum@oracle.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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).