mirrors/linux-stable
1
0
Fork 0
mirror of https://git.kernel.org/pub/scm/linux/kernel/git/stable/linux.git synced 2024-09-30 22:26:55 +00:00
Code Issues Releases Wiki Activity

doc-rst: FE_SET_FRONTEND: 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:22:09 -03:00
parent b1925f2e1c
commit d38395ab73
1 changed files with 10 additions and 8 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst
View file

@ -6,7 +6,8 @@
FE_SET_FRONTEND FE_SET_FRONTEND
*************** ***************
DESCRIPTION Description
-----------
This ioctl call starts a tuning operation using specified parameters. This ioctl call starts a tuning operation using specified parameters.
The result of this call will be successful if the parameters were valid The result of this call will be successful if the parameters were valid
@ -18,13 +19,13 @@ operation is initiated before the previous one was completed, the
previous operation will be aborted in favor of the new one. This command previous operation will be aborted in favor of the new one. This command
requires read/write access to the device. requires read/write access to the device.
SYNOPSIS Synopsis
--------
int ioctl(int fd, int request = .. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p)
:ref:`FE_SET_FRONTEND`, struct
dvb_frontend_parameters *p);
PARAMETERS Arguments
----------
@ -48,12 +49,13 @@ PARAMETERS
- .. row 3 - .. row 3
- struct dvb_frontend_parameters *p - struct dvb_frontend_parameters \*p
- Points to parameters for tuning operation. - Points to parameters for tuning operation.
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