linux/Documentation/media/kapi
Mauro Carvalho Chehab 66f1e6078e media: v4l2-event.rst: improve events description
Both v4l2-event.rst and v4l2-event.h have an overview of
events, but there are some inconsistencies there:

- at v4l2-event, the event's ring buffer is called kevent. Its
  name is, instead, v4l2_kevent;

- Some things are mentioned on both places (with different words),
  others are either on one of the files.

In order to cleanup this mess, put everything at v4l2-event.rst
and improve it to be a little more coherent and to have cross
references.

Acked-by: Sakari Ailus <sakari.ailus@linux.intel.com>
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2017-12-18 10:35:46 -05:00
..
cec-core.rst media: cec-core.rst: document the new adap_monitor_pin_enable op 2017-12-08 11:10:37 -05:00
csi2.rst media: docs-rst: media: Document broken frame handling in stream stop for CSI-2 2017-08-27 07:11:11 -04:00
dtv-ca.rst media: dtv-core.rst: split into multiple files 2017-10-11 13:05:44 -04:00
dtv-common.rst media: dtv-core.rst: split into multiple files 2017-10-11 13:05:44 -04:00
dtv-core.rst media: dvb-net.rst: document DVB network kAPI interface 2017-10-11 13:22:09 -04:00
dtv-demux.rst media: dtv-demux.rst: parse other demux headers with kernel-doc 2017-10-11 13:21:41 -04:00
dtv-frontend.rst media: dtv-frontend.rst fix a typo: algoritms -> algorithms 2017-10-11 13:06:30 -04:00
dtv-net.rst media: dvb-net.rst: document DVB network kAPI interface 2017-10-11 13:22:09 -04:00
mc-core.rst [media] media: Rename graph and pipeline structs and functions 2017-01-27 16:13:24 -02:00
rc-core.rst media: rc-core.rst: add an introduction for RC core 2017-12-18 10:15:29 -05:00
v4l2-async.rst media: v4l: async: Add V4L2 async documentation to the documentation build 2017-10-31 13:43:23 -04:00
v4l2-clocks.rst [media] move V4L2 clocks to a separate .rst file 2016-07-23 08:04:21 -03:00
v4l2-common.rst [media] v4l2-ioctl.h add debug info for struct v4l2_ioctl_ops 2016-07-23 08:04:21 -03:00
v4l2-controls.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-core.rst media: v4l: async: Add V4L2 async documentation to the documentation build 2017-10-31 13:43:23 -04:00
v4l2-dev.rst [media] get rid of a number of problems at the cross references 2016-09-22 10:00:23 -03:00
v4l2-device.rst [media] doc-rst: kapi: use :c:func: instead of :cpp:func 2016-07-23 08:04:21 -03:00
v4l2-dv-timings.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-event.rst media: v4l2-event.rst: improve events description 2017-12-18 10:35:46 -05:00
v4l2-fh.rst [media] docs-next: stop abusing on the cpp domain 2016-08-22 21:23:00 -03:00
v4l2-flash-led-class.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-fwnode.rst [media] docs-rst: media: Switch documentation to V4L2 fwnode API 2017-06-06 09:59:50 -03:00
v4l2-intro.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-mc.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-mediabus.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-mem2mem.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-rect.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-subdev.rst [media] v4l2-subdev.rst: get rid of legacy functions 2016-09-09 09:44:37 -03:00
v4l2-tuner.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-tveeprom.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-videobuf2.rst [media] doc-rst: reorganize the kAPI v4l2 chapters 2016-07-23 08:04:21 -03:00
v4l2-videobuf.rst [media] v4l2-dev: add cross-references and improve markup 2016-07-23 08:04:21 -03:00