All of lore.kernel.org
 help / color / mirror / Atom feed
From: Mauro Carvalho Chehab <mchehab@s-opensource.com>
To: linux-input@vger.kernel.org, Dmitry Torokhov <dmitry.torokhov@gmail.com>
Cc: Mauro Carvalho Chehab <mchehab@s-opensource.com>,
	Linux Doc Mailing List <linux-doc@vger.kernel.org>,
	Jonathan Corbet <corbet@lwn.net>
Subject: [PATCH v2 24/37] docs: input/rotary-encoder: convert it to ReST format
Date: Tue,  4 Apr 2017 09:22:24 -0300	[thread overview]
Message-ID: <3552e3986d3848001b89449926d04f44930c681e.1491308444.git.mchehab@s-opensource.com> (raw)
In-Reply-To: <c6f7140e3bdbfb30a338550b700d25667b764594.1491308444.git.mchehab@s-opensource.com>
In-Reply-To: <67ed7b07043e6fac94528044ebaf541d5deb7c82.1491308444.git.mchehab@s-opensource.com>

This file require minimum adjustments to be a valid ReST file.
Do it, in order to be able to parse it with Sphinx.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 Documentation/input/rotary-encoder.txt | 74 +++++++++++++++++-----------------
 1 file changed, 38 insertions(+), 36 deletions(-)

diff --git a/Documentation/input/rotary-encoder.txt b/Documentation/input/rotary-encoder.txt
index 46a74f0c551a..4695bea67f9b 100644
--- a/Documentation/input/rotary-encoder.txt
+++ b/Documentation/input/rotary-encoder.txt
@@ -1,8 +1,11 @@
+============================================================
 rotary-encoder - a generic driver for GPIO connected devices
-Daniel Mack <daniel@caiaq.de>, Feb 2009
+============================================================
 
-0. Function
------------
+:Author: Daniel Mack <daniel@caiaq.de>, Feb 2009
+
+Function
+--------
 
 Rotary encoders are devices which are connected to the CPU or other
 peripherals with two wires. The outputs are phase-shifted by 90 degrees
@@ -13,7 +16,7 @@ Some encoders have both outputs low in stable states, others also have
 a stable state with both outputs high (half-period mode) and some have
 a stable state in all steps (quarter-period mode).
 
-The phase diagram of these two outputs look like this:
+The phase diagram of these two outputs look like this::
 
                   _____       _____       _____
                  |     |     |     |     |     |
@@ -40,8 +43,8 @@ For more information, please see
 	https://en.wikipedia.org/wiki/Rotary_encoder
 
 
-1. Events / state machine
--------------------------
+Events / state machine
+----------------------
 
 In half-period mode, state a) and c) above are used to determine the
 rotational direction based on the last stable state. Events are reported in
@@ -65,16 +68,16 @@ d) Falling edge on channel B, channel A in low state
 	should have happened, unless it flipped back on half the way. The
 	'armed' state tells us about that.
 
-2. Platform requirements
-------------------------
+Platform requirements
+---------------------
 
 As there is no hardware dependent call in this driver, the platform it is
 used with must support gpiolib. Another requirement is that IRQs must be
 able to fire on both edges.
 
 
-3. Board integration
---------------------
+Board integration
+-----------------
 
 To use this driver in your system, register a platform_device with the
 name 'rotary-encoder' and associate the IRQs and some specific platform
@@ -93,34 +96,33 @@ the configuration.
 Because GPIO to IRQ mapping is platform specific, this information must
 be given in separately to the driver. See the example below.
 
----------<snip>---------
+::
 
-/* board support file example */
+    /* board support file example */
 
-#include <linux/input.h>
-#include <linux/rotary_encoder.h>
+    #include <linux/input.h>
+    #include <linux/rotary_encoder.h>
 
-#define GPIO_ROTARY_A 1
-#define GPIO_ROTARY_B 2
+    #define GPIO_ROTARY_A 1
+    #define GPIO_ROTARY_B 2
 
-static struct rotary_encoder_platform_data my_rotary_encoder_info = {
-	.steps		= 24,
-	.axis		= ABS_X,
-	.relative_axis	= false,
-	.rollover	= false,
-	.gpio_a		= GPIO_ROTARY_A,
-	.gpio_b		= GPIO_ROTARY_B,
-	.inverted_a	= 0,
-	.inverted_b	= 0,
-	.half_period	= false,
-	.wakeup_source	= false,
-};
-
-static struct platform_device rotary_encoder_device = {
-	.name		= "rotary-encoder",
-	.id		= 0,
-	.dev		= {
-		.platform_data = &my_rotary_encoder_info,
-	}
-};
+    static struct rotary_encoder_platform_data my_rotary_encoder_info = {
+	    .steps		= 24,
+	    .axis		= ABS_X,
+	    .relative_axis	= false,
+	    .rollover	= false,
+	    .gpio_a		= GPIO_ROTARY_A,
+	    .gpio_b		= GPIO_ROTARY_B,
+	    .inverted_a	= 0,
+	    .inverted_b	= 0,
+	    .half_period	= false,
+	    .wakeup_source	= false,
+    };
 
