diff options
| author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-19 21:56:15 +0200 |
|---|---|---|
| committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-23 02:23:34 +0200 |
| commit | cf8076c31471f967080a5c77daac7582b0b6d63f (patch) | |
| tree | ec205916c633cd6ecfff7516cf0eec65c219a886 /Documentation/media/uapi/dvb/fe-read-ber.rst | |
| parent | [media] docs-rst: Convert V4L2 uAPI to use C function references (diff) | |
| download | linux-cf8076c31471f967080a5c77daac7582b0b6d63f.tar.xz linux-cf8076c31471f967080a5c77daac7582b0b6d63f.zip | |
[media] docs-rst: Convert DVB uAPI to use C function references
Name all ioctl references and make them match the ioctls that
are documented. That will improve the cross-reference index,
as it will have all ioctls and syscalls there.
While here, improve the documentation, marking the deprecated
ioctls, and making the non-deprecated ones more like the rest
of the media book.
Also, add a notice for ioctls that still require documentation.
Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
Diffstat (limited to 'Documentation/media/uapi/dvb/fe-read-ber.rst')
| -rw-r--r-- | Documentation/media/uapi/dvb/fe-read-ber.rst | 30 |
1 files changed, 8 insertions, 22 deletions
diff --git a/Documentation/media/uapi/dvb/fe-read-ber.rst b/Documentation/media/uapi/dvb/fe-read-ber.rst index 3262441385ff..e54972ad5250 100644 --- a/Documentation/media/uapi/dvb/fe-read-ber.rst +++ b/Documentation/media/uapi/dvb/fe-read-ber.rst @@ -11,37 +11,23 @@ Name FE_READ_BER +.. attention:: This ioctl is deprecated. + Synopsis ======== -.. c:function:: int ioctl(int fd, int request = FE_READ_BER, uint32_t *ber) +.. c:function:: int ioctl(int fd, FE_READ_BER, uint32_t *ber) + :name: FE_READ_BER Arguments ========= -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 - - - - .. row 1 - - - int fd - - - File descriptor returned by a previous call to open(). - - - .. row 2 - - - int request - - - Equals :ref:`FE_READ_BER` for this command. - - - .. row 3 - - - uint32_t \*ber +``fd`` + File descriptor returned by :c:func:`open() <dvb-fe-open>`. - - The bit error rate is stored into \*ber. +``ber`` + The bit error rate is stored into \*ber. Description |