AuxXxilium/linux_dsm_epyc7002
1
0
Fork 0
mirror of https://github.com/AuxXxilium/linux_dsm_epyc7002.git synced 2024-12-23 04:17:58 +07:00
Code Issues Actions Packages Projects Releases Wiki Activity

doc-rst: FE_GET_EVENT: improve man-like format

Browse Source 
Parsing this file were causing lots of warnings with sphinx,
due to the c function prototypes.

Fix that by prepending them with .. c:function::

While here, use the same way we document man-like pages,
at the V4L side of the book and add escapes to asterisks.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-04 12:39:49 -03:00
parent d090484c76
commit e3a54ab8ce
1 changed files with 9 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
Documentation/linux_tv/media/dvb/FE_GET_EVENT.rst
View File

@ -6,7 +6,8 @@
FE_GET_EVENT FE_GET_EVENT
************ ************
DESCRIPTION Description
-----------
This ioctl call returns a frontend event if available. If an event is This ioctl call returns a frontend event if available. If an event is
not available, the behavior depends on whether the device is in blocking not available, the behavior depends on whether the device is in blocking
@ -14,12 +15,13 @@ or non-blocking mode. In the latter case, the call fails immediately
with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until with errno set to ``EWOULDBLOCK``. In the former case, the call blocks until
an event becomes available. an event becomes available.
SYNOPSIS Synopsis
--------
int ioctl(int fd, int request = QPSK_GET_EVENT, struct .. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev)
dvb_frontend_event *ev);
PARAMETERS Arguments
----------
@ -52,7 +54,8 @@ PARAMETERS
- if any, is to be stored. - if any, is to be stored.
RETURN VALUE Return Value
------------
On success 0 is returned, on error -1 and the ``errno`` variable is set On success 0 is returned, on error -1 and the ``errno`` variable is set
appropriately. The generic error codes are described at the appropriately. The generic error codes are described at the