History

media: buffer.rst: clean up timecode documentation

V4L2_BUF_FLAG_TIMECODE is not video capture specific, so drop that part. The 'Timecodes' section was a bit messy, so that's cleaned up.

Hans Verkuil committed 8 years ago

Commit 0e9109f1 parent 96bddd51 file · +5 −6Browse files

Unified · Split

Documentation/media/uapi/v4l/buffer.rst+5−6
@@ -230,8 +230,7 @@ struct v4l2_buffer · 229 unmodified lines
230230 * - struct :c:type:`v4l2_timecode`
231231 - ``timecode``
232232 -
233− - When ``type`` is ``V4L2_BUF_TYPE_VIDEO_CAPTURE`` and the
234− ``V4L2_BUF_FLAG_TIMECODE`` flag is set in ``flags``, this
233+ - When the ``V4L2_BUF_FLAG_TIMECODE`` flag is set in ``flags``, this
235234 structure contains a frame timecode. In
236235 :c:type:`V4L2_FIELD_ALTERNATE <v4l2_field>` mode the top and
237236 bottom field contain the same timecode. Timecodes are intended to
@@ -714,10 +713,10 @@ enum v4l2_memory · 476 unmodified lines
714713 Timecodes
715714 =========
716715
717−The struct :c:type:`v4l2_timecode` structure is designed to hold a
718−:ref:`smpte12m` or similar timecode. (struct
719−struct :c:type:`timeval` timestamps are stored in struct
720−:c:type:`v4l2_buffer` field ``timestamp``.)
716+The :c:type:`v4l2_buffer_timecode` structure is designed to hold a
717+:ref:`smpte12m` or similar timecode.
718+(struct :c:type:`timeval` timestamps are stored in the struct
719+:c:type:`v4l2_buffer` ``timestamp`` field.)
721720
722721
723722 .. c:type:: v4l2_timecode