diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-05 07:58:48 -0300 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-05 10:53:13 -0300 |
| commit | 586027cefac593d1a17f86e2236694357ebc6670 (patch) | |
| tree | e84d6cedfe2496b4b3c4ba4c2c2eb2640cd342fa /Documentation/linux_tv/media/dvb/video-stop.rst | |
| parent | 47d23e363fb034f32551f5fe85add77ceba98d3b (diff) | |
| download | lwn-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/dvb/video-stop.rst')
| -rw-r--r-- | Documentation/linux_tv/media/dvb/video-stop.rst | 34 |
1 files changed, 19 insertions, 15 deletions
diff --git a/Documentation/linux_tv/media/dvb/video-stop.rst b/Documentation/linux_tv/media/dvb/video-stop.rst index fd5288727911..2dbf464d85bb 100644 --- a/Documentation/linux_tv/media/dvb/video-stop.rst +++ b/Documentation/linux_tv/media/dvb/video-stop.rst @@ -2,28 +2,23 @@ .. _VIDEO_STOP: +========== VIDEO_STOP ========== -Description ------------ - -This ioctl is for DVB devices only. To control a V4L2 decoder use the -V4L2 :ref:`VIDIOC_DECODER_CMD` instead. +NAME +---- -This ioctl call asks the Video Device to stop playing the current -stream. Depending on the input parameter, the screen can be blanked out -or displaying the last decoded frame. +VIDEO_STOP -Synopsis +SYNOPSIS -------- .. c:function:: int ioctl(fd, int request = VIDEO_STOP, boolean mode) -Arguments ----------- - +ARGUMENTS +--------- .. flat-table:: :header-rows: 0 @@ -59,11 +54,20 @@ Arguments - FALSE: Show last decoded frame. -Return Value +DESCRIPTION +----------- + +This ioctl is for DVB devices only. To control a V4L2 decoder use the +V4L2 :ref:`VIDIOC_DECODER_CMD` instead. + +This ioctl call asks the Video Device to stop playing the current +stream. Depending on the input parameter, the screen can be blanked out +or displaying the last decoded frame. + + +RETURN VALUE ------------ On success 0 is returned, on error -1 and the ``errno`` variable is set appropriately. The generic error codes are described at the :ref:`Generic Error Codes <gen-errors>` chapter. - - |