[PATCH 0/3] docs/cmdline: Misc improvements to documentation

[PATCH 0/3] docs/cmdline: Misc improvements to documentation

[Andrew Cooper]

Andrew Cooper (3):
  docs/cmdline: Fix markdown syntax
  docs/cmdline: Move XSM to be in alphabetical order
  docs/cmdline: Rewrite the cpuid_mask_* section

 docs/misc/xen-command-line.markdown | 100 ++++++++++++++++++------------------
 1 file changed, 51 insertions(+), 49 deletions(-)

-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

[PATCH 1/3] docs/cmdline: Fix markdown syntax

[Andrew Cooper]

 * vwfi needs a closing `.  rmrr needs one as well, and the opening ' switched
   to `
 * The com1/com2 example lines are already verbatim blocks and shouldn't
   escape their underscores.  This ends up in the rendered output.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@eu.citrix.com>
CC: Ian Jackson <ian.jackson@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Tim Deegan <tim@xen.org>
CC: Wei Liu <wei.liu2@citrix.com>
CC: Julien Grall <julien.grall@arm.com>
---
 docs/misc/xen-command-line.markdown | 8 ++++----
 1 file changed, 4 insertions(+), 4 deletions(-)

diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 6f671d3..8097b7a 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -348,8 +348,8 @@ The accepted name keywords for name=value pairs are:
 The following are examples of correct specifications:
 
     com1=115200,8n1,0x3f8,4
-    com1=115200,8n1,0x3f8,4,reg\_width=4,reg\_shift=2
-    com1=baud=115200,parity=n,stop\_bits=1,io\_base=0x3f8,reg\_width=4
+    com1=115200,8n1,0x3f8,4,reg_width=4,reg_shift=2
+    com1=baud=115200,parity=n,stop_bits=1,io_base=0x3f8,reg_width=4
 
 ### conring\_size
 > `= <size>`
@@ -1665,7 +1665,7 @@ Specify the host reboot method.
 when running nested Xen)
 
 ### rmrr
-> '= start<-end>=[s1]bdf1[,[s1]bdf2[,...]];start<-end>=[s2]bdf1[,[s2]bdf2[,...]]
+> `= start<-end>=[s1]bdf1[,[s1]bdf2[,...]];start<-end>=[s2]bdf1[,[s2]bdf2[,...]]`
 
 Define RMRR units that are missing from ACPI table along with device they
 belong to and use them for 1:1 mapping. End addresses can be omitted and one
