[v4] qapi/qom: Memory backend property prealloc-threads doc fix

[PATCH v4] qapi/qom: Memory backend property prealloc-threads doc fix

Posted by Zhenyu Zhang 1 year, 5 months ago

Commit ffac16fab3 "hostmem: introduce "prealloc-threads" property"
(v5.0.0) changed the default number of threads from number of CPUs
to 1.  This was deemed a regression, and fixed in commit f8d426a685
"hostmem: default the amount of prealloc-threads to smp-cpus".
Except the documentation remained unchanged.

Update 'qapi/qom.json' to reflect the change in commit f8d426a6852c.

Signed-off-by: Zhenyu Zhang <zhenyzha@redhat.com>
---

v4: Fix the line exceeding 80 characters limitation issue  (Gavin)
v3: Covers historical descriptions                         (Markus)
v2: The property is changed to smp-cpus since 5.0          (Phild)

---
 qapi/qom.json | 3 ++-
 1 file changed, 2 insertions(+), 1 deletion(-)

diff --git a/qapi/qom.json b/qapi/qom.json
index 30e76653ad..f4a7917f3d 100644
--- a/qapi/qom.json
+++ b/qapi/qom.json
@@ -576,7 +576,8 @@
 #
 # @prealloc: if true, preallocate memory (default: false)
 #
-# @prealloc-threads: number of CPU threads to use for prealloc (default: 1)
+# @prealloc-threads: number of CPU threads to use for prealloc 
+#                    (default: number of CPUs) (since 5.0)
 #
 # @prealloc-context: thread context to use for creation of preallocation threads
 #                    (default: none) (since 7.2)
-- 
2.31.1

Re: [PATCH v4] qapi/qom: Memory backend property prealloc-threads doc fix

Posted by Markus Armbruster 1 year, 5 months ago

Zhenyu Zhang <zhenyzha@redhat.com> writes:

> Commit ffac16fab3 "hostmem: introduce "prealloc-threads" property"
> (v5.0.0) changed the default number of threads from number of CPUs
> to 1.  This was deemed a regression, and fixed in commit f8d426a685
> "hostmem: default the amount of prealloc-threads to smp-cpus".
> Except the documentation remained unchanged.
>
> Update 'qapi/qom.json' to reflect the change in commit f8d426a6852c.
>
> Signed-off-by: Zhenyu Zhang <zhenyzha@redhat.com>
> ---
>
> v4: Fix the line exceeding 80 characters limitation issue  (Gavin)
> v3: Covers historical descriptions                         (Markus)
> v2: The property is changed to smp-cpus since 5.0          (Phild)
>
> ---
>  qapi/qom.json | 3 ++-
>  1 file changed, 2 insertions(+), 1 deletion(-)
>
> diff --git a/qapi/qom.json b/qapi/qom.json
> index 30e76653ad..f4a7917f3d 100644
> --- a/qapi/qom.json
> +++ b/qapi/qom.json
> @@ -576,7 +576,8 @@
>  #
>  # @prealloc: if true, preallocate memory (default: false)
>  #
> -# @prealloc-threads: number of CPU threads to use for prealloc (default: 1)
> +# @prealloc-threads: number of CPU threads to use for prealloc 

Could drop "CPU" while there.  Not worth a respin by itself, but perhaps
the maintainer can drop it for you.

> +#                    (default: number of CPUs) (since 5.0)
>  #
>  # @prealloc-context: thread context to use for creation of preallocation threads
>  #                    (default: none) (since 7.2)

Reviewed-by: Markus Armbruster <armbru@redhat.com>

Re: [PATCH v4] qapi/qom: Memory backend property prealloc-threads doc fix

Posted by Gavin Shan 1 year, 5 months ago

On 11/14/22 11:24 AM, Zhenyu Zhang wrote:
> Commit ffac16fab3 "hostmem: introduce "prealloc-threads" property"
> (v5.0.0) changed the default number of threads from number of CPUs
> to 1.  This was deemed a regression, and fixed in commit f8d426a685
> "hostmem: default the amount of prealloc-threads to smp-cpus".
> Except the documentation remained unchanged.
> 
> Update 'qapi/qom.json' to reflect the change in commit f8d426a6852c.
> 
> Signed-off-by: Zhenyu Zhang <zhenyzha@redhat.com>
> ---
> 
> v4: Fix the line exceeding 80 characters limitation issue  (Gavin)
> v3: Covers historical descriptions                         (Markus)
> v2: The property is changed to smp-cpus since 5.0          (Phild)
> 
> ---
>   qapi/qom.json | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)
> 

Reviewed-by: Gavin Shan <gshan@redhat.com>

> diff --git a/qapi/qom.json b/qapi/qom.json
> index 30e76653ad..f4a7917f3d 100644
> --- a/qapi/qom.json
> +++ b/qapi/qom.json
> @@ -576,7 +576,8 @@
>   #
>   # @prealloc: if true, preallocate memory (default: false)
>   #
> -# @prealloc-threads: number of CPU threads to use for prealloc (default: 1)
> +# @prealloc-threads: number of CPU threads to use for prealloc
> +#                    (default: number of CPUs) (since 5.0)
>   #
>   # @prealloc-context: thread context to use for creation of preallocation threads
>   #                    (default: none) (since 7.2)
>

Re: [PATCH v4] qapi/qom: Memory backend property prealloc-threads doc fix

Posted by Philippe Mathieu-Daudé 1 year, 5 months ago

On 14/11/22 04:24, Zhenyu Zhang wrote:
> Commit ffac16fab3 "hostmem: introduce "prealloc-threads" property"
> (v5.0.0) changed the default number of threads from number of CPUs
> to 1.  This was deemed a regression, and fixed in commit f8d426a685
> "hostmem: default the amount of prealloc-threads to smp-cpus".
> Except the documentation remained unchanged.
> 
> Update 'qapi/qom.json' to reflect the change in commit f8d426a6852c.
> 
> Signed-off-by: Zhenyu Zhang <zhenyzha@redhat.com>
> ---
> 
> v4: Fix the line exceeding 80 characters limitation issue  (Gavin)
> v3: Covers historical descriptions                         (Markus)
> v2: The property is changed to smp-cpus since 5.0          (Phild)
> 
> ---
>   qapi/qom.json | 3 ++-
>   1 file changed, 2 insertions(+), 1 deletion(-)

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