[1/2] audio: fix buffer-length typo in documentation
diff mbox series

Message ID 20190911145818.18962-2-stefanha@redhat.com
State New
Headers show
Series
  • audio: -audiodev documentation tweaks
Related show

Commit Message

Stefan Hajnoczi Sept. 11, 2019, 2:58 p.m. UTC
Fixes: f0b3d811529 ("audio: -audiodev command line option: documentation")
Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
---
 qemu-options.hx | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

Comments

=?UTF-8?q?K=C5=91v=C3=A1g=C3=B3=2C=20Zolt=C3=A1n?= Sept. 17, 2019, 7:29 p.m. UTC | #1
On 2019-09-11 16:58, Stefan Hajnoczi wrote:
> Fixes: f0b3d811529 ("audio: -audiodev command line option: documentation")
> Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> ---
>   qemu-options.hx | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/qemu-options.hx b/qemu-options.hx
> index bbfd936d29..a4f9f74f52 100644
> --- a/qemu-options.hx
> +++ b/qemu-options.hx
> @@ -439,7 +439,7 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
>       "                in|out.format= sample format to use with fixed settings\n"
>       "                valid values: s8, s16, s32, u8, u16, u32\n"
>       "                in|out.voices= number of voices to use\n"
> -    "                in|out.buffer-len= length of buffer in microseconds\n"
> +    "                in|out.buffer-length= length of buffer in microseconds\n"
>       "-audiodev none,id=id,[,prop[=value][,...]]\n"
>       "                dummy driver that discards all output\n"
>   #ifdef CONFIG_AUDIO_ALSA
> @@ -524,7 +524,7 @@ Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},
>   @item in|out.voices=@var{voices}
>   Specify the number of @var{voices} to use.  Default is 1.
>   
> -@item in|out.buffer=@var{usecs}
> +@item in|out.buffer-length=@var{usecs}
>   Sets the size of the buffer in microseconds.
>   
>   @end table
> 

Double checking it's indeed "buffer-length" in qapi.  Also I spot a 
different bug: the alsa documentation qemu-options.hx has "period-len" 
but according to qapi it should be "period-length".  Care to fix it or 
should I submit a different patch?

Regards,
Zoltan
Stefan Hajnoczi Sept. 18, 2019, 9:47 a.m. UTC | #2
On Tue, Sep 17, 2019 at 09:29:34PM +0200, Zoltán Kővágó wrote:
> On 2019-09-11 16:58, Stefan Hajnoczi wrote:
> > Fixes: f0b3d811529 ("audio: -audiodev command line option: documentation")
> > Signed-off-by: Stefan Hajnoczi <stefanha@redhat.com>
> > ---
> >   qemu-options.hx | 4 ++--
> >   1 file changed, 2 insertions(+), 2 deletions(-)
> > 
> > diff --git a/qemu-options.hx b/qemu-options.hx
> > index bbfd936d29..a4f9f74f52 100644
> > --- a/qemu-options.hx
> > +++ b/qemu-options.hx
> > @@ -439,7 +439,7 @@ DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
> >       "                in|out.format= sample format to use with fixed settings\n"
> >       "                valid values: s8, s16, s32, u8, u16, u32\n"
> >       "                in|out.voices= number of voices to use\n"
> > -    "                in|out.buffer-len= length of buffer in microseconds\n"
> > +    "                in|out.buffer-length= length of buffer in microseconds\n"
> >       "-audiodev none,id=id,[,prop[=value][,...]]\n"
> >       "                dummy driver that discards all output\n"
> >   #ifdef CONFIG_AUDIO_ALSA
> > @@ -524,7 +524,7 @@ Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},
> >   @item in|out.voices=@var{voices}
> >   Specify the number of @var{voices} to use.  Default is 1.
> > -@item in|out.buffer=@var{usecs}
> > +@item in|out.buffer-length=@var{usecs}
> >   Sets the size of the buffer in microseconds.
> >   @end table
> > 
> 
> Double checking it's indeed "buffer-length" in qapi.  Also I spot a
> different bug: the alsa documentation qemu-options.hx has "period-len" but
> according to qapi it should be "period-length".  Care to fix it or should I
> submit a different patch?

Thanks.  I will send another revision.

Stefan

Patch
diff mbox series

diff --git a/qemu-options.hx b/qemu-options.hx
index bbfd936d29..a4f9f74f52 100644
--- a/qemu-options.hx
+++ b/qemu-options.hx
@@ -439,7 +439,7 @@  DEF("audiodev", HAS_ARG, QEMU_OPTION_audiodev,
     "                in|out.format= sample format to use with fixed settings\n"
     "                valid values: s8, s16, s32, u8, u16, u32\n"
     "                in|out.voices= number of voices to use\n"
-    "                in|out.buffer-len= length of buffer in microseconds\n"
+    "                in|out.buffer-length= length of buffer in microseconds\n"
     "-audiodev none,id=id,[,prop[=value][,...]]\n"
     "                dummy driver that discards all output\n"
 #ifdef CONFIG_AUDIO_ALSA
@@ -524,7 +524,7 @@  Valid values are: @code{s8}, @code{s16}, @code{s32}, @code{u8},
 @item in|out.voices=@var{voices}
 Specify the number of @var{voices} to use.  Default is 1.
 
-@item in|out.buffer=@var{usecs}
+@item in|out.buffer-length=@var{usecs}
 Sets the size of the buffer in microseconds.
 
 @end table