@@ -2096,7 +2096,7 @@ As the virtualisation is not 100% safe, don't use the vpmu flag on
 production systems (see http://xenbits.xen.org/xsa/advisory-163.html)!
 
 ### vwfi (arm)
-> `= trap | native
+> `= trap | native`
 
 > Default: `trap`
 
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

[PATCH 2/3] docs/cmdline: Move XSM to be in alphabetical order

[Andrew Cooper]

Adjust the default line to note that the default is now selectable in Kconfig.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@eu.citrix.com>
CC: Ian Jackson <ian.jackson@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Tim Deegan <tim@xen.org>
CC: Wei Liu <wei.liu2@citrix.com>
CC: Julien Grall <julien.grall@arm.com>
---
 docs/misc/xen-command-line.markdown | 32 ++++++++++++++++----------------
 1 file changed, 16 insertions(+), 16 deletions(-)

diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 8097b7a..175d462 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -870,22 +870,6 @@ hardware domain is architecture dependent.
 Note that specifying zero as domU value means zero, while for dom0 it means
 to use the default.
 
-### xsm
-> `= dummy | flask | silo`
-
-> Default: `dummy`
-
-Specify which XSM module should be enabled.  This option is only available if
-the hypervisor was compiled with XSM support.
-
-* `dummy`: this is the default choice.  Basic restriction for common deployment
-  (the dummy module) will be applied.  It's also used when XSM is compiled out.
-* `flask`: this is the policy based access control.  To choose this, the
-  separated option in kconfig must also be enabled.
-* `silo`: this will deny any unmediated communication channels between
-  unprivileged VMs.  To choose this, the separated option in kconfig must also
-  be enabled.
-
 ### flask
 > `= permissive | enforcing | late | disabled`
 
@@ -2180,3 +2164,19 @@ for dom0 or guest domains only.
 > Default: `true`
 
 Permit use of the `xsave/xrstor` instructions.
+
+### xsm
+> `= dummy | flask | silo`
+
+> Default: `dummy`, selectable via Kconfig.
+
+Specify which XSM module should be enabled.  This option is only available if
+the hypervisor was compiled with CONFIG\_XSM enabled.
+
+* `dummy`: this is the default choice.  Basic restriction for common deployment
+  (the dummy module) will be applied.  It's also used when XSM is compiled out.
+* `flask`: this is the policy based access control.  To choose this, the
+  separated option in kconfig must also be enabled.
+* `silo`: this will deny any unmediated communication channels between
+  unprivileged VMs.  To choose this, the separated option in kconfig must also
+  be enabled.
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

[PATCH 3/3] docs/cmdline: Rewrite the cpuid_mask_* section

[Andrew Cooper]

A large amount of the information here is obsolete since Xen 4.7

To being with, however, this patch marks a change in style for section
headings, due to how HTML anchors are generated.  Having more than one
parameter per heading makes an awkward anchor, especially when brace globbing
is used.  Furthermore, the misc suffixes such as (AMD only) get included, as
do the escaping for the underscores.

Markdown doesn't require escaped underscores in headings (I'm not entirely
sure how we ended up with that style), so remove them and fully expand the
glob syntax.  Also adjust com1,com2 while at it, which is the only other
multi-parameter heading.  Move the misc suffixes into an "Applicability:" note
alongside the information about defaults.

This results in the headings being unadorned, and identical to how they are
expressed on the command line and in code.

For cpuid_mask_cpu option, collapse the long line of almost identical strings
using [] globbing.  The result is much shorter and clearer to read.  Add a
warning that this option no longer masks all features on Fam15h and above, due
to not making use of the leaf 7 masks.

For the remainder of the cpuid_mask_* options, collapse them all together into
a single description.

Finally, leave an explicit note explaining that people should not be using
these options for migration safety.

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
---
CC: George Dunlap <George.Dunlap@eu.citrix.com>
CC: Ian Jackson <ian.jackson@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
CC: Stefano Stabellini <sstabellini@kernel.org>
CC: Tim Deegan <tim@xen.org>
CC: Wei Liu <wei.liu2@citrix.com>
CC: Julien Grall <julien.grall@arm.com>
---
 docs/misc/xen-command-line.markdown | 60 +++++++++++++++++++------------------
 1 file changed, 31 insertions(+), 29 deletions(-)

diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
index 175d462..29fec20 100644
--- a/docs/misc/xen-command-line.markdown
+++ b/docs/misc/xen-command-line.markdown
@@ -277,7 +277,8 @@ Interrupts.  Specifying zero disables CMCI handling.
 Flag to indicate whether to probe for a CMOS Real Time Clock irrespective of
 ACPI indicating none to be there.
 
-### com1,com2
+### com1
+### com2
 > `= <baud>[/<base-baud>][,[DPS][,[<io-base>|pci|amt][,[<irq>|msi][,[<port-bdf>][,[<bridge-bdf>]]]]]]`
 
 Both option `com1` and `com2` follow the same format.
@@ -467,44 +468,45 @@ The Speculation Control hardware features `ibrsb`, `stibp`, `ibpb`,
 be ignored, e.g. `no-ibrsb`, at which point Xen won't use them itself, and
 won't offer them to guests.
 
-### cpuid\_mask\_cpu (AMD only)
-> `= fam_0f_rev_c | fam_0f_rev_d | fam_0f_rev_e | fam_0f_rev_f | fam_0f_rev_g | fam_10_rev_b | fam_10_rev_c | fam_11_rev_b`
+### cpuid_mask_cpu
+> `= fam_0f_rev_[cdefg] | fam_10_rev_[bc] | fam_11_rev_b`
 
-If the other **cpuid\_mask\_{,ext\_,thermal\_,l7s0\_}e{a,b,c,d}x**
-options are fully set (unspecified on the command line), specify a
-pre-canned cpuid mask to mask the current processor down to appear as
-the specified processor. It is important to ensure that all hosts in a
-pool appear the same to guests to allow successful live migration.
+> Applicability: AMD
 
-### cpuid\_mask\_{{,ext\_}ecx,edx} (x86)
-> `= <integer>`
+If none of the other **cpuid\_mask\_\*** options are given, Xen has a set of
+pre-configured masks to make the current processor appear to be
+family/revision specified.
 
-> Default: `~0` (all bits set)
+See below for general information on masking.
 
-These four command line parameters are used to specify cpuid masks to
-help with cpuid levelling across a pool of hosts.  Setting a bit in
-the mask indicates that the feature should be enabled, while clearing
-a bit in the mask indicates that the feature should be disabled.  It
-is important to ensure that all hosts in a pool appear the same to
-guests to allow successful live migration.
+**Warning: This option is not fully effective on Family 15h processors or
+later.**
 
-### cpuid\_mask\_xsave\_eax (Intel only)
+### cpuid_mask_ecx
+### cpuid_mask_edx
+### cpuid_mask_ext_ecx
+### cpuid_mask_ext_edx
+### cpuid_mask_l7s0_eax
+### cpuid_mask_l7s0_ebx
+### cpuid_mask_thermal_ecx
+### cpuid_mask_xsave_eax
 > `= <integer>`
 
-> Default: `~0` (all bits set)
-
-This command line parameter is also used to specify a cpuid mask to
-help with cpuid levelling across a pool of hosts.  See the description
-of the other respective options above.
+> Applicability: x86.  Default: `~0` (all bits set)
 
-### cpuid\_mask\_{l7s0\_{eax,ebx},thermal\_ecx} (AMD only)
-> `= <integer>`
+The availability of these options are model specific.  Some processors don't
+support any of them, and no processor supports all of them.  Xen will ignore
+options on processors which are lacking support.
 
-> Default: `~0` (all bits set)
+These options can be used to alter the features visible via the `CPUID`
+instruction.  Settings applied here take effect globally, including for Xen
+and all guests.
 
-These three command line parameters are also used to specify cpuid
-masks to help with cpuid levelling across a pool of hosts.  See the
-description of the other respective options above.
+Note: Since Xen 4.7, it is no longer necessary to mask a host to create
+migration safety in heterogeneous scenarios.  All necessary CPUID settings
+should be provided in the VM configuration file.  Furthermore, it is
+recommended not to use this option, as doing so causes an unnecessary
+reduction of features at Xen's disposal to manage guests.
 
 ### cpuidle (x86)
 > `= <boolean>`
-- 
2.1.4


_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 3/3] docs/cmdline: Rewrite the cpuid_mask_* section

[Julien Grall]

Hi Andrew,

On 07/12/2018 13:45, Andrew Cooper wrote:
> A large amount of the information here is obsolete since Xen 4.7
> 
> To being with, however, this patch marks a change in style for section
> headings, due to how HTML anchors are generated.  Having more than one
> parameter per heading makes an awkward anchor, especially when brace globbing
> is used.  Furthermore, the misc suffixes such as (AMD only) get included, as
> do the escaping for the underscores.
> 
> Markdown doesn't require escaped underscores in headings (I'm not entirely
> sure how we ended up with that style), so remove them and fully expand the
> glob syntax.  Also adjust com1,com2 while at it, which is the only other
> multi-parameter heading.  Move the misc suffixes into an "Applicability:" note
> alongside the information about defaults.
> 
> This results in the headings being unadorned, and identical to how they are
> expressed on the command line and in code.
> 
> For cpuid_mask_cpu option, collapse the long line of almost identical strings
> using [] globbing.  The result is much shorter and clearer to read.  Add a
> warning that this option no longer masks all features on Fam15h and above, due
> to not making use of the leaf 7 masks.
> 
> For the remainder of the cpuid_mask_* options, collapse them all together into
> a single description.
> 
> Finally, leave an explicit note explaining that people should not be using
> these options for migration safety.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
> ---
> CC: George Dunlap <George.Dunlap@eu.citrix.com>
> CC: Ian Jackson <ian.jackson@citrix.com>
> CC: Jan Beulich <JBeulich@suse.com>
> CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
> CC: Stefano Stabellini <sstabellini@kernel.org>
> CC: Tim Deegan <tim@xen.org>
> CC: Wei Liu <wei.liu2@citrix.com>
> CC: Julien Grall <julien.grall@arm.com>
> ---
>   docs/misc/xen-command-line.markdown | 60 +++++++++++++++++++------------------
>   1 file changed, 31 insertions(+), 29 deletions(-)
> 
> diff --git a/docs/misc/xen-command-line.markdown b/docs/misc/xen-command-line.markdown
> index 175d462..29fec20 100644
> --- a/docs/misc/xen-command-line.markdown
> +++ b/docs/misc/xen-command-line.markdown
> @@ -277,7 +277,8 @@ Interrupts.  Specifying zero disables CMCI handling.
>   Flag to indicate whether to probe for a CMOS Real Time Clock irrespective of
>   ACPI indicating none to be there.
>   
> -### com1,com2
> +### com1
> +### com2

Should not this belong to patch #1?

Cheers,

-- 
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 3/3] docs/cmdline: Rewrite the cpuid_mask_* section

[Andrew Cooper]

On 07/12/2018 15:09, Julien Grall wrote:
> Hi Andrew,
>
> On 07/12/2018 13:45, Andrew Cooper wrote:
>> A large amount of the information here is obsolete since Xen 4.7
>>
>> To being with, however, this patch marks a change in style for section
>> headings, due to how HTML anchors are generated.  Having more than one
>> parameter per heading makes an awkward anchor, especially when brace
>> globbing
>> is used.  Furthermore, the misc suffixes such as (AMD only) get
>> included, as
>> do the escaping for the underscores.
>>
>> Markdown doesn't require escaped underscores in headings (I'm not
>> entirely
>> sure how we ended up with that style), so remove them and fully
>> expand the
>> glob syntax.  Also adjust com1,com2 while at it, which is the only other
>> multi-parameter heading.  Move the misc suffixes into an
>> "Applicability:" note
>> alongside the information about defaults.
>>
>> This results in the headings being unadorned, and identical to how
>> they are
>> expressed on the command line and in code.
>>
>> For cpuid_mask_cpu option, collapse the long line of almost identical
>> strings
>> using [] globbing.  The result is much shorter and clearer to read. 
>> Add a
>> warning that this option no longer masks all features on Fam15h and
>> above, due
>> to not making use of the leaf 7 masks.
>>
>> For the remainder of the cpuid_mask_* options, collapse them all
>> together into
>> a single description.
>>
>> Finally, leave an explicit note explaining that people should not be
>> using
>> these options for migration safety.
>>
>> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
>> ---
>> CC: George Dunlap <George.Dunlap@eu.citrix.com>
>> CC: Ian Jackson <ian.jackson@citrix.com>
>> CC: Jan Beulich <JBeulich@suse.com>
>> CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
>> CC: Stefano Stabellini <sstabellini@kernel.org>
>> CC: Tim Deegan <tim@xen.org>
>> CC: Wei Liu <wei.liu2@citrix.com>
>> CC: Julien Grall <julien.grall@arm.com>
>> ---
>>   docs/misc/xen-command-line.markdown | 60
>> +++++++++++++++++++------------------
>>   1 file changed, 31 insertions(+), 29 deletions(-)
>>
>> diff --git a/docs/misc/xen-command-line.markdown
>> b/docs/misc/xen-command-line.markdown
>> index 175d462..29fec20 100644
>> --- a/docs/misc/xen-command-line.markdown
>> +++ b/docs/misc/xen-command-line.markdown
>> @@ -277,7 +277,8 @@ Interrupts.  Specifying zero disables CMCI handling.
>>   Flag to indicate whether to probe for a CMOS Real Time Clock
>> irrespective of
>>   ACPI indicating none to be there.
>>   -### com1,com2
>> +### com1
>> +### com2
>
> Should not this belong to patch #1?

No.  This change isn't for markdown syntax issues.

It is for a change in how we express headings, and more logically fits
in this patch, as explained (hopefully well enough) in the commit message.

~Andrew

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 2/3] docs/cmdline: Move XSM to be in alphabetical order

[Jan Beulich]

>>> On 07.12.18 at 14:45, <andrew.cooper3@citrix.com> wrote:
> Adjust the default line to note that the default is now selectable in 
> Kconfig.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

Acked-by: Jan Beulich <jbeulich@suse.com>
with one remark:

> @@ -2180,3 +2164,19 @@ for dom0 or guest domains only.
>  > Default: `true`
>  
>  Permit use of the `xsave/xrstor` instructions.
> +
> +### xsm
> +> `= dummy | flask | silo`
> +
> +> Default: `dummy`, selectable via Kconfig.

How about something like: "Default: selectable via Kconfig, the default
there is `dummy`"? Point being that to the user (non-developer) it
mainly matters what their package defaults to, and what mainly matters
is perhaps better to come first.

Jan



_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 3/3] docs/cmdline: Rewrite the cpuid_mask_* section

[Jan Beulich]

>>> On 07.12.18 at 14:45, <andrew.cooper3@citrix.com> wrote:
> A large amount of the information here is obsolete since Xen 4.7
> 
> To being with, however, this patch marks a change in style for section
> headings, due to how HTML anchors are generated.  Having more than one
> parameter per heading makes an awkward anchor, especially when brace globbing
> is used.  Furthermore, the misc suffixes such as (AMD only) get included, as
> do the escaping for the underscores.
> 
> Markdown doesn't require escaped underscores in headings (I'm not entirely
> sure how we ended up with that style), so remove them and fully expand the
> glob syntax.  Also adjust com1,com2 while at it, which is the only other
> multi-parameter heading.  Move the misc suffixes into an "Applicability:" note
> alongside the information about defaults.
> 
> This results in the headings being unadorned, and identical to how they are
> expressed on the command line and in code.
> 
> For cpuid_mask_cpu option, collapse the long line of almost identical strings
> using [] globbing.  The result is much shorter and clearer to read.  Add a
> warning that this option no longer masks all features on Fam15h and above, due
> to not making use of the leaf 7 masks.
> 
> For the remainder of the cpuid_mask_* options, collapse them all together into
> a single description.
> 
> Finally, leave an explicit note explaining that people should not be using
> these options for migration safety.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

Contents (but not formatting, due to my lack of markdown speak)
Acked-by: Jan Beulich <jbeulich@suse.com>

Jan



_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 1/3] docs/cmdline: Fix markdown syntax

[Wei Liu]

On Fri, Dec 07, 2018 at 01:45:44PM +0000, Andrew Cooper wrote:
>  * vwfi needs a closing `.  rmrr needs one as well, and the opening ' switched
>    to `
>  * The com1/com2 example lines are already verbatim blocks and shouldn't
>    escape their underscores.  This ends up in the rendered output.
> 
> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

Acked-by: Wei Liu <wei.liu2@citrix.com>

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 2/3] docs/cmdline: Move XSM to be in alphabetical order

[Andrew Cooper]

On 10/12/2018 14:22, Jan Beulich wrote:
>>>> On 07.12.18 at 14:45, <andrew.cooper3@citrix.com> wrote:
>> Adjust the default line to note that the default is now selectable in 
>> Kconfig.
>>
>> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
> Acked-by: Jan Beulich <jbeulich@suse.com>

Thanks.

> with one remark:
>
>> @@ -2180,3 +2164,19 @@ for dom0 or guest domains only.
>>  > Default: `true`
>>  
>>  Permit use of the `xsave/xrstor` instructions.
>> +
>> +### xsm
>> +> `= dummy | flask | silo`
>> +
>> +> Default: `dummy`, selectable via Kconfig.
> How about something like: "Default: selectable via Kconfig, the default
> there is `dummy`"? Point being that to the user (non-developer) it
> mainly matters what their package defaults to, and what mainly matters
> is perhaps better to come first.

I'll leave it as just "selectable via Kconfig, depends on selected XSM
modules", because the actual default (given no user choice) will turn to
FLASK if enabled, then SILO, and finally fall back to dummy.

~Andrew

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel

Re: [PATCH 3/3] docs/cmdline: Rewrite the cpuid_mask_* section

[Julien Grall]

Hi Andrew,

On 07/12/2018 15:24, Andrew Cooper wrote:
> On 07/12/2018 15:09, Julien Grall wrote:
>> Hi Andrew,
>>
>> On 07/12/2018 13:45, Andrew Cooper wrote:
>>> A large amount of the information here is obsolete since Xen 4.7
>>>
>>> To being with, however, this patch marks a change in style for section
>>> headings, due to how HTML anchors are generated.  Having more than one
>>> parameter per heading makes an awkward anchor, especially when brace
>>> globbing
>>> is used.  Furthermore, the misc suffixes such as (AMD only) get
>>> included, as
>>> do the escaping for the underscores.
>>>
>>> Markdown doesn't require escaped underscores in headings (I'm not
>>> entirely
>>> sure how we ended up with that style), so remove them and fully
>>> expand the
>>> glob syntax.  Also adjust com1,com2 while at it, which is the only other
>>> multi-parameter heading.  Move the misc suffixes into an
>>> "Applicability:" note
>>> alongside the information about defaults.
>>>
>>> This results in the headings being unadorned, and identical to how
>>> they are
>>> expressed on the command line and in code.
>>>
>>> For cpuid_mask_cpu option, collapse the long line of almost identical
>>> strings
>>> using [] globbing.  The result is much shorter and clearer to read.
>>> Add a
>>> warning that this option no longer masks all features on Fam15h and
>>> above, due
>>> to not making use of the leaf 7 masks.
>>>
>>> For the remainder of the cpuid_mask_* options, collapse them all
>>> together into
>>> a single description.
>>>
>>> Finally, leave an explicit note explaining that people should not be
>>> using
>>> these options for migration safety.
>>>
>>> Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
>>> ---
>>> CC: George Dunlap <George.Dunlap@eu.citrix.com>
>>> CC: Ian Jackson <ian.jackson@citrix.com>
>>> CC: Jan Beulich <JBeulich@suse.com>
>>> CC: Konrad Rzeszutek Wilk <konrad.wilk@oracle.com>
>>> CC: Stefano Stabellini <sstabellini@kernel.org>
>>> CC: Tim Deegan <tim@xen.org>
>>> CC: Wei Liu <wei.liu2@citrix.com>
>>> CC: Julien Grall <julien.grall@arm.com>
>>> ---
>>>    docs/misc/xen-command-line.markdown | 60
>>> +++++++++++++++++++------------------
>>>    1 file changed, 31 insertions(+), 29 deletions(-)
>>>
>>> diff --git a/docs/misc/xen-command-line.markdown
>>> b/docs/misc/xen-command-line.markdown
>>> index 175d462..29fec20 100644
>>> --- a/docs/misc/xen-command-line.markdown
>>> +++ b/docs/misc/xen-command-line.markdown
>>> @@ -277,7 +277,8 @@ Interrupts.  Specifying zero disables CMCI handling.
>>>    Flag to indicate whether to probe for a CMOS Real Time Clock
>>> irrespective of
>>>    ACPI indicating none to be there.
>>>    -### com1,com2
>>> +### com1
>>> +### com2
>>
>> Should not this belong to patch #1?
> 
> No.  This change isn't for markdown syntax issues.
> 
> It is for a change in how we express headings, and more logically fits
> in this patch, as explained (hopefully well enough) in the commit message.

I misread the commit message. It is explained well enough.

Cheers,

-- 
Julien Grall

_______________________________________________
Xen-devel mailing list
Xen-devel@lists.xenproject.org
https://lists.xenproject.org/mailman/listinfo/xen-devel