leandrof/linux
1
0
Fork 0
forked from Minki/linux
Code Issues Pull Requests Packages Projects Releases Wiki Activity
b67b81d750
linux/Documentation/media/kapi/v4l2-core.rst

26 lines
385 B
ReStructuredText
Raw Normal View History

[media] doc-rst: split media_drivers.rst into one file per API type Just like the uAPI book is split into parts, let's split the kAPI documentation. That should make easier to maintain, and will split the final documentation into smaller html files. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-17 11:22:23 +00:00
Video2Linux devices
-------------------
[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>
2016-07-20 17:14:37 +00:00
.. toctree::
:maxdepth: 1
v4l2-framework
[media] doc-rst: move v4l2-dev doc to a separate file Move the documentation for video device node creation to a separate file. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-21 18:37:34 +00:00
v4l2-dev
[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>
2016-07-20 17:14:37 +00:00
v4l2-controls
v4l2-device
[media] v4l2-fh.h: add documentation for it This header file was undocumented. Add documentation for it. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-22 12:06:45 +00:00
v4l2-fh
[media] move V4L2 clocks to a separate .rst file Move the v4l2 clocks stuff from v4l2-framework to a separate file and adds an attention that came from the v4l2-clk.h. Note: as this is meant to be a temporary kAPI, and it is used only by two drivers (soc_camera and em28xx), where the first one is in deprecation process, it probably not a worth effort to document its header. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-22 12:38:58 +00:00
v4l2-clocks
[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>
2016-07-20 17:14:37 +00:00
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
Reference in New Issue Copy Permalink