summaryrefslogtreecommitdiffstats
path: root/Documentation/media/uapi/dvb/dmx-fread.rst
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-19 16:56:15 -0300
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-08-22 21:23:34 -0300
commitcf8076c31471f967080a5c77daac7582b0b6d63f (patch)
treeec205916c633cd6ecfff7516cf0eec65c219a886 /Documentation/media/uapi/dvb/dmx-fread.rst
parent41d804653ec8aaee432bfd9a78f4c0e24553f5ab (diff)
downloadop-kernel-dev-cf8076c31471f967080a5c77daac7582b0b6d63f.zip
op-kernel-dev-cf8076c31471f967080a5c77daac7582b0b6d63f.tar.gz
[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/dmx-fread.rst')
-rw-r--r--Documentation/media/uapi/dvb/dmx-fread.rst29
1 files changed, 7 insertions, 22 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-fread.rst b/Documentation/media/uapi/dvb/dmx-fread.rst
index efa2a01..e8c7f4d 100644
--- a/Documentation/media/uapi/dvb/dmx-fread.rst
+++ b/Documentation/media/uapi/dvb/dmx-fread.rst
@@ -16,34 +16,19 @@ Synopsis
--------
.. c:function:: size_t read(int fd, void *buf, size_t count)
-
+ :name: dvb-dmx-read
Arguments
---------
-.. flat-table::
- :header-rows: 0
- :stub-columns: 0
-
-
- - .. row 1
-
- - int fd
-
- - File descriptor returned by a previous call to open().
-
- - .. row 2
-
- - void \*buf
-
- - Pointer to the buffer to be used for returned filtered data.
-
- - .. row 3
-
- - size_t count
+``fd``
+ File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`.
- - Size of buf.
+ ``buf``
+ Buffer to be filled
+``count``
+ Max number of bytes to read
Description
-----------
OpenPOWER on IntegriCloud