Commit 58759874 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 575f9308

Documentation/media/kapi/v4l2-async.rst

0 → 100644
+4 −0
Original line number Diff line number Diff line 
V4L2 Async kAPI

^^^^^^^^^^^^^^^



.. kernel-doc:: include/media/v4l2-async.h

Documentation/media/kapi/v4l2-controls.rst

+5 −0
Original line number Diff line number Diff line
@@ -807,3 +807,8 @@ notify function is called. 


There can be only one notify function per control handler. Any attempt

to set another notify function will cause a WARN_ON.



V4L2 control kAPI

-----------------



.. kernel-doc:: include/media/v4l2-ctrls.h

Documentation/media/kapi/v4l2-core.rst

+20 −35
Original line number Diff line number Diff line 
Video2Linux devices

-------------------



.. kernel-doc:: include/media/tuner.h



.. kernel-doc:: include/media/tuner-types.h



.. kernel-doc:: include/media/tveeprom.h



.. kernel-doc:: include/media/v4l2-async.h



.. kernel-doc:: include/media/v4l2-ctrls.h



.. kernel-doc:: include/media/v4l2-device.h



.. kernel-doc:: include/media/v4l2-dv-timings.h



.. kernel-doc:: include/media/v4l2-event.h



.. kernel-doc:: include/media/v4l2-flash-led-class.h



.. kernel-doc:: include/media/v4l2-mc.h



.. 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
 
.. toctree::

    :maxdepth: 1



    v4l2-framework

    v4l2-async

    v4l2-controls

    v4l2-device

    v4l2-dv-timings

    v4l2-event

    v4l2-flash-led-class

    v4l2-mc

    v4l2-mediabus

    v4l2-mem2mem

    v4l2-of

    v4l2-rect

    v4l2-subdev

    v4l2-tuner

    v4l2-tveeprom

    v4l2-videobuf2

    v4l2-videobuf

Documentation/media/kapi/v4l2-device.rst

0 → 100644
+4 −0
Original line number Diff line number Diff line 
V4L2 Device kAPI

^^^^^^^^^^^^^^^^



.. kernel-doc:: include/media/v4l2-device.h

Documentation/media/kapi/v4l2-dv-timings.rst

0 → 100644
+4 −0
Original line number Diff line number Diff line 
V4L2 DV Timings kAPI

^^^^^^^^^^^^^^^^^^^^



.. kernel-doc:: include/media/v4l2-dv-timings.h