summaryrefslogtreecommitdiff
path: root/Documentation/media/uapi/dvb/dmx-fopen.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-fopen.rst
parent41d804653ec8aaee432bfd9a78f4c0e24553f5ab (diff)
[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-fopen.rst')
-rw-r--r--Documentation/media/uapi/dvb/dmx-fopen.rst43
1 files changed, 17 insertions, 26 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-fopen.rst b/Documentation/media/uapi/dvb/dmx-fopen.rst
index 7e640fa860c3..a697e33c32ea 100644
--- a/Documentation/media/uapi/dvb/dmx-fopen.rst
+++ b/Documentation/media/uapi/dvb/dmx-fopen.rst
@@ -16,42 +16,33 @@ Synopsis
--------
.. c:function:: int open(const char *deviceName, int flags)
-
+ :name: dvb-dmx-open
Arguments
---------
+``name``
+ Name of specific DVB demux device.
+
+``flags``
+ A bit-wise OR of the following flags:
+
.. flat-table::
:header-rows: 0
:stub-columns: 0
+ -
+ - O_RDONLY
+ - read-only access
- - .. row 1
-
- - const char \*deviceName
-
- - Name of demux device.
-
- - .. row 2
-
- - int flags
-
- - A bit-wise OR of the following flags:
-
- - .. row 3
-
- -
- - O_RDWR read/write access
-
- - .. row 4
-
- -
- - O_NONBLOCK open in non-blocking mode
-
- - .. row 5
+ -
+ - O_RDWR
+ - read/write access
- -
- - (blocking mode is the default)
+ -
+ - O_NONBLOCK
+ - open in non-blocking mode
+ (blocking mode is the default)
Description