diff mbox series

[v6,01/16] docs/about/removed-features: Remove duplicated doc about -smp

Message ID 20210819031027.41104-2-wangyanan55@huawei.com
State New
Headers show
Series machine: smp parsing fixes and improvement | expand

Commit Message

wangyanan (Y) Aug. 19, 2021, 3:10 a.m. UTC
There are two places describing the same thing about deprecation
of invalid topologies of -smp CLI, so remove the duplicated one.

Signed-off-by: Yanan Wang <wangyanan55@huawei.com>
---
 docs/about/removed-features.rst | 21 ++++-----------------
 1 file changed, 4 insertions(+), 17 deletions(-)

Comments

Cornelia Huck Aug. 19, 2021, 11:26 a.m. UTC | #1
On Thu, Aug 19 2021, Yanan Wang <wangyanan55@huawei.com> wrote:

> There are two places describing the same thing about deprecation
> of invalid topologies of -smp CLI, so remove the duplicated one.
>
> Signed-off-by: Yanan Wang <wangyanan55@huawei.com>
> ---
>  docs/about/removed-features.rst | 21 ++++-----------------
>  1 file changed, 4 insertions(+), 17 deletions(-)
>
> diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.rst
> index cbfa1a8e31..f5d6e2ea9c 100644
> --- a/docs/about/removed-features.rst
> +++ b/docs/about/removed-features.rst
> @@ -194,7 +194,7 @@ by the ``tls-authz`` and ``sasl-authz`` options.
>  The ``pretty=on|off`` switch has no effect for HMP monitors and
>  its use is rejected.
>  
> -``-drive file=json:{...{'driver':'file'}}`` (removed 6.0)
> +``-drive file=json:{...{'driver':'file'}}`` (removed in 6.0)

I would not change this in this patch; while the cleanup looks fine,
there are some more instances and also e.g. things like x.y.z being used
sometimes, and it's probably better to clean that up via a separated patch.

>  '''''''''''''''''''''''''''''''''''''''''''''''''''''''''
>  
>  The 'file' driver for drives is no longer appropriate for character or host
> @@ -593,7 +593,7 @@ error when ``-u`` is not used.
>  Command line options
>  --------------------
>  
> -``-smp`` (invalid topologies) (removed 5.2)
> +``-smp`` (invalid topologies) (removed in 5.2)
>  '''''''''''''''''''''''''''''''''''''''''''
>  
>  CPU topology properties should describe whole machine topology including
> @@ -606,7 +606,7 @@ Support for invalid topologies is removed, the user must ensure
>  topologies described with -smp include all possible cpus, i.e.
>  *sockets* * *cores* * *threads* = *maxcpus*.
>  
> -``-numa`` node (without memory specified) (removed 5.2)
> +``-numa`` node (without memory specified) (removed in 5.2)
>  '''''''''''''''''''''''''''''''''''''''''''''''''''''''
>  
>  Splitting RAM by default between NUMA nodes had the same issues as ``mem``
> @@ -647,20 +647,7 @@ as ignored. Currently, users are responsible for making sure the backing storage
>  specified with ``-mem-path`` can actually provide the guest RAM configured with
>  ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
>  
> -``-smp`` (invalid topologies) (removed 5.2)
> -'''''''''''''''''''''''''''''''''''''''''''
> -
> -CPU topology properties should describe whole machine topology including
> -possible CPUs.
> -
> -However, historically it was possible to start QEMU with an incorrect topology
> -where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
> -which could lead to an incorrect topology enumeration by the guest.
> -Support for invalid topologies is removed, the user must ensure
> -topologies described with -smp include all possible cpus, i.e.
> -*sockets* * *cores* * *threads* = *maxcpus*.

Actually removing the duplicated section looks fine.

> -
> -``-machine enforce-config-section=on|off`` (removed 5.2)
> +``-machine enforce-config-section=on|off`` (removed in 5.2)
>  ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
>  
>  The ``enforce-config-section`` property was replaced by the
wangyanan (Y) Aug. 19, 2021, 12:20 p.m. UTC | #2
On 2021/8/19 19:26, Cornelia Huck wrote:
> On Thu, Aug 19 2021, Yanan Wang <wangyanan55@huawei.com> wrote:
>
>> There are two places describing the same thing about deprecation
>> of invalid topologies of -smp CLI, so remove the duplicated one.
>>
>> Signed-off-by: Yanan Wang <wangyanan55@huawei.com>
>> ---
>>   docs/about/removed-features.rst | 21 ++++-----------------
>>   1 file changed, 4 insertions(+), 17 deletions(-)
>>
>> diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.rst
>> index cbfa1a8e31..f5d6e2ea9c 100644
>> --- a/docs/about/removed-features.rst
>> +++ b/docs/about/removed-features.rst
>> @@ -194,7 +194,7 @@ by the ``tls-authz`` and ``sasl-authz`` options.
>>   The ``pretty=on|off`` switch has no effect for HMP monitors and
>>   its use is rejected.
>>   
>> -``-drive file=json:{...{'driver':'file'}}`` (removed 6.0)
>> +``-drive file=json:{...{'driver':'file'}}`` (removed in 6.0)
> I would not change this in this patch; while the cleanup looks fine,
> there are some more instances and also e.g. things like x.y.z being used
> sometimes, and it's probably better to clean that up via a separated patch.
Yes, I did notice that format (x.y,z) but didn't modify them...
I will make a separate patch only for subject format clean-up and
keep the duplicated text removal in another one.
>>   '''''''''''''''''''''''''''''''''''''''''''''''''''''''''
>>   
>>   The 'file' driver for drives is no longer appropriate for character or host
>> @@ -593,7 +593,7 @@ error when ``-u`` is not used.
>>   Command line options
>>   --------------------
>>   
>> -``-smp`` (invalid topologies) (removed 5.2)
>> +``-smp`` (invalid topologies) (removed in 5.2)
>>   '''''''''''''''''''''''''''''''''''''''''''
>>   
>>   CPU topology properties should describe whole machine topology including
>> @@ -606,7 +606,7 @@ Support for invalid topologies is removed, the user must ensure
>>   topologies described with -smp include all possible cpus, i.e.
>>   *sockets* * *cores* * *threads* = *maxcpus*.
>>   
>> -``-numa`` node (without memory specified) (removed 5.2)
>> +``-numa`` node (without memory specified) (removed in 5.2)
>>   '''''''''''''''''''''''''''''''''''''''''''''''''''''''
>>   
>>   Splitting RAM by default between NUMA nodes had the same issues as ``mem``
>> @@ -647,20 +647,7 @@ as ignored. Currently, users are responsible for making sure the backing storage
>>   specified with ``-mem-path`` can actually provide the guest RAM configured with
>>   ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
>>   
>> -``-smp`` (invalid topologies) (removed 5.2)
>> -'''''''''''''''''''''''''''''''''''''''''''
>> -
>> -CPU topology properties should describe whole machine topology including
>> -possible CPUs.
>> -
>> -However, historically it was possible to start QEMU with an incorrect topology
>> -where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
>> -which could lead to an incorrect topology enumeration by the guest.
>> -Support for invalid topologies is removed, the user must ensure
>> -topologies described with -smp include all possible cpus, i.e.
>> -*sockets* * *cores* * *threads* = *maxcpus*.
> Actually removing the duplicated section looks fine.
Thanks,
Yanan
.
>> -
>> -``-machine enforce-config-section=on|off`` (removed 5.2)
>> +``-machine enforce-config-section=on|off`` (removed in 5.2)
>>   ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
>>   
>>   The ``enforce-config-section`` property was replaced by the
> .
diff mbox series

