lkml.org 
[lkml]   [2016]   [Aug]   [22]   [last100]   RSS Feed
Views: [wrap][no wrap]   [headers]  [forward] 
 
Messages in this thread
/
Date
From
SubjectRe: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts
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.

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

\
 
 \ /
  Last update: 2016-09-17 09:57    [W:1.359 / U:0.056 seconds]
©2003-2020 Jasper Spaans|hosted at Digital Ocean and TransIP|Read the blog|Advertise on this site