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/ca-send-msg.rst | |
parent | 41d804653ec8aaee432bfd9a78f4c0e24553f5ab (diff) | |
download | linux-cf8076c31471f967080a5c77daac7582b0b6d63f.tar.bz2 |
[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/ca-send-msg.rst')
-rw-r--r-- | Documentation/media/uapi/dvb/ca-send-msg.rst | 30 |
1 files changed, 7 insertions, 23 deletions
diff --git a/Documentation/media/uapi/dvb/ca-send-msg.rst b/Documentation/media/uapi/dvb/ca-send-msg.rst index 5e4fd4f7b683..0c42b10cf4f4 100644 --- a/Documentation/media/uapi/dvb/ca-send-msg.rst +++ b/Documentation/media/uapi/dvb/ca-send-msg.rst @@ -15,40 +15,24 @@ CA_SEND_MSG Synopsis -------- -.. c:function:: int ioctl(fd, int request = CA_SEND_MSG, ca_msg_t *) +.. c:function:: int ioctl(fd, CA_SEND_MSG, ca_msg_t *msg) + :name: CA_SEND_MSG Arguments --------- -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 +``fd`` + File descriptor returned by a previous call to :c:func:`open() <cec-open>`. - - - .. row 1 - - - int fd - - - File descriptor returned by a previous call to open(). - - - .. row 2 - - - int request - - - Equals CA_SEND_MSG for this command. - - - .. row 3 - - - ca_msg_t \* - - - Undocumented. +``msg`` + Undocumented. Description ----------- -This ioctl is undocumented. Documentation is welcome. +.. note:: This ioctl is undocumented. Documentation is welcome. Return Value |