From mboxrd@z Thu Jan 1 00:00:00 1970 Return-Path: Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1756223AbdDQMrC (ORCPT ); Mon, 17 Apr 2017 08:47:02 -0400 Received: from ec2-52-27-115-49.us-west-2.compute.amazonaws.com ([52.27.115.49]:49488 "EHLO osg.samsung.com" rhost-flags-OK-OK-OK-FAIL) by vger.kernel.org with ESMTP id S1753774AbdDQMq2 (ORCPT ); Mon, 17 Apr 2017 08:46:28 -0400 X-Amavis-Alert: BAD HEADER SECTION, Duplicate header field: "References" From: Mauro Carvalho Chehab To: Linux Doc Mailing List Cc: Mauro Carvalho Chehab , Mauro Carvalho Chehab , Jonathan Corbet , linux-kernel@vger.kernel.org, Jonathan Cameron , Greg Kroah-Hartman , "Rafael J. Wysocki" , "Luis R. Rodriguez" , Oliver Neukum , Martyn Welch , Markus Heiser , Dmitry Torokhov Subject: [PATCH 4/4] [RFC] input: add kAPI and uAPI kernel-doc stuff at the input book Date: Mon, 17 Apr 2017 09:46:16 -0300 Message-Id: X-Mailer: git-send-email 2.9.3 In-Reply-To: References: In-Reply-To: References: Sender: linux-kernel-owner@vger.kernel.org List-ID: X-Mailing-List: linux-kernel@vger.kernel.org Move the kAPI kernel-doc produced documentation to Documentation/input and add uAPI documentation there too. Signed-off-by: Mauro Carvalho Chehab --- 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 ` 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 ` 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