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/fe-get-event.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/fe-get-event.rst')
-rw-r--r-- | Documentation/media/uapi/dvb/fe-get-event.rst | 35 |
1 files changed, 8 insertions, 27 deletions
diff --git a/Documentation/media/uapi/dvb/fe-get-event.rst b/Documentation/media/uapi/dvb/fe-get-event.rst index 79beb1b9da3b..8a719c33073d 100644 --- a/Documentation/media/uapi/dvb/fe-get-event.rst +++ b/Documentation/media/uapi/dvb/fe-get-event.rst @@ -11,43 +11,24 @@ Name FE_GET_EVENT +.. attention:: This ioctl is deprecated. + Synopsis ======== -.. c:function:: int ioctl(int fd, int request = QPSK_GET_EVENT, struct dvb_frontend_event *ev) +.. c:function:: int ioctl(int fd, FE_GET_EVENT, struct dvb_frontend_event *ev) + :name: FE_GET_EVENT 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_GET_EVENT` for this command. - - - .. row 3 - - - struct dvb_frontend_event \*ev - - - Points to the location where the event, - - - .. row 4 +``fd`` + File descriptor returned by :c:func:`open() <dvb-fe-open>`. - - - - if any, is to be stored. +``ev`` + Points to the location where the event, if any, is to be stored. Description |