From bd6a63f2e69ea16851a99b200cd2039186173775 Mon Sep 17 00:00:00 2001 From: Mauro Carvalho Chehab Date: Tue, 12 Jul 2016 09:35:26 -0300 Subject: [PATCH] [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 --- .../rc/{lirc_dev_intro.rst => lirc-dev-intro.rst} | 0 Documentation/media/uapi/rc/lirc-dev.rst | 14 ++++++++++++++ .../{lirc_device_interface.rst => lirc-func.rst} | 11 +++++------ .../media/uapi/rc/{lirc_read.rst => lirc-read.rst} | 8 ++++---- .../uapi/rc/{lirc_write.rst => lirc-write.rst} | 0 Documentation/media/uapi/rc/remote_controllers.rst | 3 +-- 6 files changed, 24 insertions(+), 12 deletions(-) rename Documentation/media/uapi/rc/{lirc_dev_intro.rst => lirc-dev-intro.rst} (100%) create mode 100644 Documentation/media/uapi/rc/lirc-dev.rst rename Documentation/media/uapi/rc/{lirc_device_interface.rst => lirc-func.rst} (81%) rename Documentation/media/uapi/rc/{lirc_read.rst => lirc-read.rst} (83%) rename Documentation/media/uapi/rc/{lirc_write.rst => lirc-write.rst} (100%) diff --git a/Documentation/media/uapi/rc/lirc_dev_intro.rst b/Documentation/media/uapi/rc/lirc-dev-intro.rst similarity index 100% rename from Documentation/media/uapi/rc/lirc_dev_intro.rst rename to 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 similarity index 81% rename from Documentation/media/uapi/rc/lirc_device_interface.rst rename to 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 similarity index 83% rename from Documentation/media/uapi/rc/lirc_read.rst rename to 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 `, 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 `__ diff --git a/Documentation/media/uapi/rc/lirc_write.rst b/Documentation/media/uapi/rc/lirc-write.rst similarity index 100% rename from Documentation/media/uapi/rc/lirc_write.rst rename to 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 ********************** -- 2.20.1