Commit 9f97b306 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: autogenerate videodev2.h.rst file 



This file comes from the uAPI definitions for V4L2, with is dynamic
and updated on almost every Kernel version. So, this file
needs to be auto-updated, as otherwise the documentation will
become obsolete too early.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 153234c4

Documentation/linux_tv/Makefile

+5 −1
Original line number Diff line number Diff line
@@ -2,7 +2,8 @@ 


PARSER = ../sphinx/parse-headers.pl

UAPI = ../../include/uapi/linux

TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst

TARGETS = audio.h.rst ca.h.rst dmx.h.rst frontend.h.rst net.h.rst video.h.rst \

	  videodev2.h.rst



htmldocs: ${TARGETS}
@@ -24,5 +25,8 @@ net.h.rst: ${PARSER} ${UAPI}/dvb/net.h net.h.rst.exceptions 
video.h.rst: ${PARSER} ${UAPI}/dvb/video.h  video.h.rst.exceptions

	${PARSER} ${UAPI}/dvb/video.h $@ video.h.rst.exceptions



videodev2.h.rst: ${UAPI}/videodev2.h ${PARSER} videodev2.h.rst.exceptions

	${PARSER} ${UAPI}/videodev2.h $@ videodev2.h.rst.exceptions



cleandocs:

	-rm ${TARGETS}

Documentation/linux_tv/media/v4l/audio.rst

+4 −4
Original line number Diff line number Diff line
@@ -28,23 +28,23 @@ number, starting at zero, of one audio input or output. 
To learn about the number and attributes of the available inputs and

outputs applications can enumerate them with the

:ref:`VIDIOC_ENUMAUDIO` and

:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` ioctl, respectively.

:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>` ioctl, respectively.

The struct :ref:`v4l2_audio <v4l2-audio>` returned by the

:ref:`VIDIOC_ENUMAUDIO` ioctl also contains signal

:status information applicable when the current audio input is queried.



The :ref:`VIDIOC_G_AUDIO <VIDIOC_G_AUDIO>` and

:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` ioctls report the current

:ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDOUT>` ioctls report the current

audio input and output, respectively. Note that, unlike

:ref:`VIDIOC_G_INPUT <VIDIOC_G_INPUT>` and

:ref:`VIDIOC_G_OUTPUT <VIDIOC_G_OUTPUT>` these ioctls return a

structure as :ref:`VIDIOC_ENUMAUDIO` and

:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>` do, not just an index.

:ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>` do, not just an index.



To select an audio input and change its properties applications call the

:ref:`VIDIOC_S_AUDIO <VIDIOC_G_AUDIO>` ioctl. To select an audio

output (which presently has no changeable properties) applications call

the :ref:`VIDIOC_S_AUDOUT <VIDIOC_G_AUDIOout>` ioctl.

the :ref:`VIDIOC_S_AUDOUT <VIDIOC_G_AUDOUT>` ioctl.



Drivers must implement all audio input ioctls when the device has

multiple selectable audio inputs, all audio output ioctls when the

Documentation/linux_tv/media/v4l/hist-v4l2.rst

+2 −2
Original line number Diff line number Diff line
@@ -727,8 +727,8 @@ V4L2 2003-06-19 
   audio input.



   The same changes were made to

   :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDIOout>` and

   :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDIOout>`.

   :ref:`VIDIOC_G_AUDOUT <VIDIOC_G_AUDOUT>` and

   :ref:`VIDIOC_ENUMAUDOUT <VIDIOC_ENUMAUDOUT>`.



   Until further the "videodev" module will automatically translate

   between the old and new ioctls, but drivers and applications must be

Documentation/linux_tv/media/v4l/vidioc-enumaudioout.rst

+2 −2
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _VIDIOC_ENUMAUDIOOUT:

.. _VIDIOC_ENUMAUDOUT:



***********************

ioctl VIDIOC_ENUMAUDOUT
@@ -44,7 +44,7 @@ zero, incrementing by one until the driver returns ``EINVAL``. 
Note connectors on a TV card to loop back the received audio signal to a

sound card are not audio outputs in this sense.



See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDIOout>` for a description of struct

See :ref:`VIDIOC_G_AUDIOout <VIDIOC_G_AUDOUT>` for a description of struct

:ref:`v4l2_audioout <v4l2-audioout>`.

Documentation/linux_tv/media/v4l/vidioc-g-audioout.rst

+1 −1
Original line number Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _VIDIOC_G_AUDIOOUT:

.. _VIDIOC_G_AUDOUT:



**************************************

ioctl VIDIOC_G_AUDOUT, VIDIOC_S_AUDOUT