[alsa-devel] [PATCH 00/10] ASoC: Modernize documents

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


Hi,

this patchset converts the ASoC text documents to ReST format, which
has been recently introduced to the kernel tree.  The conversions are
really simple since the original texts were already well formatted.

The files are moved to Documentation/sound/soc, and TOC is to the
index page.

All the patches are found in topic/rest-docs branch of sound git
tree.

The new file after 4.9 isn't covered yet, as the branch is based on
4.9-rc4.  I found only soc/codec_to_codec.txt in linux-next, and it
seems easy to convert.  Mark, let me know how you'd like to organize.
I can pull your branch and convert in my side, or you pull mine and do
it on yours.


thanks,

Takashi

===

Takashi Iwai (10):
  ASoC: doc: ReSTize overview.txt
  ASoC: doc: ReSTize codec.txt
  ASoC: doc: ReSTize DAI.txt
  ASoC: doc: ReSTize dapm.txt
  ASoC: doc: ReSTize platform.txt
  ASoC: doc: ReSTize machine.txt
  ASoC: doc: ReSTize pops_clicks.txt
  ASoC: doc: ReSTize clocking.txt
  ASoC: doc: ReSTize jack.txt
  ASoC: doc: ReSTize DPCM.txt

 Documentation/sound/index.rst                      |   1 +
 .../{alsa/soc/clocking.txt => soc/clocking.rst}    |  13 +-
 .../sound/{alsa/soc/codec.txt => soc/codec.rst}    |  75 +++---
 .../sound/{alsa/soc/DAI.txt => soc/dai.rst}        |  28 ++-
 .../sound/{alsa/soc/dapm.txt => soc/dapm.rst}      | 249 ++++++++++--------
 .../sound/{alsa/soc/DPCM.txt => soc/dpcm.rst}      | 280 +++++++++++----------
 Documentation/sound/soc/index.rst                  |  19 ++
 .../sound/{alsa/soc/jack.txt => soc/jack.rst}      |   1 +
 .../{alsa/soc/machine.txt => soc/machine.rst}      |  22 +-
 .../{alsa/soc/overview.txt => soc/overview.rst}    |  32 +--
 .../{alsa/soc/platform.txt => soc/platform.rst}    |  31 +--
 .../soc/pops_clicks.txt => soc/pops-clicks.rst}    |  15 +-
 12 files changed, 417 insertions(+), 349 deletions(-)
 rename Documentation/sound/{alsa/soc/clocking.txt => soc/clocking.rst} (94%)
 rename Documentation/sound/{alsa/soc/codec.txt => soc/codec.rst} (84%)
 rename Documentation/sound/{alsa/soc/DAI.txt => soc/dai.rst} (71%)
 rename Documentation/sound/{alsa/soc/dapm.txt => soc/dapm.rst} (62%)
 rename Documentation/sound/{alsa/soc/DPCM.txt => soc/dpcm.rst} (57%)
 create mode 100644 Documentation/sound/soc/index.rst
 rename Documentation/sound/{alsa/soc/jack.txt => soc/jack.rst} (99%)
 rename Documentation/sound/{alsa/soc/machine.txt => soc/machine.rst} (90%)
 rename Documentation/sound/{alsa/soc/overview.txt => soc/overview.rst} (83%)
 rename Documentation/sound/{alsa/soc/platform.txt => soc/platform.rst} (81%)
 rename Documentation/sound/{alsa/soc/pops_clicks.txt => soc/pops-clicks.rst} (87%)

-- 
2.10.2



More information about the Alsa-devel mailing list