diff mbox series

[v2,4/4] input: docs: Make headings compliant w/ guidelines

Message ID 20250526135957.180254-5-contact@gvernon.com
State New
Headers show
Series Multiple fixes to Amiga joystick documentation | expand

Commit Message

George Anthony Vernon May 26, 2025, 1:59 p.m. UTC
Make heading adornments compliant with the guidelines to improve
organisation of the page.

Signed-off-by: George Anthony Vernon <contact@gvernon.com>
---
 Documentation/input/devices/amijoy.rst | 42 ++++++++++++++++----------
 1 file changed, 26 insertions(+), 16 deletions(-)

Comments

Bagas Sanjaya May 29, 2025, 1:20 a.m. UTC | #1
On Mon, May 26, 2025 at 02:59:52PM +0100, George Anthony Vernon wrote:
> diff --git a/Documentation/input/devices/amijoy.rst b/Documentation/input/devices/amijoy.rst
> index cbc5240f8af3..a81e9de481c7 100644
> --- a/Documentation/input/devices/amijoy.rst
> +++ b/Documentation/input/devices/amijoy.rst
> @@ -1,10 +1,12 @@
> -~~~~~~~~~~~~~~~
> +===============
>  Amiga joysticks
> -~~~~~~~~~~~~~~~
> +===============
>  
> +Pinouts
> +=======
>  
>  Amiga 4-joystick parallel port extension
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +----------------------------------------
>  
>  Parallel port pins:
>  
> @@ -19,8 +21,8 @@ Pin    Meaning  Pin    Meaning
>  19     Gnd1	18     Gnd2
>  =====  ======== ====   ==========
>  
> -Amiga digital joystick pinout
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +Amiga digital joystick
> +----------------------
>  
>  === ============
>  Pin Meaning
> @@ -36,8 +38,8 @@ Pin Meaning
>  9   Thumb button
>  === ============
>  
> -Amiga mouse pinout
> -~~~~~~~~~~~~~~~~~~
> +Amiga mouse
> +-----------
>  
>  === ============
>  Pin Meaning
> @@ -53,8 +55,8 @@ Pin Meaning
>  9   Right button
>  === ============
>  
> -Amiga analog joystick pinout
> -~~~~~~~~~~~~~~~~~~~~~~~~~~~~
> +Amiga analog joystick
> +---------------------
>  
>  === ==============
>  Pin Meaning
> @@ -70,8 +72,8 @@ Pin Meaning
>  9   Analog Y
>  === ==============
>  
> -Amiga lightpen pinout
> -~~~~~~~~~~~~~~~~~~~~~
> +Amiga lightpen
> +--------------
>  
>  === =============
>  Pin Meaning
> @@ -87,7 +89,11 @@ Pin Meaning
>  9   Stylus button
>  === =============
>  
> --------------------------------------------------------------------------------
> +Register addresses
> +==================
> +
> +JOY0DAT/JOY1DAT
> +---------------
>  
>  ======== === ==== ==== ====== ===========================================
>  NAME     rev ADDR type chip   Description
> @@ -159,7 +165,8 @@ JOY1DAT   Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0     X7  X6  X5  X4  X3  X2  X1  X0
>           | Right      |  4   | X1                              |
>           +------------+------+---------------------------------+
>  
> --------------------------------------------------------------------------------
> +JOYTEST
> +-------
>  
>  ========  === ==== ==== ====== =================================================
>  NAME      rev ADDR type chip    Description
> @@ -176,7 +183,8 @@ JOYTEST       036   W   Denise  Write to all 4  joystick-mouse counters at once.
>    JOYxDAT  Y7  Y6  Y5  Y4  Y3  Y2  xx  xx     X7  X6  X5  X4  X3  X2  xx  xx
>  ========= === === === === === === === === ====== === === === === === === ===
>  
> --------------------------------------------------------------------------------
> +POT0DAT/POT1DAT
> +---------------
>  
>  ======= === ==== ==== ====== ===========================================
>  NAME    rev ADDR type chip   Description
> @@ -217,7 +225,8 @@ POT1DAT  h  014   R   Paula  Pot counter data right pair (vert., horiz.)
>           the counters will count proportionally faster.
>           This should be noted when doing variable beam displays.
>  
> --------------------------------------------------------------------------------
> +POTGO
> +-----
>  
>  ====== === ==== ==== ====== ================================================
>  NAME   rev ADDR type chip   Description
> @@ -226,7 +235,8 @@ POTGO      034   W   Paula  Pot port (4 bit) bi-direction and data, and pot
>  			    counter start.
>  ====== === ==== ==== ====== ================================================
>  
> --------------------------------------------------------------------------------
> +POTINP
> +------
>  
>  ====== === ==== ==== ====== ================================================
>  NAME   rev ADDR type chip   Description

