diff mbox

[1/2] ALSA: doc: Add missing headers and compress stuff to alsa-driver-api.tmpl

Message ID 1414507545-13362-1-git-send-email-tiwai@suse.de (mailing list archive)
State Accepted
Delegated to: Takashi Iwai
Headers show

Commit Message

Takashi Iwai Oct. 28, 2014, 2:45 p.m. UTC
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(+)

Comments

Vinod Koul Oct. 29, 2014, 5:48 a.m. UTC | #1
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
Takashi Iwai Oct. 29, 2014, 7:27 a.m. UTC | #2
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
diff mbox

Patch

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