diff mbox

[10/13] sound: fix the comments that refers to kernel-doc

Message ID 3514c2b81341c160bf6753cb47fa2346f3b5a0e7.1494775891.git.mchehab@s-opensource.com (mailing list archive)
State New, archived
Headers show

Commit Message

Mauro Carvalho Chehab May 14, 2017, 3:38 p.m. UTC
The markup inside the #if 0 comment actually refers to a
kernel-doc markup. As we're getting rid of DocBook update it.

Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>
---
 include/sound/pcm.h | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)

Comments

Takashi Iwai May 15, 2017, 9:04 a.m. UTC | #1
On Sun, 14 May 2017 17:38:44 +0200,
Mauro Carvalho Chehab wrote:
> 
> The markup inside the #if 0 comment actually refers to a
> kernel-doc markup. As we're getting rid of DocBook update it.
> 
> Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>

I guess you prefer taking it from your tree?  Feel free to take my
ack:
  Reviewed-by: Takashi Iwai <tiwai@suse.de>


thanks,

Takashi

> ---
>  include/sound/pcm.h | 2 +-
>  1 file changed, 1 insertion(+), 1 deletion(-)
> 
> diff --git a/include/sound/pcm.h b/include/sound/pcm.h
> index 361749e60799..bbf97d4c4c17 100644
> --- a/include/sound/pcm.h
> +++ b/include/sound/pcm.h
> @@ -1054,7 +1054,7 @@ int snd_pcm_format_unsigned(snd_pcm_format_t format);
>  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 */
> +#if 0 /* just for kernel-doc */
>  /**
>   * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
>   * @format: the format to check
> -- 
> 2.9.3
> 
>
Mauro Carvalho Chehab May 16, 2017, 10:46 a.m. UTC | #2
Em Mon, 15 May 2017 11:04:26 +0200
Takashi Iwai <tiwai@suse.de> escreveu:

> On Sun, 14 May 2017 17:38:44 +0200,
> Mauro Carvalho Chehab wrote:
> > 
> > The markup inside the #if 0 comment actually refers to a
> > kernel-doc markup. As we're getting rid of DocBook update it.
> > 
> > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>  
> 
> I guess you prefer taking it from your tree?  Feel free to take my
> ack:
>   Reviewed-by: Takashi Iwai <tiwai@suse.de>

In the specific case of this patch, it doesn't matter much from what
tree it would be merged, as no other patch depends on it ;)

So, if you prefer, you can merge it directly on your tree. Otherwise,
I'll keep it on my pile of patches to be send to docs -next.


> 
> 
> thanks,
> 
> Takashi
> 
> > ---
> >  include/sound/pcm.h | 2 +-
> >  1 file changed, 1 insertion(+), 1 deletion(-)
> > 
> > diff --git a/include/sound/pcm.h b/include/sound/pcm.h
> > index 361749e60799..bbf97d4c4c17 100644
> > --- a/include/sound/pcm.h
> > +++ b/include/sound/pcm.h
> > @@ -1054,7 +1054,7 @@ int snd_pcm_format_unsigned(snd_pcm_format_t format);
> >  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 */
> > +#if 0 /* just for kernel-doc */
> >  /**
> >   * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
> >   * @format: the format to check
> > -- 
> > 2.9.3
> > 
> >   



Thanks,
Mauro
Takashi Iwai May 16, 2017, 10:50 a.m. UTC | #3
On Tue, 16 May 2017 12:46:53 +0200,
Mauro Carvalho Chehab wrote:
> 
> Em Mon, 15 May 2017 11:04:26 +0200
> Takashi Iwai <tiwai@suse.de> escreveu:
> 
> > On Sun, 14 May 2017 17:38:44 +0200,
> > Mauro Carvalho Chehab wrote:
> > > 
> > > The markup inside the #if 0 comment actually refers to a
> > > kernel-doc markup. As we're getting rid of DocBook update it.
> > > 
> > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>  
> > 
> > I guess you prefer taking it from your tree?  Feel free to take my
> > ack:
> >   Reviewed-by: Takashi Iwai <tiwai@suse.de>
> 
> In the specific case of this patch, it doesn't matter much from what
> tree it would be merged, as no other patch depends on it ;)
> 
> So, if you prefer, you can merge it directly on your tree. Otherwise,
> I'll keep it on my pile of patches to be send to docs -next.

OK, since the PCM stuff is being changed for 4.13, may be it's safer
that I take this patch in sound git tree.


thanks,

Takashi

> 
> 
> > 
> > 
> > thanks,
> > 
> > Takashi
> > 
> > > ---
> > >  include/sound/pcm.h | 2 +-
> > >  1 file changed, 1 insertion(+), 1 deletion(-)
> > > 
> > > diff --git a/include/sound/pcm.h b/include/sound/pcm.h
> > > index 361749e60799..bbf97d4c4c17 100644
> > > --- a/include/sound/pcm.h
> > > +++ b/include/sound/pcm.h
> > > @@ -1054,7 +1054,7 @@ int snd_pcm_format_unsigned(snd_pcm_format_t format);
> > >  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 */
> > > +#if 0 /* just for kernel-doc */
> > >  /**
> > >   * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
> > >   * @format: the format to check
> > > -- 
> > > 2.9.3
> > > 
> > >   
> 
> 
> 
> Thanks,
> Mauro
>
Mauro Carvalho Chehab May 16, 2017, 10:55 a.m. UTC | #4
Em Tue, 16 May 2017 12:50:55 +0200
Takashi Iwai <tiwai@suse.de> escreveu:

> On Tue, 16 May 2017 12:46:53 +0200,
> Mauro Carvalho Chehab wrote:
> > 
> > Em Mon, 15 May 2017 11:04:26 +0200
> > Takashi Iwai <tiwai@suse.de> escreveu:
> >   
> > > On Sun, 14 May 2017 17:38:44 +0200,
> > > Mauro Carvalho Chehab wrote:  
> > > > 
> > > > The markup inside the #if 0 comment actually refers to a
> > > > kernel-doc markup. As we're getting rid of DocBook update it.
> > > > 
> > > > Signed-off-by: Mauro Carvalho Chehab <mchehab@s-opensource.com>    
> > > 
> > > I guess you prefer taking it from your tree?  Feel free to take my
> > > ack:
> > >   Reviewed-by: Takashi Iwai <tiwai@suse.de>  
> > 
> > In the specific case of this patch, it doesn't matter much from what
> > tree it would be merged, as no other patch depends on it ;)
> > 
> > So, if you prefer, you can merge it directly on your tree. Otherwise,
> > I'll keep it on my pile of patches to be send to docs -next.  
> 
> OK, since the PCM stuff is being changed for 4.13, may be it's safer
> that I take this patch in sound git tree.

OK! I'll remove from my patch pile :-)

Thanks,
Mauro
diff mbox

Patch

diff --git a/include/sound/pcm.h b/include/sound/pcm.h
index 361749e60799..bbf97d4c4c17 100644
--- a/include/sound/pcm.h
+++ b/include/sound/pcm.h
@@ -1054,7 +1054,7 @@  int snd_pcm_format_unsigned(snd_pcm_format_t format);
 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 */
+#if 0 /* just for kernel-doc */
 /**
  * snd_pcm_format_cpu_endian - Check the PCM format is CPU-endian
  * @format: the format to check