Re: [git patch] fix DocBook build

[Takashi Iwai <tiwai@suse.de>]

At Wed, 07 Sep 2005 07:27:54 -0400,
Jeff Garzik wrote:
> 
> Takashi Iwai wrote:
> > At Wed, 07 Sep 2005 12:00:31 +0200,
> > I wrote:
> > 
> >>At Wed, 7 Sep 2005 01:17:20 -0400,
> >>Jeff Garzik wrote:
> >>
> >>>
> >>>    [kernel-doc] fix various DocBook build problems/warnings
> >>>    
> >>>    Most serious is fixing include/sound/pcm.h, which breaks the DocBook
> >>>    build.
> >>
> >>What is the error exactly?  IIRC, it did work in the early version.
> >>Well, I need to test it by myself... 
> > 
> > 
> > OK, I see it, too.  How about the fix below, instead?
> > 
> > 
> > [PATCH] Fix DocBook build in sound/pcm.h
> > 
> > Signed-off-by: Takashi Iwai <tiwai@suse.de>
> > 
> > 
> > diff --git a/include/sound/pcm.h b/include/sound/pcm.h
> > --- a/include/sound/pcm.h
> > +++ b/include/sound/pcm.h
> > @@ -910,7 +910,7 @@ int snd_pcm_format_big_endian(snd_pcm_fo
> >   * Returns 1 if the given PCM format is CPU-endian, 0 if
> >   * opposite, or a negative error code if endian not specified.
> >   */
> > -/* int snd_pcm_format_cpu_endian(snd_pcm_format_t format); */
> > +int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
> >  #ifdef SNDRV_LITTLE_ENDIAN
> >  #define snd_pcm_format_cpu_endian	snd_pcm_format_little_endian
> >  #else
> 
> I considered that, but decided not to, given the C pre-processor games 
> that are occurring with that symbol shortly after the commented-out block.

The function doesn't exist but is declared just for docbook.  Since
it's replaced with the macro anyway, it shouldn't hurt.

To be safer, we can put #if 0 around the comment block and the pseudo
function definition.


Takashi


diff --git a/include/sound/pcm.h b/include/sound/pcm.h
--- a/include/sound/pcm.h
+++ b/include/sound/pcm.h
@@ -903,6 +903,7 @@ int snd_pcm_format_unsigned(snd_pcm_form
 int snd_pcm_format_linear(snd_pcm_format_t format);
 int snd_pcm_format_little_endian(snd_pcm_format_t format);
 int snd_pcm_format_big_endian(snd_pcm_format_t format);
+#if 0 /* just for DocBook */
 /**
  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
  * @format: the format to check
@@ -910,7 +911,8 @@ int snd_pcm_format_big_endian(snd_pcm_fo
  * Returns 1 if the given PCM format is CPU-endian, 0 if
  * opposite, or a negative error code if endian not specified.
  */
-/* int snd_pcm_format_cpu_endian(snd_pcm_format_t format); */
+int snd_pcm_format_cpu_endian(snd_pcm_format_t format);
+#endif /* DocBook */
 #ifdef SNDRV_LITTLE_ENDIAN
 #define snd_pcm_format_cpu_endian	snd_pcm_format_little_endian
 #else