aboutsummaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-12 08:35:26 -0400
committerMauro Carvalho Chehab <mchehab@s-opensource.com>2016-07-12 08:43:04 -0400
commitbd6a63f2e69ea16851a99b200cd2039186173775 (patch)
tree847ea21e7790244cc946d1d551658888714e28be
parent048eb3ef7580ef5dd64c74a319e58b1c8568ed68 (diff)
[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 @@
1.. -*- coding: utf-8; mode: rst -*-
2
3.. _lirc_dev:
4
5LIRC Device Interface
6=====================
7
8
9.. toctree::
10 :maxdepth: 1
11
12 lirc-dev-intro
13 lirc-func
14 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 @@
1.. -*- coding: utf-8; mode: rst -*- 1.. -*- coding: utf-8; mode: rst -*-
2 2
3.. _lirc_dev: 3.. _lirc_func:
4 4
5LIRC Device Interface 5LIRC Function Reference
6===================== 6=======================
7 7
8 8
9.. toctree:: 9.. toctree::
10 :maxdepth: 1 10 :maxdepth: 1
11 11
12 lirc_dev_intro 12 lirc-read
13 lirc_read 13 lirc-write
14 lirc_write
15 lirc-get-features 14 lirc-get-features
16 lirc-get-send-mode 15 lirc-get-send-mode
17 lirc-get-rec-mode 16 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.
44The lircd userspace daemon reads raw IR data from the LIRC chardev. The 44The lircd userspace daemon reads raw IR data from the LIRC chardev. The
45exact format of the data depends on what modes a driver supports, and 45exact format of the data depends on what modes a driver supports, and
46what mode has been selected. lircd obtains supported modes and sets the 46what mode has been selected. lircd obtains supported modes and sets the
47active mode via the ioctl interface, detailed at :ref:`lirc_ioctl`. 47active mode via the ioctl interface, detailed at :ref:`lirc_func`.
48The generally preferred mode is LIRC_MODE_MODE2, in which packets 48The generally preferred mode for receive is
49containing an int value describing an IR signal are read from the 49:ref:`LIRC_MODE_MODE2 <lirc-mode-mode2>`, in which packets containing an
50chardev. 50int value describing an IR signal are read from the chardev.
51 51
52See also 52See also
53`http://www.lirc.org/html/technical.html <http://www.lirc.org/html/technical.html>`__ 53`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
23 rc-sysfs-nodes 23 rc-sysfs-nodes
24 rc-tables 24 rc-tables
25 rc-table-change 25 rc-table-change
26 lirc_device_interface 26 lirc-dev
27 lirc-header
28 27
29 28
30********************** 29**********************