ALSA: doc: ReSTize Joystick document

A conversion from a simple text file.
A new subdirectory, cards, was created to contain the card-specific
information like this one.

Signed-off-by: Takashi Iwai <tiwai@suse.de>

diff --git a/Documentation/sound/cards/index.rst b/Documentation/sound/cards/index.rst
new file mode 100644 (file)
index 0000000..e1f4b78
--- /dev/null
+++ b/Documentation/sound/cards/index.rst
@@ -0,0 +1,7 @@
+Card-Specific Information
+=========================
+
+.. toctree::
+   :maxdepth: 2
+
+   joystick

diff --git a/Documentation/sound/alsa/Joystick.txt b/Documentation/sound/cards/joystick.rst
similarity index 56%
rename from Documentation/sound/alsa/Joystick.txt
rename to Documentation/sound/cards/joystick.rst
index ccda41b10f8a3a080bfdb1bd02b646b2a14ee3ac..a6e468c81d02f3da807940b4031b996a6c8e33a6 100644 (file)
--- a/Documentation/sound/alsa/Joystick.txt
+++ b/Documentation/sound/cards/joystick.rst
@@ -1,7 +1,10 @@
+=======================================
 Analog Joystick Support on ALSA Drivers
 =======================================
-                          Oct. 14, 2003
-           Takashi Iwai <tiwai@suse.de>
+
+Oct. 14, 2003
+
+Takashi Iwai <tiwai@suse.de>
 
 General
 -------
@@ -34,44 +37,46 @@ stability and the resource management.
 
 The following PCI drivers support the joystick natively.
 
-    Driver     Module Option   Available Values
-    ---------------------------------------------------------------------------
-    als4000    joystick_port   0 = disable (default), 1 = auto-detect,
-                                manual: any address (e.g. 0x200)
-    au88x0     N/A             N/A
-    azf3328    joystick        0 = disable, 1 = enable, -1 = auto (default)
-    ens1370    joystick        0 = disable (default), 1 = enable
-    ens1371    joystick_port   0 = disable (default), 1 = auto-detect,
-                                manual: 0x200, 0x208, 0x210, 0x218
-    cmipci     joystick_port   0 = disable (default), 1 = auto-detect,
-                                manual: any address (e.g. 0x200)
-    cs4281     N/A             N/A
-    cs46xx     N/A             N/A
-    es1938     N/A             N/A
-    es1968     joystick        0 = disable (default), 1 = enable
-    sonicvibes N/A             N/A
-    trident    N/A             N/A
-    via82xx(*1)        joystick        0 = disable (default), 1 = enable
-    ymfpci     joystick_port   0 = disable (default), 1 = auto-detect,
-                                manual: 0x201, 0x202, 0x204, 0x205(*2)
-    ---------------------------------------------------------------------------
-
-    *1)  VIA686A/B only
-    *2)  With YMF744/754 chips, the port address can be chosen arbitrarily
+============== =============   ============================================
+Driver         Module Option   Available Values
+============== =============   ============================================
+als4000                joystick_port   0 = disable (default), 1 = auto-detect,
+                               manual: any address (e.g. 0x200)
+au88x0         N/A             N/A
+azf3328                joystick        0 = disable, 1 = enable, -1 = auto (default)
+ens1370                joystick        0 = disable (default), 1 = enable
+ens1371                joystick_port   0 = disable (default), 1 = auto-detect,
+                               manual: 0x200, 0x208, 0x210, 0x218
+cmipci         joystick_port   0 = disable (default), 1 = auto-detect,
+                               manual: any address (e.g. 0x200)
+cs4281         N/A             N/A
+cs46xx         N/A             N/A
+es1938         N/A             N/A
+es1968         joystick        0 = disable (default), 1 = enable
+sonicvibes     N/A             N/A
+trident                N/A             N/A
+via82xx [#f1]_ joystick        0 = disable (default), 1 = enable
+ymfpci         joystick_port   0 = disable (default), 1 = auto-detect,
+                               manual: 0x201, 0x202, 0x204, 0x205 [#f2]_
+============== =============   ============================================
+
+.. [#f1] VIA686A/B only
+.. [#f2] With YMF744/754 chips, the port address can be chosen arbitrarily
 
 The following drivers don't support gameport natively, but there are
 additional modules.  Load the corresponding module to add the gameport
 support.
 
-    Driver     Additional Module
-    -----------------------------
-    emu10k1    emu10k1-gp
-    fm801      fm801-gp
-    -----------------------------
+=======        =================
+Driver Additional Module
+=======        =================
+emu10k1        emu10k1-gp
+fm801  fm801-gp
+=======        =================
 
 Note: the "pcigame" and "cs461x" modules are for the OSS drivers only.
-      These ALSA drivers (cs46xx, trident and au88x0) have the
-      built-in gameport support.
+These ALSA drivers (cs46xx, trident and au88x0) have the
+built-in gameport support.
 
 As mentioned above, ALSA PCI drivers have the built-in gameport
 support, so you don't have to load ns558 module.  Just load "joydev"

diff --git a/Documentation/sound/index.rst b/Documentation/sound/index.rst
index e9fbbfff9d0d6443f739df443859c0a386aa82b0..1f5d166f81c4cf4808193636a74af7bae8c94aa9 100644 (file)
--- a/Documentation/sound/index.rst
+++ b/Documentation/sound/index.rst
@@ -9,6 +9,7 @@ Linux Sound Subsystem Documentation
    designs/index
    alsa-configuration
    hd-audio/index
+   cards/index
 
 .. only::  subproject