summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/v4l
AgeCommit message (Collapse)Author
2016-07-13Revert "[media] docs-rst: escape [] characters"Mauro Carvalho Chehab
This patch touches on places where it shouldn't: image files and code examples. Also, it doesn't fix all array occurrences. So, let's revert it. This reverts commit ffbab694ede33c294e5864a5e0bf4d1474446a71.
2016-07-12[media] docs-rst: escape [] charactersMauro Carvalho Chehab
Those characters are used for citations. Better to escape, to avoid them to be misinterpreted. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12[media] doc-rst: use the right markup for footnotesMauro Carvalho Chehab
According with ReST spec, footnotes should be like: [#name], and not [name]. So, change them. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12[media] vidioc-g-dv-timings.rst: document interlaced definesHans Verkuil
Document V4L2_DV_PROGRESSIVE and V4L2_DV_INTERLACED and fix missing references. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12[media] pixfmt-006.rst: add missing V4L2_YCBCR_ENC_SMPTE240MHans Verkuil
Fix missing documentation, and its cross reference. Signed-off-by: Hans Verkuil <hans.verkuil@cisco.com> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-12[media] doc-rst: fix a missing reference for V4L2_BUF_FLAG_LASTMauro Carvalho Chehab
Fix it by adding a header to the flat-table to match to the list of define symbols. As a side-effect, it also removes some exceptions from videodev2.h.rst. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-10[media] doc-rst: improve display of notes and warningsMauro Carvalho Chehab
There are several notes and warning mesages in the middle of the media docbook. Use the ReST tags for that, as it makes them visually better and hightlights them. While here, modify a few ones to make them clearer. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-10[media] doc-rst: Don't use captions for examplesMauro Carvalho Chehab
Unfortunately, captions are new on Sphinx for c blocks: it was added only on version 1.3. Also, it were already bad enough not being able to auto-numerate them. So, let's give up and use, instead, titles before the examples. Not much is lost, and, as a side track, we don't need to numerate them anymore. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-10[media] doc-rst: remove an extra label on V4L2 and CEC partsMauro Carvalho Chehab
There's no need to say: Table of Contents there. Also, this generates a duplicated caption xref. So, remove, to use the same format on every part. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08[media] doc-rst: linux_tv CEC part, DocBook to reST migrationMarkus Heiser
This is the reST migration of media's CEC part. The migration is based on media_tree's cec branch: https://git.linuxtv.org/media_tree.git c7169ad * cec media_tree/cec [media] DocBook/media: add CEC documentation Signed-off-by: Markus Heiser <markus.heiser@darmarIT.de> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08[media] doc-rst: fix the Z16 format definitionMauro Carvalho Chehab
Changeset 811c6d6a4243 ("[media] V4L: fix the Z16 format definition") fixed the definition for DocBook, but we need to replicate it also to ReST. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08[media] doc-rst: mention the memory type to be set for all streaming I/OMauro Carvalho Chehab
Changeset 8c9f46095176 ("[media] DocBook: mention the memory type to be set for all streaming I/O") updated the media DocBook to mention the need of filling the memory types. We need to keep the ReST doc updated to such change. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08[media] doc-rst: add dmabuf as streaming I/O in VIDIOC_REQBUFS descriptionMauro Carvalho Chehab
Commit 707e65831d3b("[media] DocBook: add dmabuf as streaming I/O in VIDIOC_REQBUFS description") added DMABUF to reqbufs description, but, as we're migrating to ReST markup, we need to keep it in sync with the change. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
2016-07-08doc_rst: rename the media Sphinx suff to Documentation/mediaMauro Carvalho Chehab
The name of the subsystem is "media", and not "linux_tv". Also, as we plan to add other stuff there in the future, let's rename also the media uAPI book to media_uapi, to make it clearer. No functional changes. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>