summaryrefslogtreecommitdiffstats
path: root/Documentation/linux_tv/media/v4l/func-write.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab2016-07-05 12:58:48 +0200
committerMauro Carvalho Chehab2016-07-05 15:53:13 +0200
commit586027cefac593d1a17f86e2236694357ebc6670 (patch)
treee84d6cedfe2496b4b3c4ba4c2c2eb2640cd342fa /Documentation/linux_tv/media/v4l/func-write.rst
parentdoc-rst: linux_tv: split DVB function call documentation (diff)
downloadkernel-qcow2-linux-586027cefac593d1a17f86e2236694357ebc6670.tar.gz
kernel-qcow2-linux-586027cefac593d1a17f86e2236694357ebc6670.tar.xz
kernel-qcow2-linux-586027cefac593d1a17f86e2236694357ebc6670.zip
doc-rst: linux_tv: reformat all syscall pages
The syscall pages are written to be used also as man-pages. However, they don't match the format used by kernel-doc generated pages from DocBook. Rewrite them to match it. One side effect is that now all such pages at the book will have the same format, reducing the format differences between DVB and the other parts of the book. Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/linux_tv/media/v4l/func-write.rst')
-rw-r--r--Documentation/linux_tv/media/v4l/func-write.rst15
1 files changed, 8 insertions, 7 deletions
diff --git a/Documentation/linux_tv/media/v4l/func-write.rst b/Documentation/linux_tv/media/v4l/func-write.rst
index a4b093ba15c3..6609f191af76 100644
--- a/Documentation/linux_tv/media/v4l/func-write.rst
+++ b/Documentation/linux_tv/media/v4l/func-write.rst
@@ -6,12 +6,12 @@
V4L2 write()
************
-*man v4l2-write(2)*
+NAME
+====
-Write to a V4L2 device
+v4l2-write - Write to a V4L2 device
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,8 @@ Synopsis
.. cpp:function:: ssize_t write( int fd, void *buf, size_t count )
-Arguments
+
+ARGUMENTS
=========
``fd``
@@ -31,7 +32,7 @@ Arguments
``count``
-Description
+DESCRIPTION
===========
:ref:`write() <func-write>` writes up to ``count`` bytes to the device
@@ -46,7 +47,7 @@ Sliced Teletext or Closed Caption data is not repeated, the driver
inserts a blank line instead.
-Return Value
+RETURN VALUE
============
On success, the number of bytes written are returned. Zero indicates