summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-12 14:35:26 +0200
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-12 14:43:04 +0200
commitbd6a63f2e69ea16851a99b200cd2039186173775 (patch)
tree847ea21e7790244cc946d1d551658888714e28be
parent[media] doc-rst: document LIRC set mode ioctls (diff)
downloadlinux-bd6a63f2e69ea16851a99b200cd2039186173775.tar.xz
linux-bd6a63f2e69ea16851a99b200cd2039186173775.zip
[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>
-rw-r--r--Documentation/media/uapi/rc/lirc-dev-intro.rst (renamed from Documentation/media/uapi/rc/lirc_dev_intro.rst)0
-rw-r--r--Documentation/media/uapi/rc/lirc-dev.rst14
-rw-r--r--Documentation/media/uapi/rc/lirc-func.rst (renamed from Documentation/media/uapi/rc/lirc_device_interface.rst)11
-rw-r--r--Documentation/media/uapi/rc/lirc-read.rst (renamed from Documentation/media/uapi/rc/lirc_read.rst)8
-rw-r--r--Documentation/media/uapi/rc/lirc-write.rst (renamed from Documentation/media/uapi/rc/lirc_write.rst)0
-rw-r--r--Documentation/media/uapi/rc/remote_controllers.rst3
6 files changed, 24 insertions, 12 deletions
diff --git a/Documentation/media/uapi/rc/lirc_dev_intro.rst b/Documentation/media/uapi/rc/lirc-dev-intro.rst
index ef97e40f2fd8..ef97e40f2fd8 100644
--- a/Documentation/media/uapi/rc/lirc_dev_intro.rst
+++ b/Documentation/media/uapi/rc/lirc-dev-intro.rst
diff --git a/Documentation/media/uapi/rc/lirc-dev.rst b/Documentation/media/uapi/rc/lirc-dev.rst
new file mode 100644
index 000000000000..03cde25f5859
--- /dev/null
+++ b/Documentation/media/uapi/rc/lirc-dev.rst
@@ -0,0 +1,14 @@
+.. -*- coding: utf-8; mode: rst -*-
+
+.. _lirc_dev:
+
+LIRC Device Interface
+=====================
+
+
+.. toctree::
+ :maxdepth: 1
+
+ lirc-dev-intro
+ lirc-func
+ lirc-header
diff --git a/Documentation/media/uapi/rc/lirc_device_interface.rst b/Documentation/media/uapi/rc/lirc-func.rst
index a2ad957c96ae..9b5a772ec96c 100644
--- a/Documentation/media/uapi/rc/lirc_device_interface.rst
+++ b/Documentation/media/uapi/rc/lirc-func.rst
@@ -1,17 +1,16 @@
.. -*- coding: utf-8; mode: rst -*-
-.. _lirc_dev:
+.. _lirc_func:
-LIRC Device Interface
-=====================
+LIRC Function Reference
+=======================
.. toctree::
:maxdepth: 1
- lirc_dev_intro
- lirc_read
- lirc_write
+ lirc-read
+ lirc-write
lirc-get-features
lirc-get-send-mode
lirc-get-rec-mode
diff --git a/Documentation/media/uapi/rc/lirc_read.rst b/Documentation/media/uapi/rc/lirc-read.rst
index a8f1b446c294..8d4e9b6e507d 100644
--- a/Documentation/media/uapi/rc/lirc_read.rst
+++ b/Documentation/media/uapi/rc/lirc-read.rst
@@ -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
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
-active mode via the ioctl interface, detailed at :ref:`lirc_ioctl`.
-The generally preferred mode is LIRC_MODE_MODE2, in which packets
-containing an int value describing an IR signal are read from the
-chardev.
+active mode via the ioctl interface, detailed at :ref:`lirc_func`.
+The generally preferred mode for receive is
+:ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`, in which packets containing an
+int value describing an IR signal are read from the chardev.
See also
`http://www.lirc.org/html/technical.html <http://www.lirc.org/html/technical.html>`__
diff --git a/Documentation/media/uapi/rc/lirc_write.rst b/Documentation/media/uapi/rc/lirc-write.rst
index dcba3b1bee6e..dcba3b1bee6e 100644
--- a/Documentation/media/uapi/rc/lirc_write.rst
+++ b/Documentation/media/uapi/rc/lirc-write.rst
diff --git a/Documentation/media/uapi/rc/remote_controllers.rst b/Documentation/media/uapi/rc/remote_controllers.rst
index 3e9731afedd9..169286501ebb 100644
--- a/Documentation/media/uapi/rc/remote_controllers.rst
+++ b/Documentation/media/uapi/rc/remote_controllers.rst
@@ -23,8 +23,7 @@ Remote Controllers
rc-sysfs-nodes
rc-tables
rc-table-change
- lirc_device_interface
- lirc-header
+ lirc-dev
**********************