diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-15 17:49:50 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-22 10:02:29 -0300 |
| commit | b6b6e67824ec0593878afbee5958d80205606210 (patch) | |
| tree | 433e204fb20bf108880513bfe0d67b4e6841e90e /Documentation/media/uapi/v4l/dev-overlay.rst | |
| parent | 187594418d37b29d02a22f5d15db51ea4df70957 (diff) | |
[media] docs-rst: better use the .. note:: tag
Change multi-line note tags to be more symetric, e. g. not starting
the text together witht the tag.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/v4l/dev-overlay.rst')
| -rw-r--r-- | Documentation/media/uapi/v4l/dev-overlay.rst | 8 |
1 files changed, 6 insertions, 2 deletions
diff --git a/Documentation/media/uapi/v4l/dev-overlay.rst b/Documentation/media/uapi/v4l/dev-overlay.rst index 92b4471b0c6e..d47a6bbc2e98 100644 --- a/Documentation/media/uapi/v4l/dev-overlay.rst +++ b/Documentation/media/uapi/v4l/dev-overlay.rst @@ -19,7 +19,9 @@ video into a window. Video overlay devices are accessed through the same character special files as :ref:`video capture <capture>` devices. -.. note:: The default function of a ``/dev/video`` device is video +.. note:: + + The default function of a ``/dev/video`` device is video capturing. The overlay function is only available after calling the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl. @@ -236,7 +238,9 @@ exceeded are undefined. [#f3]_ :ref:`VIDIOC_S_FBUF <VIDIOC_G_FBUF>`, :ref:`framebuffer-flags`). - .. note:: This field was added in Linux 2.6.23, extending the + .. note:: + + This field was added in Linux 2.6.23, extending the structure. However the :ref:`VIDIOC_[G|S|TRY]_FMT <VIDIOC_G_FMT>` ioctls, which take a pointer to a :ref:`v4l2_format <v4l2-format>` parent structure with padding bytes at the end, are not affected. |