Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 5ccbb182 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[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: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 15c19014

Documentation/media/uapi/mediactl/media-func-close.rst

+2 −2
Original line number Original line Diff line number Diff line
@@ -21,13 +21,13 @@ Synopsis 








.. c:function:: int close( int fd )

.. c:function:: int close( int fd )



    :name: mc-close





Arguments

Arguments

=========

=========





``fd``

``fd``

    File descriptor returned by :ref:`open() <func-open>`.

    File descriptor returned by :c:func:`open() <mc-open>`.









Description

Description

Documentation/media/uapi/mediactl/media-func-ioctl.rst

+2 −2
Original line number Original line Diff line number Diff line
@@ -21,13 +21,13 @@ Synopsis 








.. c:function:: int ioctl( int fd, int request, void *argp )

.. c:function:: int ioctl( int fd, int request, void *argp )



    :name: mc-ioctl





Arguments

Arguments

=========

=========





``fd``

``fd``

    File descriptor returned by :ref:`open() <func-open>`.

    File descriptor returned by :c:func:`open() <mc-open>`.





``request``

``request``

    Media ioctl request code as defined in the media.h header file, for

    Media ioctl request code as defined in the media.h header file, for

Documentation/media/uapi/mediactl/media-func-open.rst

+1 −1
Original line number Original line Diff line number Diff line
@@ -21,7 +21,7 @@ Synopsis 








.. c:function:: int open( const char *device_name, int flags )

.. c:function:: int open( const char *device_name, int flags )



    :name: mc-open





Arguments

Arguments

=========

=========

Documentation/media/uapi/mediactl/media-ioc-device-info.rst

+2 −4
Original line number Original line Diff line number Diff line
@@ -15,7 +15,8 @@ MEDIA_IOC_DEVICE_INFO - Query device information 
Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, struct media_device_info *argp )

.. c:function:: int ioctl( int fd, MEDIA_IOC_DEVICE_INFO, struct media_device_info *argp )

    :name: MEDIA_IOC_DEVICE_INFO









Arguments

Arguments
@@ -24,9 +25,6 @@ Arguments 
``fd``

``fd``

    File descriptor returned by :ref:`open() <media-func-open>`.

    File descriptor returned by :ref:`open() <media-func-open>`.





``request``

    MEDIA_IOC_DEVICE_INFO



``argp``

``argp``

Documentation/media/uapi/mediactl/media-ioc-enum-entities.rst

+2 −4
Original line number Original line Diff line number Diff line
@@ -15,7 +15,8 @@ MEDIA_IOC_ENUM_ENTITIES - Enumerate entities and their properties 
Synopsis

Synopsis

========

========





.. c:function:: int ioctl( int fd, int request, struct media_entity_desc *argp )

.. c:function:: int ioctl( int fd, MEDIA_IOC_ENUM_ENTITIES, struct media_entity_desc *argp )

    :name: MEDIA_IOC_ENUM_ENTITIES









Arguments

Arguments
@@ -24,9 +25,6 @@ Arguments 
``fd``

``fd``

    File descriptor returned by :ref:`open() <media-func-open>`.

    File descriptor returned by :ref:`open() <media-func-open>`.





``request``

    MEDIA_IOC_ENUM_ENTITIES



``argp``

``argp``