linux-kernel - [PATCH 4/4] [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book

lists.openwall.net		lists / announce owl-users owl-dev john-users john-dev passwdqc-users yescrypt popa3d-users / oss-security kernel-hardening musl sabotage tlsify passwords / crypt-dev xvendor / Bugtraq Full-Disclosure linux-kernel linux-netdev linux-ext4 linux-hardening linux-cve-announce PHC
Open Source and information security mailing list archives

Hash Suite: Windows password security audit tool. GUI, reports in PDF.

[<prev] [next>] [<thread-prev] [thread-next>] [day] [month] [year] [list]

Date:   Mon, 17 Apr 2017 09:46:16 -0300
From:   Mauro Carvalho Chehab <mchehab@...pensource.com>
To:     Linux Doc Mailing List <linux-doc@...r.kernel.org>
Cc:     Mauro Carvalho Chehab <mchehab@...pensource.com>,
        Mauro Carvalho Chehab <mchehab@...radead.org>,
        Jonathan Corbet <corbet@....net>, linux-kernel@...r.kernel.org,
        Jonathan Cameron <jic23@...nel.org>,
        Greg Kroah-Hartman <gregkh@...uxfoundation.org>,
        "Rafael J. Wysocki" <rafael.j.wysocki@...el.com>,
        "Luis R. Rodriguez" <mcgrof@...nel.org>,
        Oliver Neukum <oneukum@...e.com>,
        Martyn Welch <martyn@...chs.me.uk>,
        Markus Heiser <markus.heiser@...marit.de>,
        Dmitry Torokhov <dmitry.torokhov@...il.com>
Subject: [PATCH 4/4] [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book

Move the kAPI kernel-doc produced documentation to
Documentation/input and add uAPI documentation there too.

Signed-off-by: Mauro Carvalho Chehab <mchehab@...pensource.com>
---
 Documentation/driver-api/iio/intro.rst                              | 4 ++--
 Documentation/driver-api/index.rst                                  | 1 -
 Documentation/input/input_kapi.rst                                  | 1 +
 .../{driver-api/input.rst => input/input_kapi_symbols.rst}          | 6 ++++--
 Documentation/input/input_uapi.rst                                  | 1 +
 Documentation/input/input_uapi_symbols.rst                          | 4 ++++
 6 files changed, 12 insertions(+), 5 deletions(-)
 rename Documentation/{driver-api/input.rst => input/input_kapi_symbols.rst} (93%)
 create mode 100644 Documentation/input/input_uapi_symbols.rst

diff --git a/Documentation/driver-api/iio/intro.rst b/Documentation/driver-api/iio/intro.rst
index 3653fbd57069..696f7f99a459 100644
--- a/Documentation/driver-api/iio/intro.rst
+++ b/Documentation/driver-api/iio/intro.rst
@@ -8,9 +8,9 @@ The main purpose of the Industrial I/O subsystem (IIO) is to provide support
 for devices that in some sense perform either
 analog-to-digital conversion (ADC) or digital-to-analog conversion (DAC)
 or both. The aim is to fill the gap between the somewhat similar hwmon and
-:doc:`input <../input>` subsystems. Hwmon is directed at low sample rate
+:ref:`input <input_kapi>` subsystems. Hwmon is directed at low sample rate
 sensors used to monitor and control the system itself, like fan speed control
-or temperature measurement. :doc:`Input <../input>` is, as its name suggests,
+or temperature measurement. :ref:`Input <input_kapi>` is, as its name suggests,
 focused on human interaction input devices (keyboard, mouse, touchscreen).
 In some cases there is considerable overlap between these and IIO.
 
diff --git a/Documentation/driver-api/index.rst b/Documentation/driver-api/index.rst
index 60db00d1532b..d7bc5e8bf3a1 100644
--- a/Documentation/driver-api/index.rst
+++ b/Documentation/driver-api/index.rst
@@ -25,7 +25,6 @@ available subsections can be seen below.
    frame-buffer
    regulator
    iio/index
-   input
    usb
    spi
    i2c
diff --git a/Documentation/input/input_kapi.rst b/Documentation/input/input_kapi.rst
index 41f1b7e6b78e..b3ee24881773 100644
--- a/Documentation/input/input_kapi.rst
+++ b/Documentation/input/input_kapi.rst
@@ -15,3 +15,4 @@ Linux Input Subsystem kernel API
    input-programming
    gameport-programming
    notifier
+   input_kapi_symbols
diff --git a/Documentation/driver-api/input.rst b/Documentation/input/input_kapi_symbols.rst
similarity index 93%
rename from Documentation/driver-api/input.rst
rename to Documentation/input/input_kapi_symbols.rst
index d05bf58fa83e..b85b34303f72 100644
--- a/Documentation/driver-api/input.rst
+++ b/Documentation/input/input_kapi_symbols.rst
@@ -1,5 +1,7 @@
-Input Subsystem
-===============
+.. _input_kapi:
+
+Input kAPI reference
+====================
 
 Input core
 ----------
diff --git a/Documentation/input/input_uapi.rst b/Documentation/input/input_uapi.rst
index 12ef8974a773..59596af7e01f 100644
--- a/Documentation/input/input_uapi.rst
+++ b/Documentation/input/input_uapi.rst
@@ -19,3 +19,4 @@ Linux Input Subsystem userspace API
    ff
    joydev/index
    userio
+   input_uapi_symbols
diff --git a/Documentation/input/input_uapi_symbols.rst b/Documentation/input/input_uapi_symbols.rst
new file mode 100644
index 000000000000..9cb29d10e483
--- /dev/null
+++ b/Documentation/input/input_uapi_symbols.rst
@@ -0,0 +1,4 @@
+Input uAPI reference
+====================
+
+.. kernel-doc:: include/uapi/linux/input.h
-- 
2.9.3