[alsa-devel] [PATCH 08/10] ASoC: doc: ReSTize clocking.txt

Takashi Iwai tiwai at suse.de
Thu Nov 10 22:47:20 CET 2016


A simple conversion from a plain text file.

Signed-off-by: Takashi Iwai <tiwai at suse.de>
---
 .../sound/{alsa/soc/clocking.txt => soc/clocking.rst}       | 13 ++++---------
 Documentation/sound/soc/index.rst                           |  1 +
 2 files changed, 5 insertions(+), 9 deletions(-)
 rename Documentation/sound/{alsa/soc/clocking.txt => soc/clocking.rst} (94%)

diff --git a/Documentation/sound/alsa/soc/clocking.txt b/Documentation/sound/soc/clocking.rst
similarity index 94%
rename from Documentation/sound/alsa/soc/clocking.txt
rename to Documentation/sound/soc/clocking.rst
index b1300162e01c..32122d6877a3 100644
--- a/Documentation/sound/alsa/soc/clocking.txt
+++ b/Documentation/sound/soc/clocking.rst
@@ -1,3 +1,4 @@
+==============
 Audio Clocking
 ==============
 
@@ -30,15 +31,9 @@ runs at exactly the sample rate (LRC = Rate).
 
 Bit Clock can be generated as follows:-
 
-BCLK = MCLK / x
-
- or
-
-BCLK = LRC * x
-
- or
-
-BCLK = LRC * Channels * Word Size
+- BCLK = MCLK / x, or
+- BCLK = LRC * x, or
+- BCLK = LRC * Channels * Word Size
 
 This relationship depends on the codec or SoC CPU in particular. In general
 it is best to configure BCLK to the lowest possible speed (depending on your
diff --git a/Documentation/sound/soc/index.rst b/Documentation/sound/soc/index.rst
index 4dd679927a91..0055abe16e7e 100644
--- a/Documentation/sound/soc/index.rst
+++ b/Documentation/sound/soc/index.rst
@@ -14,3 +14,4 @@ The documentation is spilt into the following sections:-
    platform
    machine
    pops-clicks
+   clocking
-- 
2.10.2



More information about the Alsa-devel mailing list