diff options
| author | Takashi Iwai | 2016-11-10 22:11:21 +0100 |
|---|---|---|
| committer | Takashi Iwai | 2016-11-11 17:32:48 +0100 |
| commit | 8e5336a14476e7350b0cf78a99541de6ed51655c (patch) | |
| tree | 1a33b5c2dd80231df932588115fb6e41fc5c2433 | |
| parent | f336c3f072216a16187b22069681d014dcb43db6 (diff) | |
ASoC: doc: ReSTize overview.txt
A simple conversion from a plain text file.
Created a new subdirectory, Documentation/sound/soc, for this and
other ASoC documents.
Since the index page contains the TOC, so "Documentation" section got
removed from overview.
Acked-by: Mark Brown <broonie@kernel.org>
Signed-off-by: Takashi Iwai <tiwai@suse.de>
| -rw-r--r-- | Documentation/sound/index.rst | 1 | ||||
| -rw-r--r-- | Documentation/sound/soc/index.rst | 10 | ||||
| -rw-r--r-- | Documentation/sound/soc/overview.rst (renamed from Documentation/sound/alsa/soc/overview.txt) | 32 |
3 files changed, 14 insertions, 29 deletions
diff --git a/Documentation/sound/index.rst b/Documentation/sound/index.rst index 1f5d166f81c4..47b89f014e69 100644 --- a/Documentation/sound/index.rst +++ b/Documentation/sound/index.rst @@ -7,6 +7,7 @@ Linux Sound Subsystem Documentation kernel-api/index designs/index + soc/index alsa-configuration hd-audio/index cards/index diff --git a/Documentation/sound/soc/index.rst b/Documentation/sound/soc/index.rst new file mode 100644 index 000000000000..e974fd9f38a3 --- /dev/null +++ b/Documentation/sound/soc/index.rst @@ -0,0 +1,10 @@ +============== +ALSA SoC Layer +============== + +The documentation is spilt into the following sections:- + +.. toctree:: + :maxdepth: 2 + + overview diff --git a/Documentation/sound/alsa/soc/overview.txt b/Documentation/sound/soc/overview.rst index f3f28b7ae242..dc8370bbfff6 100644 --- a/Documentation/sound/alsa/soc/overview.txt +++ b/Documentation/sound/soc/overview.rst @@ -1,5 +1,6 @@ -ALSA SoC Layer -============== +======================= +ALSA SoC Layer Overview +======================= The overall project goal of the ALSA System on Chip (ASoC) layer is to provide better ALSA support for embedded system-on-chip processors (e.g. @@ -66,30 +67,3 @@ multiple re-usable component drivers :- describes and binds the other component drivers together to form an ALSA "sound card device". It handles any machine specific controls and machine level audio events (e.g. turning on an amp at start of playback). - - -Documentation -============= - -The documentation is spilt into the following sections:- - -overview.txt: This file. - -codec.txt: Codec driver internals. - -DAI.txt: Description of Digital Audio Interface standards and how to configure -a DAI within your codec and CPU DAI drivers. - -dapm.txt: Dynamic Audio Power Management - -platform.txt: Platform audio DMA and DAI. - -machine.txt: Machine driver internals. - -pop_clicks.txt: How to minimise audio artifacts. - -clocking.txt: ASoC clocking for best power performance. - -jack.txt: ASoC jack detection. - -DPCM.txt: Dynamic PCM - Describes DPCM with DSP examples. |