diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-04 17:22:09 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-07-04 17:22:51 +0200 |
| commit | d38395ab7329ac2f91747eacbb65d2237a9523be (patch) | |
| tree | b89327031bb100aadae6b6040196c21c4d4b412e | |
| parent | doc-rst: audio_function_calls: improve man-like format (diff) | |
| download | linux-d38395ab7329ac2f91747eacbb65d2237a9523be.tar.xz linux-d38395ab7329ac2f91747eacbb65d2237a9523be.zip | |
doc-rst: FE_SET_FRONTEND: improve man-like format
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>
| -rw-r--r-- | Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst | 18 |
1 files changed, 10 insertions, 8 deletions
diff --git a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst index 794089897845..38e3971825ea 100644 --- a/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst +++ b/Documentation/linux_tv/media/dvb/FE_SET_FRONTEND.rst @@ -6,7 +6,8 @@ FE_SET_FRONTEND *************** -DESCRIPTION +Description +----------- This ioctl call starts a tuning operation using specified parameters. 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 requires read/write access to the device. -SYNOPSIS +Synopsis +-------- -int ioctl(int fd, int request = -:ref:`FE_SET_FRONTEND`, struct -dvb_frontend_parameters *p); +.. c:function:: int ioctl(int fd, int request = FE_SET_FRONTEND, struct dvb_frontend_parameters *p) -PARAMETERS +Arguments +---------- @@ -48,12 +49,13 @@ PARAMETERS - .. row 3 - - struct dvb_frontend_parameters *p + - struct dvb_frontend_parameters \*p - Points to parameters for tuning operation. -RETURN VALUE +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 |