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@xxxxxxxxxxxxxxxx>
---
Documentation/linux_tv/media/dvb/FE_READ_SNR.rst | 19 +++++++++++--------
1 file changed, 11 insertions(+), 8 deletions(-)
diff --git a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
index 2f9759a310f0..11b4f72d684e 100644
--- a/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
+++ b/Documentation/linux_tv/media/dvb/FE_READ_SNR.rst
@@ -6,18 +6,20 @@
FE_READ_SNR
***********
-DESCRIPTION
+Description
+-----------
This ioctl call returns the signal-to-noise ratio 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_SNR`,
-uint16_t *snr);
+.. c:function:: int ioctl(int fd, int request = FE_READ_SNR, int16_t *snr)
-PARAMETERS
+Arguments
+----------
@@ -40,12 +42,13 @@ PARAMETERS
- .. row 3
- - uint16_t *snr
+ - uint16_t \*snr
- - The signal-to-noise ratio is stored into *snr.
+ - The signal-to-noise ratio is stored into \*snr.
-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 majordomo@xxxxxxxxxxxxxxx
More majordomo info at http://vger.kernel.org/majordomo-info.html
