diff options
author | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-19 16:56:15 -0300 |
---|---|---|
committer | Mauro Carvalho Chehab <mchehab@s-opensource.com> | 2016-08-22 21:23:34 -0300 |
commit | cf8076c31471f967080a5c77daac7582b0b6d63f (patch) | |
tree | ec205916c633cd6ecfff7516cf0eec65c219a886 /Documentation/media/uapi/dvb/dmx-fwrite.rst | |
parent | 41d804653ec8aaee432bfd9a78f4c0e24553f5ab (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-fwrite.rst')
-rw-r--r-- | Documentation/media/uapi/dvb/dmx-fwrite.rst | 30 |
1 files changed, 7 insertions, 23 deletions
diff --git a/Documentation/media/uapi/dvb/dmx-fwrite.rst b/Documentation/media/uapi/dvb/dmx-fwrite.rst index c05a44c4535f..8a90dfe28307 100644 --- a/Documentation/media/uapi/dvb/dmx-fwrite.rst +++ b/Documentation/media/uapi/dvb/dmx-fwrite.rst @@ -16,34 +16,19 @@ Synopsis -------- .. c:function:: ssize_t write(int fd, const void *buf, size_t count) - + :name: dvb-dmx-write Arguments --------- -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 +``fd`` + File descriptor returned by a previous call to :c:func:`open() <dvb-ca-open>`. +``buf`` + Buffer with data to be written - - .. row 1 - - - int fd - - - File descriptor returned by a previous call to open(). - - - .. row 2 - - - void \*buf - - - Pointer to the buffer containing the Transport Stream. - - - .. row 3 - - - size_t count - - - Size of buf. - +``count`` + Number of bytes at the buffer Description ----------- @@ -65,7 +50,6 @@ Return Value :header-rows: 0 :stub-columns: 0 - - .. row 1 - ``EWOULDBLOCK`` |