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

media: docs: make RC documents more compatible with Sphinx 3.1+ 



Sphinx 3.x broke support for the cdomain.py extension, as the
c domain code was rewritten. Due to that, the c tags need to
be re-written, in order to use the new c domain notation.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab+huawei@kernel.org>
parent 937e6805

Documentation/userspace-api/media/rc/lirc-get-features.rst

+4 −5
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

.. c:namespace:: RC



.. _lirc_get_features:
@@ -14,8 +15,9 @@ LIRC_GET_FEATURES - Get the underlying hardware device's features 
Synopsis

========



.. c:function:: int ioctl( int fd, LIRC_GET_FEATURES, __u32 *features)

    :name: LIRC_GET_FEATURES

.. c:macro:: LIRC_GET_FEATURES



``int ioctl(int fd, LIRC_GET_FEATURES, __u32 *features)``



Arguments

=========
@@ -26,11 +28,9 @@ Arguments 
``features``

    Bitmask with the LIRC features.





Description

===========





Get the underlying hardware device's features. If a driver does not

announce support of certain features, calling of the corresponding ioctls

is undefined.
@@ -184,7 +184,6 @@ LIRC features 


    Unused. Kept just to avoid breaking uAPI.





Return Value

============

Documentation/userspace-api/media/rc/lirc-get-rec-mode.rst

+7 −5
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

.. c:namespace:: RC



.. _lirc_get_rec_mode:

.. _lirc_set_rec_mode:
@@ -15,11 +16,13 @@ LIRC_GET_REC_MODE/LIRC_SET_REC_MODE - Get/set current receive mode. 
Synopsis

========



.. c:function:: int ioctl( int fd, LIRC_GET_REC_MODE, __u32 *mode)

	:name: LIRC_GET_REC_MODE

.. c:macro:: LIRC_GET_REC_MODE



.. c:function:: int ioctl( int fd, LIRC_SET_REC_MODE, __u32 *mode)

	:name: LIRC_SET_REC_MODE

``int ioctl(int fd, LIRC_GET_REC_MODE, __u32 *mode)``



.. c:macro:: LIRC_SET_REC_MODE



``int ioctl(int fd, LIRC_SET_REC_MODE, __u32 *mode)``



Arguments

=========
@@ -47,7 +50,6 @@ Return Value 
    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  ``ENODEV``

Documentation/userspace-api/media/rc/lirc-get-rec-resolution.rst

+4 −4
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

.. c:namespace:: RC



.. _lirc_get_rec_resolution:
@@ -14,8 +15,9 @@ LIRC_GET_REC_RESOLUTION - Obtain the value of receive resolution, in microsecond 
Synopsis

========



.. c:function:: int ioctl( int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)

    :name: LIRC_GET_REC_RESOLUTION

.. c:macro:: LIRC_GET_REC_RESOLUTION



``int ioctl(int fd, LIRC_GET_REC_RESOLUTION, __u32 *microseconds)``



Arguments

=========
@@ -26,7 +28,6 @@ Arguments 
``microseconds``

    Resolution, in microseconds.





Description

===========
@@ -38,7 +39,6 @@ This ioctl returns the integer value with such resolution, with can be 
used by userspace applications like lircd to automatically adjust the

tolerance value.





Return Value

============

Documentation/userspace-api/media/rc/lirc-get-send-mode.rst

+7 −7
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

.. c:namespace:: RC



.. _lirc_get_send_mode:

.. _lirc_set_send_mode:
@@ -15,11 +16,13 @@ LIRC_GET_SEND_MODE/LIRC_SET_SEND_MODE - Get/set current transmit mode. 
Synopsis

========



.. c:function:: int ioctl( int fd, LIRC_GET_SEND_MODE, __u32 *mode )

    :name: LIRC_GET_SEND_MODE

.. c:macro:: LIRC_GET_SEND_MODE



.. c:function:: int ioctl( int fd, LIRC_SET_SEND_MODE, __u32 *mode )

    :name: LIRC_SET_SEND_MODE

``int ioctl(int fd, LIRC_GET_SEND_MODE, __u32 *mode)``



.. c:macro:: LIRC_SET_SEND_MODE



``int ioctl(int fd, LIRC_SET_SEND_MODE, __u32 *mode)``



Arguments

=========
@@ -30,7 +33,6 @@ Arguments 
``mode``

    The mode used for transmitting.





Description

===========
@@ -44,14 +46,12 @@ modes the driver supports. 
Return Value

============





.. tabularcolumns:: |p{2.5cm}|p{15.0cm}|



.. flat-table::

    :header-rows:  0

    :stub-columns: 0





    -  .. row 1



       -  ``ENODEV``

Documentation/userspace-api/media/rc/lirc-get-timeout.rst

+7 −6
Original line number Diff line number Diff line 
.. SPDX-License-Identifier: GFDL-1.1-no-invariants-or-later

.. c:namespace:: RC



.. _lirc_get_min_timeout:

.. _lirc_get_max_timeout:
@@ -16,11 +17,13 @@ range for IR receive. 
Synopsis

========



.. c:function:: int ioctl( int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)

    :name: LIRC_GET_MIN_TIMEOUT

.. c:macro:: LIRC_GET_MIN_TIMEOUT



.. c:function:: int ioctl( int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)

    :name: LIRC_GET_MAX_TIMEOUT

``int ioctl(int fd, LIRC_GET_MIN_TIMEOUT, __u32 *timeout)``



.. c:macro:: LIRC_GET_MAX_TIMEOUT



``int ioctl(int fd, LIRC_GET_MAX_TIMEOUT, __u32 *timeout)``



Arguments

=========
@@ -31,7 +34,6 @@ Arguments 
``timeout``

    Timeout, in microseconds.





Description

===========
@@ -47,7 +49,6 @@ that can be set. 
   both ioctls will return the same value even though the timeout

   cannot be changed via :ref:`LIRC_SET_REC_TIMEOUT`.





Return Value

============