Received-SPF: pass (google.com: domain of linux-kernel+bounces-60143-linux.lists.archive=gmail.com@vger.kernel.org designates 2604:1380:4601:e00::3 as permitted sender) client-ip=2604:1380:4601:e00::3;
Message-ID: <d8bce254-74a8-4d4e-8739-2d96a697782d@gmail.com>
Date: Sat, 10 Feb 2024 08:20:07 +0900
Precedence: bulk
MIME-Version: 1.0
User-Agent: Mozilla Thunderbird
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
References: <2d3359b3-f124-4ddc-97e0-cd56d0e7b966@oracle.com>
Subject: Re: [PATCH v3] Documentation: Document each netlink family
Content-Language: en-US
From: Akira Yokosawa <akiyks@gmail.com>
In-Reply-To: <2d3359b3-f124-4ddc-97e0-cd56d0e7b966@oracle.com>
Content-Type: text/plain; charset=UTF-8
Content-Transfer-Encoding: 7bit

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