linux-kernel - Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

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] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 22 Aug 2016 12:49:30 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Sumit Semwal <sumit.semwal@...aro.org>
Cc:     linux-media@...r.kernel.org, dri-devel@...ts.freedesktop.org,
        linaro-mm-sig@...ts.linaro.org, linux-doc@...r.kernel.org,
        corbet@....net, linux-kernel@...r.kernel.org,
        markus.heiser@...marit.de, jani.nikula@...ux.intel.com
Subject: Re: [PATCH v2 2/2] Documentation/sphinx: link dma-buf rsts

Em Mon, 22 Aug 2016 20:41:45 +0530
Sumit Semwal <sumit.semwal@...aro.org> escreveu:

> Include dma-buf sphinx documentation into top level index.
> 
> Signed-off-by: Sumit Semwal <sumit.semwal@...aro.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