LGTM, thanks!

Reviewed-by: Bagas Sanjaya <bagasdotme@gmail.com>
diff mbox series

Patch

diff --git a/Documentation/input/devices/amijoy.rst b/Documentation/input/devices/amijoy.rst
index cbc5240f8af3..a81e9de481c7 100644
--- a/Documentation/input/devices/amijoy.rst
+++ b/Documentation/input/devices/amijoy.rst
@@ -1,10 +1,12 @@ 
-~~~~~~~~~~~~~~~
+===============
 Amiga joysticks
-~~~~~~~~~~~~~~~
+===============
 
+Pinouts
+=======
 
 Amiga 4-joystick parallel port extension
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+----------------------------------------
 
 Parallel port pins:
 
@@ -19,8 +21,8 @@  Pin    Meaning  Pin    Meaning
 19     Gnd1	18     Gnd2
 =====  ======== ====   ==========
 
-Amiga digital joystick pinout
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Amiga digital joystick
+----------------------
 
 === ============
 Pin Meaning
@@ -36,8 +38,8 @@  Pin Meaning
 9   Thumb button
 === ============
 
-Amiga mouse pinout
-~~~~~~~~~~~~~~~~~~
+Amiga mouse
+-----------
 
 === ============
 Pin Meaning
@@ -53,8 +55,8 @@  Pin Meaning
 9   Right button
 === ============
 
-Amiga analog joystick pinout
-~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+Amiga analog joystick
+---------------------
 
 === ==============
 Pin Meaning
@@ -70,8 +72,8 @@  Pin Meaning
 9   Analog Y
 === ==============
 
-Amiga lightpen pinout
-~~~~~~~~~~~~~~~~~~~~~
+Amiga lightpen
+--------------
 
 === =============
 Pin Meaning
@@ -87,7 +89,11 @@  Pin Meaning
 9   Stylus button
 === =============
 
--------------------------------------------------------------------------------
+Register addresses
+==================
+
+JOY0DAT/JOY1DAT
+---------------
 
 ======== === ==== ==== ====== ===========================================
 NAME     rev ADDR type chip   Description
@@ -159,7 +165,8 @@  JOY1DAT   Y7  Y6  Y5  Y4  Y3  Y2  Y1  Y0     X7  X6  X5  X4  X3  X2  X1  X0
          | Right      |  4   | X1                              |
          +------------+------+---------------------------------+
 
--------------------------------------------------------------------------------
+JOYTEST
+-------
 
 ========  === ==== ==== ====== =================================================
 NAME      rev ADDR type chip    Description
@@ -176,7 +183,8 @@  JOYTEST       036   W   Denise  Write to all 4  joystick-mouse counters at once.
   JOYxDAT  Y7  Y6  Y5  Y4  Y3  Y2  xx  xx     X7  X6  X5  X4  X3  X2  xx  xx
 ========= === === === === === === === === ====== === === === === === === ===
 
--------------------------------------------------------------------------------
+POT0DAT/POT1DAT
+---------------
 
 ======= === ==== ==== ====== ===========================================
 NAME    rev ADDR type chip   Description
@@ -217,7 +225,8 @@  POT1DAT  h  014   R   Paula  Pot counter data right pair (vert., horiz.)
          the counters will count proportionally faster.
          This should be noted when doing variable beam displays.
 
--------------------------------------------------------------------------------
+POTGO
+-----
 
 ====== === ==== ==== ====== ================================================
 NAME   rev ADDR type chip   Description
@@ -226,7 +235,8 @@  POTGO      034   W   Paula  Pot port (4 bit) bi-direction and data, and pot
 			    counter start.
 ====== === ==== ==== ====== ================================================
 
--------------------------------------------------------------------------------
+POTINP
+------
 
 ====== === ==== ==== ====== ================================================
 NAME   rev ADDR type chip   Description