Donate to e Foundation | Murena handsets with /e/OS | Own a part of Murena! Learn more

Commit 8e5336a1 authored by Takashi Iwai's avatar Takashi Iwai
Browse files

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: default avatarMark Brown <broonie@kernel.org>
Signed-off-by: default avatarTakashi Iwai <tiwai@suse.de>
parent f336c3f0

Documentation/sound/index.rst

+1 −0
Original line number Diff line number Diff line
@@ -7,6 +7,7 @@ Linux Sound Subsystem Documentation 


   kernel-api/index

   designs/index

   soc/index

   alsa-configuration

   hd-audio/index

   cards/index

Documentation/sound/soc/index.rst

0 → 100644
+10 −0
Original line number Diff line number Diff line 
==============

ALSA SoC Layer

==============



The documentation is spilt into the following sections:-



.. toctree::

   :maxdepth: 2



   overview

Documentation/sound/alsa/soc/overview.txt→Documentation/sound/soc/overview.rst

+3 −29
Original line number Diff line number Diff line 
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.