Patch

diff --git a/docs/about/removed-features.rst b/docs/about/removed-features.rst
index cbfa1a8e31..f5d6e2ea9c 100644
--- a/docs/about/removed-features.rst
+++ b/docs/about/removed-features.rst
@@ -194,7 +194,7 @@  by the ``tls-authz`` and ``sasl-authz`` options.
 The ``pretty=on|off`` switch has no effect for HMP monitors and
 its use is rejected.
 
-``-drive file=json:{...{'driver':'file'}}`` (removed 6.0)
+``-drive file=json:{...{'driver':'file'}}`` (removed in 6.0)
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 The 'file' driver for drives is no longer appropriate for character or host
@@ -593,7 +593,7 @@  error when ``-u`` is not used.
 Command line options
 --------------------
 
-``-smp`` (invalid topologies) (removed 5.2)
+``-smp`` (invalid topologies) (removed in 5.2)
 '''''''''''''''''''''''''''''''''''''''''''
 
 CPU topology properties should describe whole machine topology including
@@ -606,7 +606,7 @@  Support for invalid topologies is removed, the user must ensure
 topologies described with -smp include all possible cpus, i.e.
 *sockets* * *cores* * *threads* = *maxcpus*.
 
-``-numa`` node (without memory specified) (removed 5.2)
+``-numa`` node (without memory specified) (removed in 5.2)
 '''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 Splitting RAM by default between NUMA nodes had the same issues as ``mem``
@@ -647,20 +647,7 @@  as ignored. Currently, users are responsible for making sure the backing storage
 specified with ``-mem-path`` can actually provide the guest RAM configured with
 ``-m`` and QEMU fails to start up if RAM allocation is unsuccessful.
 
-``-smp`` (invalid topologies) (removed 5.2)
-'''''''''''''''''''''''''''''''''''''''''''
-
-CPU topology properties should describe whole machine topology including
-possible CPUs.
-
-However, historically it was possible to start QEMU with an incorrect topology
-where *n* <= *sockets* * *cores* * *threads* < *maxcpus*,
-which could lead to an incorrect topology enumeration by the guest.
-Support for invalid topologies is removed, the user must ensure
-topologies described with -smp include all possible cpus, i.e.
-*sockets* * *cores* * *threads* = *maxcpus*.
-
-``-machine enforce-config-section=on|off`` (removed 5.2)
+``-machine enforce-config-section=on|off`` (removed in 5.2)
 ''''''''''''''''''''''''''''''''''''''''''''''''''''''''
 
 The ``enforce-config-section`` property was replaced by the