Commit bd6a63f2 authored by Mauro Carvalho Chehab's avatar Mauro Carvalho Chehab
Browse files

[media] doc-rst: reorganize LIRC ReST files 



Reorganize the LIRC rst files, using "-" instead of "_" on
their names, and creating a separate chapter for syscalls.

Signed-off-by: default avatarMauro Carvalho Chehab <mchehab@s-opensource.com>
parent 048eb3ef

Documentation/media/uapi/rc/lirc-dev.rst

0 → 100644
+14 −0
Original line number Original line Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-



.. _lirc_dev:



LIRC Device Interface

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





.. toctree::

    :maxdepth: 1



    lirc-dev-intro

    lirc-func

    lirc-header

Documentation/media/uapi/rc/lirc_device_interface.rst→Documentation/media/uapi/rc/lirc-func.rst

+5 −6
Original line number Original line Diff line number Diff line 
.. -*- coding: utf-8; mode: rst -*-

.. -*- coding: utf-8; mode: rst -*-





.. _lirc_dev:

.. _lirc_func:





LIRC Device Interface

LIRC Function Reference

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

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









.. toctree::

.. toctree::

    :maxdepth: 1

    :maxdepth: 1





    lirc_dev_intro

    lirc-read

    lirc_read

    lirc-write

    lirc_write

    lirc-get-features

    lirc-get-features

    lirc-get-send-mode

    lirc-get-send-mode

    lirc-get-rec-mode

    lirc-get-rec-mode

Documentation/media/uapi/rc/lirc_read.rst→Documentation/media/uapi/rc/lirc-read.rst

+4 −4
Original line number Original line Diff line number Diff line
@@ -44,10 +44,10 @@ is greater than ``SSIZE_MAX``, the result is unspecified. 
The lircd userspace daemon reads raw IR data from the LIRC chardev. The

The lircd userspace daemon reads raw IR data from the LIRC chardev. The

exact format of the data depends on what modes a driver supports, and

exact format of the data depends on what modes a driver supports, and

what mode has been selected. lircd obtains supported modes and sets the

what mode has been selected. lircd obtains supported modes and sets the

active mode via the ioctl interface, detailed at :ref:`lirc_ioctl`.

active mode via the ioctl interface, detailed at :ref:`lirc_func`.

The generally preferred mode is LIRC_MODE_MODE2, in which packets

The generally preferred mode for receive is

containing an int value describing an IR signal are read from the

:ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`, in which packets containing an

chardev.

int value describing an IR signal are read from the chardev.





See also

See also

`http://www.lirc.org/html/technical.html <http://www.lirc.org/html/technical.html>`__

`http://www.lirc.org/html/technical.html <http://www.lirc.org/html/technical.html>`__