[PATCH 1/2] [media] doc-rst: fix an undefined reference

[PATCH 1/2] [media] doc-rst: fix an undefined reference

[Mauro Carvalho Chehab]

	Documentation/media/uapi/cec/cec-ioc-dqevent.rst:43: WARNING: undefined label: cec_event_state_change (if the link has no caption the label must precede a section header)

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/media/uapi/cec/cec-ioc-dqevent.rst | 6 +++---
 1 file changed, 3 insertions(+), 3 deletions(-)

diff --git a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
index 0fdd4afa8d82..2785a4cb9f08 100644
--- a/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
+++ b/Documentation/media/uapi/cec/cec-ioc-dqevent.rst
@@ -45,9 +45,9 @@ there is no more room in a queue then the last event is overwritten with
 the new one. This means that intermediate results can be thrown away but
 that the latest event is always available. This also means that is it
 possible to read two successive events that have the same value (e.g.
-two :ref:`CEC_EVENT_STATE_CHANGE <CEC_EVENT_STATE_CHANGE>` events with the same state). In that case
-the intermediate state changes were lost but it is guaranteed that the
-state did change in between the two events.
+two :ref:`CEC_EVENT_STATE_CHANGE <CEC-EVENT-STATE-CHANGE>` events with
+the same state). In that case the intermediate state changes were lost but
+it is guaranteed that the state did change in between the two events.
 
 
 .. _cec-event-state-change_s:
-- 
2.7.4

[PATCH 2/2] [media] doc-rst: increase depth of the main index

[Mauro Carvalho Chehab]

It is useful to have an index with all the book contents somewhere,
as it makes easier to seek for something. So, increase maxdepth
to 5 for the main index at the beginning of the book.

While here, remove the genindex content, as it is bogus.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/media/media_uapi.rst | 11 +++--------
 1 file changed, 3 insertions(+), 8 deletions(-)

diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst
index 527c6deb1a19..5e872c8297b0 100644
--- a/Documentation/media/media_uapi.rst
+++ b/Documentation/media/media_uapi.rst
@@ -15,8 +15,10 @@ the license is included in the chapter entitled "GNU Free Documentation
 License".
 
 
+.. contents::
+
 .. toctree::
-    :maxdepth: 1
+    :maxdepth: 5
 
     intro
     uapi/v4l/v4l2
@@ -26,10 +28,3 @@ License".
     uapi/cec/cec-api
     uapi/gen-errors
     uapi/fdl-appendix
-
-.. only:: html
-
-  Retrieval
-  =========
-
-  * :ref:`genindex`
-- 
2.7.4

Re: [PATCH 2/2] [media] doc-rst: increase depth of the main index

[Markus Heiser]

Hi Mauro,

Am 13.07.2016 um 15:52 schrieb Mauro Carvalho Chehab <mchehab@s-opensource.com>:

> It is useful to have an index with all the book contents somewhere,
> as it makes easier to seek for something. So, increase maxdepth
> to 5 for the main index at the beginning of the book.
> 
> While here, remove the genindex content, as it is bogus.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
> ---
> Documentation/media/media_uapi.rst | 11 +++--------
> 1 file changed, 3 insertions(+), 8 deletions(-)
> 
> diff --git a/Documentation/media/media_uapi.rst b/Documentation/media/media_uapi.rst
> index 527c6deb1a19..5e872c8297b0 100644
> --- a/Documentation/media/media_uapi.rst
> +++ b/Documentation/media/media_uapi.rst
> @@ -15,8 +15,10 @@ the license is included in the chapter entitled "GNU Free Documentation
> License".
> 
> 
> +.. contents::
> +

Since there is a ".. toctree" with maxdepth, you don't need
this ".. contents::" directive.

The ".. contents::" directive is helpfull if you want to show
the contents (e.g.) on top of a file which has no toctree in.

-- Markus --

> .. toctree::
> -    :maxdepth: 1
> +    :maxdepth: 5
> 
>     intro
>     uapi/v4l/v4l2
> @@ -26,10 +28,3 @@ License".
>     uapi/cec/cec-api
>     uapi/gen-errors
>     uapi/fdl-appendix
> -
> -.. only:: html
> -
> -  Retrieval
> -  =========
> -
> -  * :ref:`genindex`
> -- 
> 2.7.4
> 
> --
> To unsubscribe from this list: send the line "unsubscribe linux-media" in
> the body of a message to majordomo@vger.kernel.org
> More majordomo info at  http://vger.kernel.org/majordomo-info.html