[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: Mauro Carvalho Chehab <mchehab@s-opensource.com>
This commit is contained in:
Mauro Carvalho Chehab 2016-07-12 09:35:26 -03:00
parent 048eb3ef75
commit bd6a63f2e6
6 changed files with 24 additions and 12 deletions

View File

@ -0,0 +1,14 @@
.. -*- coding: utf-8; mode: rst -*-
.. _lirc_dev:
LIRC Device Interface
=====================
.. toctree::
:maxdepth: 1
lirc-dev-intro
lirc-func
lirc-header

View File

@ -1,17 +1,16 @@
.. -*- 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

View File

@ -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>`__

View File

@ -23,8 +23,7 @@ Remote Controllers
rc-sysfs-nodes rc-sysfs-nodes
rc-tables rc-tables
rc-table-change rc-table-change
lirc_device_interface lirc-dev
lirc-header
********************** **********************