+    static struct platform_device rotary_encoder_device = {
+	    .name		= "rotary-encoder",
+	    .id		= 0,
+	    .dev		= {
+		    .platform_data = &my_rotary_encoder_info,
+	    }
+    };
-- 
2.9.3


  reply	other threads:[~2017-04-04 12:23 UTC|newest]

Thread overview: 55+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2017-04-04 10:52 [PATCH v2 00/33] Convert input documentation to ReST Mauro Carvalho Chehab
2017-04-04 10:52 ` [PATCH v2 01/33] docs: Documentation/input/input: convert it to ReST format Mauro Carvalho Chehab
     [not found]   ` <8e64d13bfc6952bc9370593ddc556a539f589654.1491302719.git.mchehab@s-opensource.com>
     [not found]     ` <781a89b410f25a2fb39d081d1ebd696317b6d2c2.1491302719.git.mchehab@s-opensource.com>
     [not found]       ` <6800b2c4e8f67b699c22533f7574d380b37cb6d6.1491302719.git.mchehab@s-opensource.com>
     [not found]         ` <9f6ae6ca543f4aa294afd000b7c8a8f49b2e8382.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52           ` [PATCH v2 06/33] docs: input/bcm5974: " Mauro Carvalho Chehab
2017-04-04 10:52             ` [PATCH v2 07/33] docs: input/cd32: " Mauro Carvalho Chehab
     [not found]               ` <e67db9bffc4a93a93b8559ed85d6e77045a99157.1491302719.git.mchehab@s-opensource.com>
     [not found]                 ` <9794ec8a2147f66e9e183f612fa7e834c9245dd9.1491302719.git.mchehab@s-opensource.com>
     [not found]                   ` <3bb792c867ec11d1e5b998b2d44e99fbd654ff95.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                     ` [PATCH v2 11/33] docs: input/event-codes: " Mauro Carvalho Chehab
2017-04-04 10:52                       ` [PATCH v2 12/33] docs: input/ff: " Mauro Carvalho Chehab
     [not found]                         ` <3efc02b3379dc908bfc0ade34185469295fee2bc.1491302719.git.mchehab@s-opensource.com>
     [not found]                           ` <9b1b818d7cde485713aced6b077f0e276a24bddd.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                             ` [PATCH v2 15/33] docs: input/gpio-tilt: " Mauro Carvalho Chehab
     [not found]                               ` <8e0ef882aa235e4e6e758662dc434567266fb541.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                 ` [PATCH v2 17/33] docs: input/input-programming: " Mauro Carvalho Chehab
     [not found]                                   ` <c4d96be24099f525b771369e2c0dd9bdfd376fa0.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                     ` [PATCH v2 19/33] docs: input/joystick: " Mauro Carvalho Chehab
2017-04-04 10:52                                       ` [PATCH v2 20/33] docs: input/joystick-parport: " Mauro Carvalho Chehab
     [not found]                                         ` <e297fc785d72be336c2e4a85705c24eedb16cf7d.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                           ` [PATCH v2 22/33] docs: input/notifier: " Mauro Carvalho Chehab
     [not found]                                             ` <c6f7140e3bdbfb30a338550b700d25667b764594.1491302719.git.mchehab@s-opensource.com>
     [not found]                                               ` <3552e3986d3848001b89449926d04f44930c681e.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                                 ` [PATCH v2 25/33] docs: input/sentelic: " Mauro Carvalho Chehab
     [not found]                                                   ` <679c283194489e852074900b0133b5b6acd9395f.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                                     ` [PATCH v2 27/33] docs: input/walkera0701: " Mauro Carvalho Chehab
     [not found]                                                       ` <ff44ad91600b12a8475e3e46a8a121dcbd3eedd9.1491302719.git.mchehab@s-opensource.com>
     [not found]                                                         ` <55d263f13237495276213de295ae1c6d67f0588b.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                                           ` [PATCH v2 30/33] docs-rst: create a book with Linux Input documentation Mauro Carvalho Chehab
     [not found]                                                             ` <a6e09069e3a232652651c2aac6d0906e728422e2.1491302719.git.mchehab@s-opensource.com>
2017-04-04 10:52                                                               ` [PATCH v2 32/33] docs: input/interactive: convert from xfig to svg Mauro Carvalho Chehab
2017-04-04 12:22 ` [PATCH v2 01/37] docs: Documentation/input/input: convert it to ReST format Mauro Carvalho Chehab
2017-04-04 12:22   ` [PATCH v2 02/37] docs: input/alps: " Mauro Carvalho Chehab
2017-04-04 12:22     ` [PATCH v2 03/37] docs: input/amijoy: " Mauro Carvalho Chehab
2017-04-04 12:22       ` [PATCH v2 04/37] docs: input/appletouch: " Mauro Carvalho Chehab
2017-04-04 12:22         ` [PATCH v2 05/37] docs: input/atarikbd: " Mauro Carvalho Chehab
2017-04-04 12:22           ` [PATCH v2 06/37] docs: input/bcm5974: " Mauro Carvalho Chehab
2017-04-04 12:22             ` [PATCH v2 07/37] docs: input/cd32: " Mauro Carvalho Chehab
2017-04-04 12:22               ` [PATCH v2 08/37] docs: input/cma3000_d0x: " Mauro Carvalho Chehab
2017-04-04 12:22                 ` [PATCH v2 09/37] docs: input/cs461x: " Mauro Carvalho Chehab
2017-04-04 12:22                   ` [PATCH v2 10/37] docs: input/elantech: " Mauro Carvalho Chehab
2017-04-04 12:22                     ` [PATCH v2 11/37] docs: input/event-codes: " Mauro Carvalho Chehab
2017-04-04 12:22                       ` [PATCH v2 12/37] docs: input/ff: " Mauro Carvalho Chehab
2017-04-04 12:22                         ` [PATCH v2 13/37] docs: input/gamepad: " Mauro Carvalho Chehab
2017-04-04 12:22                           ` [PATCH v2 14/37] docs: input/gameport-programming: " Mauro Carvalho Chehab
2017-04-04 12:22                             ` [PATCH v2 15/37] docs: input/gpio-tilt: " Mauro Carvalho Chehab
2017-04-04 12:22                               ` [PATCH v2 16/37] docs: input/iforce-protocol: " Mauro Carvalho Chehab
2017-04-04 12:22                                 ` [PATCH v2 17/37] docs: input/input-programming: " Mauro Carvalho Chehab
2017-04-04 12:22                                   ` [PATCH v2 18/37] docs: input/joystick-api: " Mauro Carvalho Chehab
2017-04-04 12:22                                     ` [PATCH v2 19/37] docs: input/joystick: " Mauro Carvalho Chehab
2017-04-04 12:22                                       ` [PATCH v2 20/37] docs: input/joystick-parport: " Mauro Carvalho Chehab
2017-04-04 12:22                                         ` [PATCH v2 21/37] docs: input/multi-touch-protocol: " Mauro Carvalho Chehab
2017-04-04 12:22                                           ` [PATCH v2 22/37] docs: input/notifier: " Mauro Carvalho Chehab
2017-04-04 12:22                                             ` [PATCH v2 23/37] docs: input/ntrig: " Mauro Carvalho Chehab
2017-04-04 12:22                                               ` Mauro Carvalho Chehab [this message]
2017-04-04 12:22                                                 ` [PATCH v2 25/37] docs: input/sentelic: " Mauro Carvalho Chehab
2017-04-04 12:22                                                   ` [PATCH v2 26/37] docs: input/userio: " Mauro Carvalho Chehab
2017-04-04 12:22                                                     ` [PATCH v2 27/37] docs: input/walkera0701: " Mauro Carvalho Chehab
2017-04-04 12:22                                                       ` [PATCH v2 28/37] docs: input/xpad: " Mauro Carvalho Chehab
2017-04-04 12:22                                                         ` [PATCH v2 29/37] docs: input/yealink: " Mauro Carvalho Chehab
2017-04-04 12:22                                                           ` [PATCH v2 30/37] docs-rst: create a book with Linux Input documentation Mauro Carvalho Chehab
2017-04-04 12:22                                                             ` [PATCH v2 31/37] docs: input/shape: convert it from xfig to svg Mauro Carvalho Chehab
2017-04-04 12:22                                                               ` [PATCH v2 32/37] docs: input/interactive: convert " Mauro Carvalho Chehab
2017-04-04 12:22                                                                 ` [PATCH v2 33/37] docs: ff.rst: use svg files instead of xfig Mauro Carvalho Chehab
2017-04-04 12:22                                                                   ` [PATCH v2 34/37] input: add an EV_REL event for high-res vertical wheel Mauro Carvalho Chehab
2017-04-04 12:22                                                                     ` [PATCH v2 35/37] input: add a EV_SW event for ratchet switch Mauro Carvalho Chehab
2017-04-04 12:22                                                                       ` [PATCH v2 36/37] hid-logitech-hidpp: add support for high res wheel Mauro Carvalho Chehab
2017-04-04 12:22                                                                         ` [PATCH v2 37/37] hid-logitech-hidpp: add support for ratchet switch Mauro Carvalho Chehab
2017-04-05 12:03                                                                       ` [PATCH v2 35/37] input: add a EV_SW event " Peter Hutterer
2017-04-07  0:16                                                                         ` Mauro Carvalho Chehab
2017-04-07  0:53                                                                           ` Peter Hutterer

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=3552e3986d3848001b89449926d04f44930c681e.1491308444.git.mchehab@s-opensource.com \
    --to=mchehab@s-opensource.com \
    --cc=corbet@lwn.net \
    --cc=dmitry.torokhov@gmail.com \
    --cc=linux-doc@vger.kernel.org \
    --cc=linux-input@vger.kernel.org \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is an external index of several public inboxes,
see mirroring instructions on how to clone and mirror
all data and code used by this external index.