Linux kernel mirror (for testing) git.kernel.org/pub/scm/linux/kernel/git/torvalds/linux.git
kernel os linux

[media] docs-rst: Convert MC 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 to make them to look more
like the rest of the document.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

+15 -25
+2 -2
Documentation/media/uapi/mediactl/media-func-close.rst
··· 21 21 22 22 23 23 .. c:function:: int close( int fd ) 24 - 24 + :name: mc-close 25 25 26 26 Arguments 27 27 ========= 28 28 29 29 ``fd`` 30 - File descriptor returned by :ref:`open() <func-open>`. 30 + File descriptor returned by :c:func:`open() <mc-open>`. 31 31 32 32 33 33 Description
+2 -2
Documentation/media/uapi/mediactl/media-func-ioctl.rst
··· 21 21 22 22 23 23 .. c:function:: int ioctl( int fd, int request, void *argp ) 24 - 24 + :name: mc-ioctl 25 25 26 26 Arguments 27 27 ========= 28 28 29 29 ``fd`` 30 - File descriptor returned by :ref:`open() <func-open>`. 30 + File descriptor returned by :c:func:`open() <mc-open>`. 31 31 32 32 ``request`` 33 33 Media ioctl request code as defined in the media.h header file, for
+1 -1
Documentation/media/uapi/mediactl/media-func-open.rst
··· 21 21 22 22 23 23 .. c:function:: int open( const char *device_name, int flags ) 24 - 24 + :name: mc-open 25 25 26 26 Arguments 27 27 =========
+2 -4
Documentation/media/uapi/mediactl/media-ioc-device-info.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, struct media_device_info *argp ) 18 + .. c:function:: int ioctl( int fd, MEDIA_IOC_DEVICE_INFO, struct media_device_info *argp ) 19 + :name: MEDIA_IOC_DEVICE_INFO 19 20 20 21 21 22 Arguments ··· 24 23 25 24 ``fd`` 26 25 File descriptor returned by :ref:`open() <media-func-open>`. 27 - 28 - ``request`` 29 - MEDIA_IOC_DEVICE_INFO 30 26 31 27 ``argp`` 32 28
+2 -4
Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, struct media_entity_desc *argp ) 18 + .. c:function:: int ioctl( int fd, MEDIA_IOC_ENUM_ENTITIES, struct media_entity_desc *argp ) 19 + :name: MEDIA_IOC_ENUM_ENTITIES 19 20 20 21 21 22 Arguments ··· 24 23 25 24 ``fd`` 26 25 File descriptor returned by :ref:`open() <media-func-open>`. 27 - 28 - ``request`` 29 - MEDIA_IOC_ENUM_ENTITIES 30 26 31 27 ``argp`` 32 28
+2 -4
Documentation/media/uapi/mediactl/media-ioc-enum-links.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, struct media_links_enum *argp ) 18 + .. c:function:: int ioctl( int fd, MEDIA_IOC_ENUM_LINKS, struct media_links_enum *argp ) 19 + :name: MEDIA_IOC_ENUM_LINKS 19 20 20 21 21 22 Arguments ··· 24 23 25 24 ``fd`` 26 25 File descriptor returned by :ref:`open() <media-func-open>`. 27 - 28 - ``request`` 29 - MEDIA_IOC_ENUM_LINKS 30 26 31 27 ``argp`` 32 28
+2 -4
Documentation/media/uapi/mediactl/media-ioc-g-topology.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, struct media_v2_topology *argp ) 18 + .. c:function:: int ioctl( int fd, MEDIA_IOC_G_TOPOLOGY, struct media_v2_topology *argp ) 19 + :name: MEDIA_IOC_G_TOPOLOGY 19 20 20 21 21 22 Arguments ··· 24 23 25 24 ``fd`` 26 25 File descriptor returned by :ref:`open() <media-func-open>`. 27 - 28 - ``request`` 29 - MEDIA_IOC_G_TOPOLOGY 30 26 31 27 ``argp`` 32 28
+2 -4
Documentation/media/uapi/mediactl/media-ioc-setup-link.rst
··· 15 15 Synopsis 16 16 ======== 17 17 18 - .. c:function:: int ioctl( int fd, int request, struct media_link_desc *argp ) 18 + .. c:function:: int ioctl( int fd, MEDIA_IOC_SETUP_LINK, struct media_link_desc *argp ) 19 + :name: MEDIA_IOC_SETUP_LINK 19 20 20 21 21 22 Arguments ··· 24 23 25 24 ``fd`` 26 25 File descriptor returned by :ref:`open() <media-func-open>`. 27 - 28 - ``request`` 29 - MEDIA_IOC_SETUP_LINK 30 26 31 27 ``argp`` 32 28