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 01/10] ASoC: doc: ReSTize overview.txt
Date: Thu, 10 Nov 2016 22:47:13 +0100	[thread overview]
Message-ID: <20161110214722.14698-2-tiwai@suse.de> (raw)
In-Reply-To: <20161110214722.14698-1-tiwai@suse.de>

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.

Signed-off-by: Takashi Iwai <tiwai@suse.de>
---
 Documentation/sound/index.rst                      |  1 +
 Documentation/sound/soc/index.rst                  | 10 +++++++
 .../{alsa/soc/overview.txt => soc/overview.rst}    | 32 ++--------------------
 3 files changed, 14 insertions(+), 29 deletions(-)
 create mode 100644 Documentation/sound/soc/index.rst
 rename Documentation/sound/{alsa/soc/overview.txt => soc/overview.rst} (83%)

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
similarity index 83%
rename from Documentation/sound/alsa/soc/overview.txt
rename to 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.
-- 
2.10.2

  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 ` Takashi Iwai [this message]
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 ` [PATCH 06/10] ASoC: doc: ReSTize machine.txt Takashi Iwai
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-2-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).