1
0

[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>
This commit is contained in:
Mauro Carvalho Chehab
2016-08-19 16:56:15 -03:00
parent 41d804653e
commit cf8076c314
105 changed files with 470 additions and 1041 deletions

View File

@@ -15,40 +15,23 @@ DMX_GET_CAPS
Synopsis
--------
.. c:function:: int ioctl(fd, int request = DMX_GET_CAPS, dmx_caps_t *)
.. c:function:: int ioctl(fd, DMX_GET_CAPS, dmx_caps_t *caps)
:name: DMX_GET_CAPS
Arguments
---------
.. flat-table::
:header-rows: 0
:stub-columns: 0
``fd``
File descriptor returned by :c:func:`open() <dvb-dmx-open>`.
- .. row 1
- int fd
- File descriptor returned by a previous call to open().
- .. row 2
- int request
- Equals DMX_GET_CAPS for this command.
- .. row 3
- dmx_caps_t *
- Undocumented.
``caps``
Undocumented.
Description
-----------
This ioctl is undocumented. Documentation is welcome.
.. note:: This ioctl is undocumented. Documentation is welcome.
Return Value