From: Markus Heiser <markus.heiser@darmarit.de>
To: Sumit Semwal <sumit.semwal@linaro.org>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
corbet@lwn.net, linux-doc@vger.kernel.org,
"linux-kernel@vger.kernel.org List"
<linux-kernel@vger.kernel.org>,
"dri-devel@lists.freedesktop.org Development"
<dri-devel@lists.freedesktop.org>,
linaro-mm-sig@lists.linaro.org, linux-media@vger.kernel.org,
Daniel Vetter <daniel@ffwll.ch>
Subject: Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts
Date: Tue, 23 Aug 2016 11:20:23 +0200 [thread overview]
Message-ID: <C5319F88-5156-4B47-B03D-40A8548CD4F1@darmarit.de> (raw)
In-Reply-To: <20160823060135.GJ24290@phenom.ffwll.local>
Am 23.08.2016 um 08:01 schrieb Daniel Vetter <daniel@ffwll.ch>:
> On Mon, Aug 22, 2016 at 12:49:30PM -0300, Mauro Carvalho Chehab wrote:
>> Em Mon, 22 Aug 2016 20:41:45 +0530
>> Sumit Semwal <sumit.semwal@linaro.org> escreveu:
>>
>>> Include dma-buf sphinx documentation into top level index.
>>>
>>> Signed-off-by: Sumit Semwal <sumit.semwal@linaro.org>
>>> ---
>>> Documentation/index.rst | 2 ++
>>> 1 file changed, 2 insertions(+)
>>>
>>> diff --git a/Documentation/index.rst b/Documentation/index.rst
>>> index e0fc72963e87..8d05070122c2 100644
>>> --- a/Documentation/index.rst
>>> +++ b/Documentation/index.rst
>>> @@ -14,6 +14,8 @@ Contents:
>>> :maxdepth: 2
>>>
>>> kernel-documentation
>>> + dma-buf/intro
>>> + dma-buf/guide
>>> media/media_uapi
>>> media/media_kapi
>>> media/dvb-drivers/index
>>
>> IMHO, the best would be, instead, to add an index with a toctree
>> with both intro and guide, and add dma-buf/index instead.
>>
>> We did that for media too (patches not merged upstream yet), together
>> with a patchset that will allow building just a subset of the books.
Since 606b9ac, one more *pro* of a index.rst file in a sub-folder is,
that you can reduce your roundtrips. Add a conf.py to your subfolder
and compile only your sub-folder with e.g.
make SPHINXDIRS="dma-buf" htmldocs
* http://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/commit/?id=606b9ac81a63ab3adb7e61206b9ae34ee186a89d
One / the example (Mauro mentioned) is media commit b32feba
* http://git.kernel.org/cgit/linux/kernel/git/next/linux-next.git/commit/?id=b32febad77068b4a28daf7b7e063438d0cca8a42
> I'm also not too sure about whether dma-buf really should be it's own
> subdirectory. It's plucked from the device-drivers.tmpl, I think an
> overall device-drivers/ for all the misc subsystems and support code would
> be better.
If the sub-folder named 'device-drivers' use:
make SPHINXDIRS="device-drivers" htmldocs
-- Markus --
> Then one toc there, which fans out to either kernel-doc and
> overview docs.
> -Daniel
>
>>
>> Regards,
>> Mauro
>>
>> PS.: That's the content of our index.rst file, at
>> Documentation/media/index.rst:
>>
>> Linux Media Subsystem Documentation
>> ===================================
>>
>> Contents:
>>
>> .. toctree::
>> :maxdepth: 2
>>
>> media_uapi
>> media_kapi
>> dvb-drivers/index
>> v4l-drivers/index
>>
>> .. only:: subproject
>>
>> Indices
>> =======
>>
>> * :ref:`genindex`
>>
>>
>> Thanks,
>> Mauro
>> _______________________________________________
>> dri-devel mailing list
>> dri-devel@lists.freedesktop.org
>> https://lists.freedesktop.org/mailman/listinfo/dri-devel
>
> --
> Daniel Vetter
> Software Engineer, Intel Corporation
> http://blog.ffwll.ch
next prev parent reply other threads:[~2016-08-23 9:24 UTC|newest]
Thread overview: 12+ messages / expand[flat|nested] mbox.gz Atom feed top
2016-08-22 15:11 [PATCH v2 0/2] doc: dma-buf: sphinx conversion Sumit Semwal
2016-08-22 15:11 ` [PATCH v2 1/2] Documentation: move dma-buf documentation to rst Sumit Semwal
2016-08-22 15:11 ` [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts Sumit Semwal
2016-08-22 15:49 ` Mauro Carvalho Chehab
2016-08-23 6:01 ` Daniel Vetter
2016-08-23 9:20 ` Markus Heiser [this message]
2016-08-23 13:08 ` Jonathan Corbet
2016-08-23 13:28 ` Daniel Vetter
2016-08-23 14:16 ` Jonathan Corbet
2016-08-23 15:15 ` Daniel Vetter
2016-08-23 16:40 ` Mauro Carvalho Chehab
2016-08-23 13:33 ` Sumit Semwal
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=C5319F88-5156-4B47-B03D-40A8548CD4F1@darmarit.de \
--to=markus.heiser@darmarit.de \
--cc=corbet@lwn.net \
--cc=daniel@ffwll.ch \
--cc=dri-devel@lists.freedesktop.org \
--cc=linaro-mm-sig@lists.linaro.org \
--cc=linux-doc@vger.kernel.org \
--cc=linux-kernel@vger.kernel.org \
--cc=linux-media@vger.kernel.org \
--cc=mchehab@s-opensource.com \
--cc=sumit.semwal@linaro.org \
/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).