[alsa-devel] [PATCH 1/2] ALSA: doc: Add missing headers and compress stuff to alsa-driver-api.tmpl
Some header files have kereldoc comments but are not referred properly. Let's add them.
Signed-off-by: Takashi Iwai tiwai@suse.de --- Documentation/DocBook/alsa-driver-api.tmpl | 12 ++++++++++++ 1 file changed, 12 insertions(+)
diff --git a/Documentation/DocBook/alsa-driver-api.tmpl b/Documentation/DocBook/alsa-driver-api.tmpl index 0230a96f0564..13f8b241f042 100644 --- a/Documentation/DocBook/alsa-driver-api.tmpl +++ b/Documentation/DocBook/alsa-driver-api.tmpl @@ -57,6 +57,7 @@ !Esound/core/pcm.c !Esound/core/pcm_lib.c !Esound/core/pcm_native.c +!include/sound/pcm.h </sect1> <sect1><title>PCM Format Helpers</title> !Esound/core/pcm_misc.c @@ -64,6 +65,10 @@ <sect1><title>PCM Memory Management</title> !Esound/core/pcm_memory.c </sect1> + <sect1><title>PCM DMA Engine API</title> +!Esound/core/pcm_dmaengine.c +!Iinclude/sound/dmaengine_pcm.h + </sect1> </chapter> <chapter><title>Control/Mixer API</title> <sect1><title>General Control Interface</title> @@ -91,12 +96,19 @@ !Esound/core/info.c </sect1> </chapter> + <chapter><title>Compress Offload</title> + <sect1><title>Compress Offload API</title> +!Esound/core/compress_offload.c +!Iinclude/sound/compress_driver.h + </sect1> + </chapter> <chapter><title>Miscellaneous Functions</title> <sect1><title>Hardware-Dependent Devices API</title> !Esound/core/hwdep.c </sect1> <sect1><title>Jack Abstraction Layer API</title> !Esound/core/jack.c +!Iinclude/sound/jack.h </sect1> <sect1><title>ISA DMA Helpers</title> !Esound/core/isadma.c
Signed-off-by: Takashi Iwai tiwai@suse.de --- include/sound/jack.h | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-)
diff --git a/include/sound/jack.h b/include/sound/jack.h index 58916573db58..37e612e77410 100644 --- a/include/sound/jack.h +++ b/include/sound/jack.h @@ -28,8 +28,9 @@ struct input_dev;
/** - * Jack types which can be reported. These values are used as a - * bitmask. + * enum snd_jack_types: Jack types which can be reported + * + * These values are used as a bitmask. * * Note that this must be kept in sync with the lookup table in * sound/core/jack.c.
On Tue, Oct 28, 2014 at 03:45:44PM +0100, Takashi Iwai wrote:
Some header files have kereldoc comments but are not referred properly. Let's add them.
Signed-off-by: Takashi Iwai tiwai@suse.de
Documentation/DocBook/alsa-driver-api.tmpl | 12 ++++++++++++ 1 file changed, 12 insertions(+)
diff --git a/Documentation/DocBook/alsa-driver-api.tmpl b/Documentation/DocBook/alsa-driver-api.tmpl index 0230a96f0564..13f8b241f042 100644 --- a/Documentation/DocBook/alsa-driver-api.tmpl +++ b/Documentation/DocBook/alsa-driver-api.tmpl @@ -57,6 +57,7 @@ !Esound/core/pcm.c !Esound/core/pcm_lib.c !Esound/core/pcm_native.c +!include/sound/pcm.h </sect1> <sect1><title>PCM Format Helpers</title> !Esound/core/pcm_misc.c @@ -64,6 +65,10 @@ <sect1><title>PCM Memory Management</title> !Esound/core/pcm_memory.c </sect1>
<sect1><title>PCM DMA Engine API</title>+!Esound/core/pcm_dmaengine.c +!Iinclude/sound/dmaengine_pcm.h
</sect1></chapter> <chapter><title>Control/Mixer API</title> <sect1><title>General Control Interface</title>
@@ -91,12 +96,19 @@ !Esound/core/info.c </sect1>
</chapter> + <chapter><title>Compress Offload</title> + <sect1><title>Compress Offload API</title> +!Esound/core/compress_offload.c +!Iinclude/sound/compress_driver.h
Was include/uapi/sound/compress_offload.h and compress_params.h added somewhere else, if not can you pls add those as well
At Wed, 29 Oct 2014 11:18:38 +0530, Vinod Koul wrote:
On Tue, Oct 28, 2014 at 03:45:44PM +0100, Takashi Iwai wrote:
Some header files have kereldoc comments but are not referred properly. Let's add them.
Signed-off-by: Takashi Iwai tiwai@suse.de
Documentation/DocBook/alsa-driver-api.tmpl | 12 ++++++++++++ 1 file changed, 12 insertions(+)
diff --git a/Documentation/DocBook/alsa-driver-api.tmpl b/Documentation/DocBook/alsa-driver-api.tmpl index 0230a96f0564..13f8b241f042 100644 --- a/Documentation/DocBook/alsa-driver-api.tmpl +++ b/Documentation/DocBook/alsa-driver-api.tmpl @@ -57,6 +57,7 @@ !Esound/core/pcm.c !Esound/core/pcm_lib.c !Esound/core/pcm_native.c +!include/sound/pcm.h </sect1> <sect1><title>PCM Format Helpers</title> !Esound/core/pcm_misc.c @@ -64,6 +65,10 @@ <sect1><title>PCM Memory Management</title> !Esound/core/pcm_memory.c </sect1>
<sect1><title>PCM DMA Engine API</title>+!Esound/core/pcm_dmaengine.c +!Iinclude/sound/dmaengine_pcm.h
</sect1></chapter> <chapter><title>Control/Mixer API</title> <sect1><title>General Control Interface</title>
@@ -91,12 +96,19 @@ !Esound/core/info.c </sect1>
</chapter> + <chapter><title>Compress Offload</title> + <sect1><title>Compress Offload API</title> +!Esound/core/compress_offload.c +!Iinclude/sound/compress_driver.h
Was include/uapi/sound/compress_offload.h and compress_params.h added somewhere else, if not can you pls add those as well
Submitted a patch series now.
Takashi
participants (2)
-
Takashi Iwai -
Vinod Koul