[PATCH 1/8] qapi/audio: Fix description markup of AudiodevDBusOptions @nsamples

Markus Armbruster posted 8 patches 2 weeks ago
There is a newer version of this series
[PATCH 1/8] qapi/audio: Fix description markup of AudiodevDBusOptions @nsamples
Posted by Markus Armbruster 2 weeks ago
The description of Member @nsamples is indented incorrectly.  Comes
out like

    Members:
            [...]
	    nsamples (int, optional) – set the number of samples per read/write calls (default to 480,

    10ms at 48kHz).

Fixing the indentation makes it come out like

    Members:
            [...]
	    nsamples (int, optional) – set the number of samples per read/write calls (default to 480, 10ms at 48kHz).

Fixes: 19c628f2f579 (dbus: add -audio dbus nsamples option)
Signed-off-by: Markus Armbruster <armbru@redhat.com>
---
 qapi/audio.json | 4 ++--
 1 file changed, 2 insertions(+), 2 deletions(-)

diff --git a/qapi/audio.json b/qapi/audio.json
index 53142080f7..2df87b9710 100644
--- a/qapi/audio.json
+++ b/qapi/audio.json
@@ -76,8 +76,8 @@
 #
 # @out: options of the playback stream
 #
-# @nsamples: set the number of samples per read/write calls (default to 480,
-# 10ms at 48kHz).
+# @nsamples: set the number of samples per read/write calls
+#     (default to 480, 10ms at 48kHz).
 #
 # Since: 10.0
 ##
-- 
2.49.0


Re: [PATCH 1/8] qapi/audio: Fix description markup of AudiodevDBusOptions @nsamples
Posted by Philippe Mathieu-Daudé 2 weeks ago
On 31/10/25 10:47, Markus Armbruster wrote:
> The description of Member @nsamples is indented incorrectly.  Comes
> out like
> 
>      Members:
>              [...]
> 	    nsamples (int, optional) – set the number of samples per read/write calls (default to 480,
> 
>      10ms at 48kHz).
> 
> Fixing the indentation makes it come out like
> 
>      Members:
>              [...]
> 	    nsamples (int, optional) – set the number of samples per read/write calls (default to 480, 10ms at 48kHz).
> 
> Fixes: 19c628f2f579 (dbus: add -audio dbus nsamples option)
> Signed-off-by: Markus Armbruster <armbru@redhat.com>
> ---
>   qapi/audio.json | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)

Reviewed-by: Philippe Mathieu-Daudé <philmd@linaro.org>


Re: [PATCH 1/8] qapi/audio: Fix description markup of AudiodevDBusOptions @nsamples
Posted by Vladimir Sementsov-Ogievskiy 2 weeks ago
On 31.10.25 12:47, Markus Armbruster wrote:
> The description of Member @nsamples is indented incorrectly.  Comes
> out like
> 
>      Members:
>              [...]
> 	    nsamples (int, optional) – set the number of samples per read/write calls (default to 480,
> 
>      10ms at 48kHz).
> 
> Fixing the indentation makes it come out like
> 
>      Members:
>              [...]
> 	    nsamples (int, optional) – set the number of samples per read/write calls (default to 480, 10ms at 48kHz).
> 

I'm not sure this example worth breaking recommendation to
" not use lines that are longer than 76 characters in your commit message" :)

> Fixes: 19c628f2f579 (dbus: add -audio dbus nsamples option)
> Signed-off-by: Markus Armbruster <armbru@redhat.com>

Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

> ---
>   qapi/audio.json | 4 ++--
>   1 file changed, 2 insertions(+), 2 deletions(-)
> 
> diff --git a/qapi/audio.json b/qapi/audio.json
> index 53142080f7..2df87b9710 100644
> --- a/qapi/audio.json
> +++ b/qapi/audio.json
> @@ -76,8 +76,8 @@
>   #
>   # @out: options of the playback stream
>   #
> -# @nsamples: set the number of samples per read/write calls (default to 480,
> -# 10ms at 48kHz).
> +# @nsamples: set the number of samples per read/write calls
> +#     (default to 480, 10ms at 48kHz).
>   #
>   # Since: 10.0
>   ##


-- 
Best regards,
Vladimir

Re: [PATCH 1/8] qapi/audio: Fix description markup of AudiodevDBusOptions @nsamples
Posted by Markus Armbruster 2 weeks ago
Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru> writes:

> On 31.10.25 12:47, Markus Armbruster wrote:
>> The description of Member @nsamples is indented incorrectly.  Comes
>> out like
>>
>>      Members:
>>              [...]
>> 	         nsamples (int, optional) – set the number of samples per read/write calls (default to 480,
>>      10ms at 48kHz).
>>
>> Fixing the indentation makes it come out like
>>
>>      Members:
>>              [...]
>> 	        nsamples (int, optional) – set the number of samples per read/write calls (default to 480, 10ms at 48kHz).
>> 
>
> I'm not sure this example worth breaking recommendation to
> " not use lines that are longer than 76 characters in your commit message" :)

Accident, will tidy up.

>> Fixes: 19c628f2f579 (dbus: add -audio dbus nsamples option)
>> Signed-off-by: Markus Armbruster <armbru@redhat.com>
>
> Reviewed-by: Vladimir Sementsov-Ogievskiy <vsementsov@yandex-team.ru>

Thanks!