mirrors
/
linux-stable
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git
1
0
Fork 0
Code Issues Releases Wiki Activity

[media] doc-rst: Split v4l-core into one file per kAPI 

Sphinx produce a 1:1 mapping between a rst file and an html file.

So, we need to split the kernel-doc tags on multiple documents.

A side effect is that we're now having a better name for each
section of the kAPI documentation.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-20 14:14:37 -03:00
parent 575f93084d
commit 5875987400
18 changed files with 84 additions and 37 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

4
Documentation/media/kapi/v4l2-async.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 Async kAPI
^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-async.h

5
Documentation/media/kapi/v4l2-controls.rst
View File

@ -807,3 +807,8 @@ notify function is called.
There can be only one notify function per control handler. Any attempt There can be only one notify function per control handler. Any attempt
to set another notify function will cause a WARN_ON. to set another notify function will cause a WARN_ON.
V4L2 control kAPI
-----------------
.. kernel-doc:: include/media/v4l2-ctrls.h

53
Documentation/media/kapi/v4l2-core.rst
View File

@ -1,38 +1,23 @@
Video2Linux devices Video2Linux devices
------------------- -------------------
.. kernel-doc:: include/media/tuner.h .. toctree::
:maxdepth: 1
.. kernel-doc:: include/media/tuner-types.h v4l2-framework
v4l2-async
.. kernel-doc:: include/media/tveeprom.h v4l2-controls
v4l2-device
.. kernel-doc:: include/media/v4l2-async.h v4l2-dv-timings
v4l2-event
.. kernel-doc:: include/media/v4l2-ctrls.h v4l2-flash-led-class
v4l2-mc
.. kernel-doc:: include/media/v4l2-device.h v4l2-mediabus
v4l2-mem2mem
.. kernel-doc:: include/media/v4l2-dv-timings.h v4l2-of
v4l2-rect
.. kernel-doc:: include/media/v4l2-event.h v4l2-subdev
v4l2-tuner
.. kernel-doc:: include/media/v4l2-flash-led-class.h v4l2-tveeprom
v4l2-videobuf2
.. kernel-doc:: include/media/v4l2-mc.h v4l2-videobuf
.. kernel-doc:: include/media/v4l2-mediabus.h
.. kernel-doc:: include/media/v4l2-mem2mem.h
.. kernel-doc:: include/media/v4l2-of.h
.. kernel-doc:: include/media/v4l2-rect.h
.. kernel-doc:: include/media/v4l2-subdev.h
.. kernel-doc:: include/media/videobuf2-core.h
.. kernel-doc:: include/media/videobuf2-v4l2.h
.. kernel-doc:: include/media/videobuf2-memops.h

4
Documentation/media/kapi/v4l2-device.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 Device kAPI
^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-device.h

4
Documentation/media/kapi/v4l2-dv-timings.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 DV Timings kAPI
^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-dv-timings.h

4
Documentation/media/kapi/v4l2-event.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 event kAPI
^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-event.h

4
Documentation/media/kapi/v4l2-flash-led-class.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 Flash and LED class kAPI
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-flash-led-class.h

4
Documentation/media/kapi/v4l2-mc.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 Media Controller kAPI
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-mc.h

4
Documentation/media/kapi/v4l2-mediabus.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 Media Bus kAPI
^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-mediabus.h

3
Documentation/media/kapi/v4l2-mem2mem.rst Normal file
View File

@ -0,0 +1,3 @@
V4L2 Memory to Memory kAPI
^^^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-mem2mem.h

3
Documentation/media/kapi/v4l2-of.rst Normal file
View File

@ -0,0 +1,3 @@
V4L2 Open Firmware kAPI
^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-of.h

4
Documentation/media/kapi/v4l2-rect.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 rect kAPI
^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-rect.h

4
Documentation/media/kapi/v4l2-subdev.rst Normal file
View File

@ -0,0 +1,4 @@
V4L2 subdev kAPI
^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/v4l2-subdev.h

6
Documentation/media/kapi/v4l2-tuner.rst Normal file
View File

@ -0,0 +1,6 @@
Tuner kAPI
^^^^^^^^^^
.. kernel-doc:: include/media/tuner.h
.. kernel-doc:: include/media/tuner-types.h

4
Documentation/media/kapi/v4l2-tveeprom.rst Normal file
View File

@ -0,0 +1,4 @@
Hauppauge TV EEPROM kAPI
^^^^^^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/tveeprom.h

0
Documentation/media/kapi/videobuf.rst → Documentation/media/kapi/v4l2-videobuf.rst
View File

8
Documentation/media/kapi/v4l2-videobuf2.rst Normal file
View File

@ -0,0 +1,8 @@
V4L2 videobuf2 kAPI
^^^^^^^^^^^^^^^^^^^
.. kernel-doc:: include/media/videobuf2-core.h
.. kernel-doc:: include/media/videobuf2-v4l2.h
.. kernel-doc:: include/media/videobuf2-memops.h

3
Documentation/media/media_kapi.rst
View File

@ -28,9 +28,6 @@ For more details see the file COPYING in the source distribution of Linux.
:maxdepth: 5 :maxdepth: 5
:numbered: :numbered:
kapi/v4l2-framework
kapi/v4l2-controls
kapi/videobuf
kapi/v4l2-core kapi/v4l2-core
kapi/dtv-core kapi/dtv-core
kapi/rc-core kapi/rc-core