]> git.karo-electronics.de Git - linux-beck.git/commitdiff
doc-rst: FE_READ_SIGNAL_STRENGTH: improve man-like format
authorMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 4 Jul 2016 15:31:15 +0000 (12:31 -0300)
committerMauro Carvalho Chehab <mchehab@s-opensource.com>
Mon, 4 Jul 2016 15:31:15 +0000 (12:31 -0300)
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>
Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst

index d2dd0fba5363570ec4f40b1570b8d4ae8d946c57..2a3342dc39a220f903bd6bcbd331d5d105658842 100644 (file)
@@ -6,19 +6,20 @@
 FE_READ_SIGNAL_STRENGTH
 ***********************
 
-DESCRIPTION
+Description
+-----------
 
 This ioctl call returns the signal strength value for the signal
 currently received by the front-end. For this command, read-only access
 to the device is sufficient.
 
-SYNOPSIS
+Synopsis
+--------
 
-int ioctl( int fd, int request =
-:ref:`FE_READ_SIGNAL_STRENGTH`,
-uint16_t *strength);
+.. c:function:: int ioctl( int fd, int request = FE_READ_SIGNAL_STRENGTH, uint16_t *strength)
 
-PARAMETERS
+Arguments
+----------
 
 
 
@@ -43,12 +44,13 @@ PARAMETERS
 
     -  .. row 3
 
-       -  uint16_t *strength
+       -  uint16_t \*strength
 
-       -  The signal strength value is stored into *strength.
+       -  The signal strength value is stored into \*strength.
 
 
-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