Commit 9de499fe authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

doc-rst: FE_READ_UNCORRECTED_BLOCKS: 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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent d38395ab

Documentation/linux_tv/media/dvb/FE_READ_UNCORRECTED_BLOCKS.rst

+10 −8
Original line number Diff line number Diff line
@@ -6,7 +6,8 @@ 
FE_READ_UNCORRECTED_BLOCKS

**************************



DESCRIPTION

Description

-----------



This ioctl call returns the number of uncorrected blocks detected by the

device driver during its lifetime. For meaningful measurements, the
@@ -14,13 +15,13 @@ increment in block count during a specific time interval should be 
calculated. For this command, read-only access to the device is

sufficient.



SYNOPSIS

Synopsis

--------



int ioctl( int fd, int request =

:ref:`FE_READ_UNCORRECTED_BLOCKS`,

uint32_t *ublocks);

.. c:function:: int ioctl( int fd, int request =FE_READ_UNCORRECTED_BLOCKS, uint32_t *ublocks)



PARAMETERS

Arguments

----------
@@ -45,12 +46,13 @@ PARAMETERS 


    -  .. row 3



       -  uint32_t *ublocks

       -  uint32_t \*ublocks



       -  The total number of uncorrected blocks seen by the driver so far.





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