From cf8076c31471f967080a5c77daac7582b0b6d63f Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Fri, 19 Aug 2016 16:56:15 -0300 Subject: [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 --- Documentation/media/uapi/dvb/ca-get-msg.rst | 30 +++++++---------------------- 1 file changed, 7 insertions(+), 23 deletions(-) (limited to 'Documentation/media/uapi/dvb/ca-get-msg.rst') diff --git a/Documentation/media/uapi/dvb/ca-get-msg.rst b/Documentation/media/uapi/dvb/ca-get-msg.rst index e0d2c8853e63..880995230909 100644 --- a/Documentation/media/uapi/dvb/ca-get-msg.rst +++ b/Documentation/media/uapi/dvb/ca-get-msg.rst @@ -15,40 +15,24 @@ CA_GET_MSG Synopsis -------- -.. c:function:: int ioctl(fd, int request = CA_GET_MSG, ca_msg_t *) +.. c:function:: int ioctl(fd, CA_GET_MSG, ca_msg_t *msg) + :name: CA_GET_MSG Arguments --------- -.. flat-table:: - :header-rows: 0 - :stub-columns: 0 +``fd`` + File descriptor returned by a previous call to :c:func:`open() `. - - - .. row 1 - - - int fd - - - File descriptor returned by a previous call to open(). - - - .. row 2 - - - int request - - - Equals CA_GET_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 -- cgit v1.2.3-59-g8ed1b