summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/v4l/dev-osd.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-15 17:49:50 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-22 10:02:29 -0300
commitb6b6e67824ec0593878afbee5958d80205606210 (patch)
tree433e204fb20bf108880513bfe0d67b4e6841e90e /Documentation/media/uapi/v4l/dev-osd.rst
parent187594418d37b29d02a22f5d15db51ea4df70957 (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-osd.rst')
-rw-r--r--Documentation/media/uapi/v4l/dev-osd.rst4
1 files changed, 3 insertions, 1 deletions
diff --git a/Documentation/media/uapi/v4l/dev-osd.rst b/Documentation/media/uapi/v4l/dev-osd.rst
index fadda131f020..4e1ee79ec334 100644
--- a/Documentation/media/uapi/v4l/dev-osd.rst
+++ b/Documentation/media/uapi/v4l/dev-osd.rst
@@ -16,7 +16,9 @@ this interface, which borrows structures and ioctls of the
The OSD function is accessible through the same character special file
as the :ref:`Video Output <capture>` function.
-.. note:: The default function of such a ``/dev/video`` device is video
+.. note::
+
+ The default function of such a ``/dev/video`` device is video
capturing or output. The OSD function is only available after calling
the :ref:`VIDIOC_S_FMT <VIDIOC_G_FMT>` ioctl.