p71924506
/
linux_old1
1
0
Fork 0
Code Issues Pull Requests Projects Releases Wiki Activity

doc-rst: FE_READ_BER: 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>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-04 12:34:44 -03:00
parent 5d468e2baf
commit 9e1f61c057
1 changed files with 9 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
Documentation/linux_tv/media/dvb/FE_READ_BER.rst
View File

@ -6,7 +6,8 @@
FE_READ_BER FE_READ_BER
*********** ***********
DESCRIPTION Description
-----------
This ioctl call returns the bit error rate for the signal currently This ioctl call returns the bit error rate for the signal currently
received/demodulated by the front-end. For this command, read-only received/demodulated by the front-end. For this command, read-only
@ -14,10 +15,10 @@ access to the device is sufficient.
SYNOPSIS SYNOPSIS
int ioctl(int fd, int request = :ref:`FE_READ_BER`, .. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber)
uint32_t *ber);
PARAMETERS Arguments
----------
@ -40,12 +41,13 @@ PARAMETERS
- .. row 3 - .. row 3
- uint32_t *ber - uint32_t \*ber
- The bit error rate is stored into *ber. - The bit error rate is stored into \*ber.
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