[alsa-devel] [PATCH 17/30] ALSA: doc: ReSTize Jack-Controls.txt
Takashi Iwai
tiwai at suse.de
Thu Nov 10 22:06:28 CET 2016
A simple conversion from a plain text file.
Put to designs subdirectory.
Signed-off-by: Takashi Iwai <tiwai at suse.de>
---
Documentation/sound/designs/index.rst | 1 +
.../{alsa/Jack-Controls.txt => designs/jack-controls.rst} | 13 +++++++++----
2 files changed, 10 insertions(+), 4 deletions(-)
rename Documentation/sound/{alsa/Jack-Controls.txt => designs/jack-controls.rst} (86%)
diff --git a/Documentation/sound/designs/index.rst b/Documentation/sound/designs/index.rst
index 798b1a44bbbd..04dcdae3e4f2 100644
--- a/Documentation/sound/designs/index.rst
+++ b/Documentation/sound/designs/index.rst
@@ -8,6 +8,7 @@ Designs and Implementations
channel-mapping-api
compress-offload
timestamping
+ jack-controls
procfile
powersave
oss-emulation
diff --git a/Documentation/sound/alsa/Jack-Controls.txt b/Documentation/sound/designs/jack-controls.rst
similarity index 86%
rename from Documentation/sound/alsa/Jack-Controls.txt
rename to Documentation/sound/designs/jack-controls.rst
index fe1c5e0c8555..ae25b1531bb0 100644
--- a/Documentation/sound/alsa/Jack-Controls.txt
+++ b/Documentation/sound/designs/jack-controls.rst
@@ -1,3 +1,7 @@
+==================
+ALSA Jack Controls
+==================
+
Why we need Jack kcontrols
==========================
@@ -29,11 +33,12 @@ How to use jack kcontrols
=========================
In order to keep compatibility, snd_jack_new() has been modified by
-adding two params :-
+adding two params:
- - @initial_kctl: if true, create a kcontrol and add it to the jack
- list.
- - @phantom_jack: Don't create a input device for phantom jacks.
+initial_kctl
+ if true, create a kcontrol and add it to the jack list.
+phantom_jack
+ Don't create a input device for phantom jacks.
HDA jacks can set phantom_jack to true in order to create a phantom
jack and set initial_kctl to true to create an initial kcontrol with
--
2.10.2
More information about the Alsa-devel
mailing list