alsa-devel.alsa-project.org archive mirror
 help / color / mirror / Atom feed
From: Takashi Iwai <tiwai@suse.de>
To: alsa-devel@alsa-project.org
Cc: Liam Girdwood <liam.r.girdwood@linux.intel.com>,
	Mark Brown <broonie@kernel.org>
Subject: [PATCH 06/10] ASoC: doc: ReSTize machine.txt
Date: Thu, 10 Nov 2016 22:47:18 +0100	[thread overview]
Message-ID: <20161110214722.14698-7-tiwai@suse.de> (raw)
In-Reply-To: <20161110214722.14698-1-tiwai@suse.de>

A simple conversion from a plain text file.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
 Documentation/sound/soc/index.rst                  |  1 +
 .../{alsa/soc/machine.txt => soc/machine.rst}      | 22 +++++++++++++---------
 2 files changed, 14 insertions(+), 9 deletions(-)
 rename Documentation/sound/{alsa/soc/machine.txt => soc/machine.rst} (90%)

diff --git a/Documentation/sound/soc/index.rst b/Documentation/sound/soc/index.rst
index c5a55195bf4d..4ac3585e7dd1 100644
--- a/Documentation/sound/soc/index.rst
+++ b/Documentation/sound/soc/index.rst
@@ -12,3 +12,4 @@ The documentation is spilt into the following sections:-
    dai
    dapm
    platform
+   machine
diff --git a/Documentation/sound/alsa/soc/machine.txt b/Documentation/sound/soc/machine.rst
similarity index 90%
rename from Documentation/sound/alsa/soc/machine.txt
rename to Documentation/sound/soc/machine.rst
index 6bf2d2063b52..515c9444deaf 100644
--- a/Documentation/sound/alsa/soc/machine.txt
+++ b/Documentation/sound/soc/machine.rst
@@ -1,3 +1,4 @@
+===================
 ASoC Machine Driver
 ===================
 
@@ -9,9 +10,10 @@ interrupts, clocking, jacks and voltage regulators.
 The machine driver can contain codec and platform specific code. It registers
 the audio subsystem with the kernel as a platform device and is represented by
 the following struct:-
+::
 
-/* SoC machine */
-struct snd_soc_card {
+  /* SoC machine */
+  struct snd_soc_card {
 	char *name;
 
 	...
@@ -33,7 +35,7 @@ struct snd_soc_card {
 	int num_links;
 
 	...
-};
+  };
 
 probe()/remove()
 ----------------
@@ -55,9 +57,10 @@ initialisation e.g. the machine audio map can be connected to the codec audio
 map, unconnected codec pins can be set as such.
 
 struct snd_soc_dai_link is used to set up each DAI in your machine. e.g.
+::
 
-/* corgi digital audio interface glue - connects codec <--> CPU */
-static struct snd_soc_dai_link corgi_dai = {
+  /* corgi digital audio interface glue - connects codec <--> CPU */
+  static struct snd_soc_dai_link corgi_dai = {
 	.name = "WM8731",
 	.stream_name = "WM8731",
 	.cpu_dai_name = "pxa-is2-dai",
@@ -66,16 +69,17 @@ static struct snd_soc_dai_link corgi_dai = {
 	.codec_name = "wm8713-codec.0-001a",
 	.init = corgi_wm8731_init,
 	.ops = &corgi_ops,
-};
+  };
 
 struct snd_soc_card then sets up the machine with its DAIs. e.g.
+::
 
-/* corgi audio machine driver */
-static struct snd_soc_card snd_soc_corgi = {
+  /* corgi audio machine driver */
+  static struct snd_soc_card snd_soc_corgi = {
 	.name = "Corgi",
 	.dai_link = &corgi_dai,
 	.num_links = 1,
-};
+  };
 
 
 Machine Power Map
-- 
2.10.2

  parent reply	other threads:[~2016-11-10 21:47 UTC|newest]

Thread overview: 13+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2016-11-10 21:47 [PATCH 00/10] ASoC: Modernize documents Takashi Iwai
2016-11-10 21:47 ` [PATCH 01/10] ASoC: doc: ReSTize overview.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 02/10] ASoC: doc: ReSTize codec.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 03/10] ASoC: doc: ReSTize DAI.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 04/10] ASoC: doc: ReSTize dapm.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 05/10] ASoC: doc: ReSTize platform.txt Takashi Iwai
2016-11-10 21:47 ` Takashi Iwai [this message]
2016-11-10 21:47 ` [PATCH 07/10] ASoC: doc: ReSTize pops_clicks.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 08/10] ASoC: doc: ReSTize clocking.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 09/10] ASoC: doc: ReSTize jack.txt Takashi Iwai
2016-11-10 21:47 ` [PATCH 10/10] ASoC: doc: ReSTize DPCM.txt Takashi Iwai
2016-11-11 15:16 ` [PATCH 00/10] ASoC: Modernize documents Mark Brown
2016-11-11 15:57   ` Takashi Iwai

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=20161110214722.14698-7-tiwai@suse.de \
    --to=tiwai@suse.de \
    --cc=alsa-devel@alsa-project.org \
    --cc=broonie@kernel.org \
    --cc=liam.r.girdwood@linux.intel.com \
    /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 a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).