summaryrefslogtreecommitdiff
path: root/Documentation/linux_tv/media/v4l/func-poll.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-05 07:58:48 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-05 10:53:13 -0300
commit586027cefac593d1a17f86e2236694357ebc6670 (patch)
treee84d6cedfe2496b4b3c4ba4c2c2eb2640cd342fa /Documentation/linux_tv/media/v4l/func-poll.rst
parent47d23e363fb034f32551f5fe85add77ceba98d3b (diff)
downloadlwn-586027cefac593d1a17f86e2236694357ebc6670.tar.gz
lwn-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-poll.rst')
-rw-r--r--Documentation/linux_tv/media/v4l/func-poll.rst18
1 files changed, 12 insertions, 6 deletions
diff --git a/Documentation/linux_tv/media/v4l/func-poll.rst b/Documentation/linux_tv/media/v4l/func-poll.rst
index 27f381d75de1..8632e05ff5b2 100644
--- a/Documentation/linux_tv/media/v4l/func-poll.rst
+++ b/Documentation/linux_tv/media/v4l/func-poll.rst
@@ -6,12 +6,12 @@
V4L2 poll()
***********
-*man v4l2-poll(2)*
+NAME
+====
-Wait for some event on a file descriptor
+v4l2-poll - Wait for some event on a file descriptor
-
-Synopsis
+SYNOPSIS
========
.. code-block:: c
@@ -21,7 +21,13 @@ Synopsis
.. cpp:function:: int poll( struct pollfd *ufds, unsigned int nfds, int timeout )
-Description
+
+ARGUMENTS
+=========
+
+
+
+DESCRIPTION
===========
With the :ref:`poll() <func-poll>` function applications can suspend execution
@@ -84,7 +90,7 @@ function.
For more details see the :ref:`poll() <func-poll>` manual page.
-Return Value
+RETURN VALUE
============
On success, :ref:`poll() <func-poll>` returns the number structures which have