Skip to content

Commit 8551914

Browse files
tiwaitiwai
committed
ALSA: doc: ReSTize alsa-driver-api document
A simple conversion of alsa-driver-api document from DocBook to ReST. It's moved to the new Documentation/sound/kernel-api subdirectory that will contain other ALSA kernel API documents. The GPL legal note was removed, as it's superfluous (and doesn't fit with ReST kernel docs pretty well). Signed-off-by: Takashi Iwai <[email protected]>
1 parent 3a5182c commit 8551914

File tree

6 files changed

+158
-143
lines changed

6 files changed

+158
-143
lines changed

‎Documentation/DocBook/Makefile

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@ DOCBOOKS := z8530book.xml \
1313
gadget.xml libata.xml mtdnand.xml librs.xml rapidio.xml \
1414
genericirq.xml s390-drivers.xml uio-howto.xml scsi.xml \
1515
debugobjects.xml sh.xml regulator.xml \
16-
alsa-driver-api.xml writing-an-alsa-driver.xml \
16+
writing-an-alsa-driver.xml \
1717
tracepoint.xml w1.xml \
1818
writing_musb_glue_layer.xml crypto-API.xml iio.xml
1919

‎Documentation/DocBook/alsa-driver-api.tmpl

Lines changed: 0 additions & 142 deletions
This file was deleted.

‎Documentation/index.rst

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ Contents:
1818
media/index
1919
gpu/index
2020
80211/index
21+
sound/index
2122

2223
Indices and tables
2324
==================

‎Documentation/sound/index.rst

Lines changed: 15 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,15 @@
1+
===================================
2+
Linux Sound Subsystem Documentation
3+
===================================
4+
5+
.. toctree::
6+
:maxdepth: 2
7+
8+
kernel-api/index
9+
10+
.. only:: subproject
11+
12+
Indices
13+
=======
14+
15+
* :ref:`genindex`

‎Documentation/sound/kernel-api/alsa-driver-api.rst

Lines changed: 134 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,134 @@
1+
===================
2+
The ALSA Driver API
3+
===================
4+
5+
Management of Cards and Devices
6+
===============================
7+
8+
Card Management
9+
---------------
10+
.. kernel-doc:: sound/core/init.c
11+
12+
Device Components
13+
-----------------
14+
.. kernel-doc:: sound/core/device.c
15+
16+
Module requests and Device File Entries
17+
---------------------------------------
18+
.. kernel-doc:: sound/core/sound.c
19+
20+
Memory Management Helpers
21+
-------------------------
22+
.. kernel-doc:: sound/core/memory.c
23+
.. kernel-doc:: sound/core/memalloc.c
24+
25+
26+
PCM API
27+
=======
28+
29+
PCM Core
30+
--------
31+
.. kernel-doc:: sound/core/pcm.c
32+
.. kernel-doc:: sound/core/pcm_lib.c
33+
.. kernel-doc:: sound/core/pcm_native.c
34+
.. kernel-doc:: include/sound/pcm.h
35+
36+
PCM Format Helpers
37+
------------------
38+
.. kernel-doc:: sound/core/pcm_misc.c
39+
40+
PCM Memory Management
41+
---------------------
42+
.. kernel-doc:: sound/core/pcm_memory.c
43+
44+
PCM DMA Engine API
45+
------------------
46+
.. kernel-doc:: sound/core/pcm_dmaengine.c
47+
.. kernel-doc:: include/sound/dmaengine_pcm.h
48+
49+
Control/Mixer API
50+
=================
51+
52+
General Control Interface
53+
-------------------------
54+
.. kernel-doc:: sound/core/control.c
55+
56+
AC97 Codec API
57+
--------------
58+
.. kernel-doc:: sound/pci/ac97/ac97_codec.c
59+
.. kernel-doc:: sound/pci/ac97/ac97_pcm.c
60+
61+
Virtual Master Control API
62+
--------------------------
63+
.. kernel-doc:: sound/core/vmaster.c
64+
.. kernel-doc:: include/sound/control.h
65+
66+
MIDI API
67+
========
68+
69+
Raw MIDI API
70+
------------
71+
.. kernel-doc:: sound/core/rawmidi.c
72+
73+
MPU401-UART API
74+
---------------
75+
.. kernel-doc:: sound/drivers/mpu401/mpu401_uart.c
76+
77+
Proc Info API
78+
=============
79+
80+
Proc Info Interface
81+
-------------------
82+
.. kernel-doc:: sound/core/info.c
83+
84+
Compress Offload
85+
================
86+
87+
Compress Offload API
88+
--------------------
89+
.. kernel-doc:: sound/core/compress_offload.c
90+
.. kernel-doc:: include/uapi/sound/compress_offload.h
91+
.. kernel-doc:: include/uapi/sound/compress_params.h
92+
.. kernel-doc:: include/sound/compress_driver.h
93+
94+
ASoC
95+
====
96+
97+
ASoC Core API
98+
-------------
99+
.. kernel-doc:: include/sound/soc.h
100+
.. kernel-doc:: sound/soc/soc-core.c
101+
.. kernel-doc:: sound/soc/soc-devres.c
102+
.. kernel-doc:: sound/soc/soc-io.c
103+
.. kernel-doc:: sound/soc/soc-pcm.c
104+
.. kernel-doc:: sound/soc/soc-ops.c
105+
.. kernel-doc:: sound/soc/soc-compress.c
106+
107+
ASoC DAPM API
108+
-------------
109+
.. kernel-doc:: sound/soc/soc-dapm.c
110+
111+
ASoC DMA Engine API
112+
-------------------
113+
.. kernel-doc:: sound/soc/soc-generic-dmaengine-pcm.c
114+
115+
Miscellaneous Functions
116+
=======================
117+
118+
Hardware-Dependent Devices API
119+
------------------------------
120+
.. kernel-doc:: sound/core/hwdep.c
121+
122+
Jack Abstraction Layer API
123+
--------------------------
124+
.. kernel-doc:: include/sound/jack.h
125+
.. kernel-doc:: sound/core/jack.c
126+
.. kernel-doc:: sound/soc/soc-jack.c
127+
128+
ISA DMA Helpers
129+
---------------
130+
.. kernel-doc:: sound/core/isadma.c
131+
132+
Other Helper Macros
133+
-------------------
134+
.. kernel-doc:: include/sound/core.h

‎Documentation/sound/kernel-api/index.rst

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
ALSA Kernel API Documentation
2+
=============================
3+
4+
.. toctree::
5+
:maxdepth: 2
6+
7+
alsa-driver-api

0 commit comments

Comments
 (0)