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 <mche...@s-opensource.com>
---
.../linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst | 20 +++++++++++---------
1 file changed, 11 insertions(+), 9 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
index d2dd0fba5363..2a3342dc39a2 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SIGNAL_STRENGTH.rst
@@ -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
--
2.7.4
--
To unsubscribe from this list: send the line "unsubscribe linux-media" in
the body of a message to majord...@vger.kernel.org
More majordomo info at http://vger.kernel.org/majordomo-info.html
