diff mbox

docs/arm64: clarify the documention for loading XSM support

Message ID 1461598536-28774-1-git-send-email-ian.jackson@eu.citrix.com (mailing list archive)
State New, archived
Headers show

Commit Message

Ian Jackson April 25, 2016, 3:35 p.m. UTC
From: Fu Wei <fu.wei@linaro.org>

Improve the clarity of the wording introduced in 67831c4c
"docs/arm64: update the documentation for loading XSM support"

Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
CC: Fu Wei <fu.wei@linaro.org>
CC: Julien Grall <julien.grall@arm.com>,
CC: Stefano Stabellini <sstabellini@kernel.org>
---
 docs/misc/arm/device-tree/booting.txt |   31 ++++++++++++++++++-------------
 1 file changed, 18 insertions(+), 13 deletions(-)

Comments

Julien Grall April 25, 2016, 4:16 p.m. UTC | #1
Hi Ian,

On 25/04/16 16:35, Ian Jackson wrote:
> From: Fu Wei <fu.wei@linaro.org>
>
> Improve the clarity of the wording introduced in 67831c4c
> "docs/arm64: update the documentation for loading XSM support"
>
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> CC: Fu Wei <fu.wei@linaro.org>
> CC: Julien Grall <julien.grall@arm.com>,

Somehow, I am not in the mail CC. Maybe because of the "," at the end?

Otherwise, the text looks good to me. I have some questions about the 
formatting, see below.

> CC: Stefano Stabellini <sstabellini@kernel.org>
> ---
>   docs/misc/arm/device-tree/booting.txt |   31 ++++++++++++++++++-------------
>   1 file changed, 18 insertions(+), 13 deletions(-)
>
> diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
> index cae46eda..f3179d6 100644
> --- a/docs/misc/arm/device-tree/booting.txt
> +++ b/docs/misc/arm/device-tree/booting.txt
> @@ -26,19 +26,24 @@ Each node contains the following properties:
>   	Xen will assume that the first module which lacks a more
>   	specific compatible string is a "multiboot,kernel".
>
> -	Xen will check all the modules for the XSM Magic from the second
> -	module that lacks a specific compatible string. According to the
> -	result of the detection:
> -	- if it's an XSM, Xen will assume its compatible string is
> -	  "xen,xsm-policy";
> -	- if it's not an XSM, for the second module that lacks a specific
> -	  compatible string, Xen will assume its compatible string is
> -	  "multiboot,ramdisk"; the third and subsequent modules that
> -	  lack a specific compatible string will not receive any special
> -	  treatment.
> -	This means that if the ramdisk module is present and does not have
> -	the compatible string "multiboot,ramdisk", then it must always be
> -	the second module.
> +	Xen will examine each module, starting from the second
> +	module that lacks a specific compatible string.  Xen will

NIT: there is 2 spaces rather than 1 before "Xen".

> +        check each such module for the XSM Magic number:

I am not sure sure why the extra spaces before "check"?

> +
> +	- For a module which has the XSM Magic number: it will be
> +          treated by Xen as if its compatible string was
> +          "xen,xsm-policy";

Ditto

> +
> +	- For a module which does not have the XSM Magic: the second
> +          module lacking a compatible string will be treated by Xen as
> +          if its compatible string was "multiboot,ramdisk"; for the
> +          third and subsequent modules which lack a specific
> +          compatible string, Xen will not apply any special treatment.

Ditto

> +
> +	This means if the ramdisk module is present and does not have the
> +	compatible string "multiboot,ramdisk", then it must always be the
> +	second module.
> +
>   	Note: This XSM Magic detection behavior was introduced by Xen 4.7.
>   	Xen 4.6 (and downwards) still requires the XSM module to have the
>   	compatible string "xen,xsm-policy".
>

Regards,
Ian Jackson April 25, 2016, 4:35 p.m. UTC | #2
Julien Grall writes ("Re: [Xen-devel] [PATCH] docs/arm64: clarify the
> Somehow, I am not in the mail CC. Maybe because of the "," at the end?

How odd.

> Otherwise, the text looks good to me. I have some questions about the 
> formatting, see below.

I think there has been some damage from repeated tab<->space
conversions.

I will resend.

Ian.
Stefano Stabellini April 26, 2016, 9:47 a.m. UTC | #3
On Mon, 25 Apr 2016, Ian Jackson wrote:
> From: Fu Wei <fu.wei@linaro.org>
> 
> Improve the clarity of the wording introduced in 67831c4c
> "docs/arm64: update the documentation for loading XSM support"
> 
> Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> CC: Fu Wei <fu.wei@linaro.org>
> CC: Julien Grall <julien.grall@arm.com>,
> CC: Stefano Stabellini <sstabellini@kernel.org>

Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>

Added to my queue.


>  docs/misc/arm/device-tree/booting.txt |   31 ++++++++++++++++++-------------
>  1 file changed, 18 insertions(+), 13 deletions(-)
> 
> diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
> index cae46eda..f3179d6 100644
> --- a/docs/misc/arm/device-tree/booting.txt
> +++ b/docs/misc/arm/device-tree/booting.txt
> @@ -26,19 +26,24 @@ Each node contains the following properties:
>  	Xen will assume that the first module which lacks a more
>  	specific compatible string is a "multiboot,kernel".
>  
> -	Xen will check all the modules for the XSM Magic from the second
> -	module that lacks a specific compatible string. According to the
> -	result of the detection:
> -	- if it's an XSM, Xen will assume its compatible string is
> -	  "xen,xsm-policy";
> -	- if it's not an XSM, for the second module that lacks a specific
> -	  compatible string, Xen will assume its compatible string is
> -	  "multiboot,ramdisk"; the third and subsequent modules that
> -	  lack a specific compatible string will not receive any special
> -	  treatment.
> -	This means that if the ramdisk module is present and does not have
> -	the compatible string "multiboot,ramdisk", then it must always be
> -	the second module.
> +	Xen will examine each module, starting from the second
> +	module that lacks a specific compatible string.  Xen will
> +        check each such module for the XSM Magic number:
> +
> +	- For a module which has the XSM Magic number: it will be
> +          treated by Xen as if its compatible string was
> +          "xen,xsm-policy";
> +
> +	- For a module which does not have the XSM Magic: the second
> +          module lacking a compatible string will be treated by Xen as
> +          if its compatible string was "multiboot,ramdisk"; for the
> +          third and subsequent modules which lack a specific
> +          compatible string, Xen will not apply any special treatment.
> +
> +	This means if the ramdisk module is present and does not have the
> +	compatible string "multiboot,ramdisk", then it must always be the
> +	second module.
> +
>  	Note: This XSM Magic detection behavior was introduced by Xen 4.7.
>  	Xen 4.6 (and downwards) still requires the XSM module to have the
>  	compatible string "xen,xsm-policy".
> -- 
> 1.7.10.4
>
Wei Liu April 26, 2016, 9:56 a.m. UTC | #4
On Tue, Apr 26, 2016 at 10:47:34AM +0100, Stefano Stabellini wrote:
> On Mon, 25 Apr 2016, Ian Jackson wrote:
> > From: Fu Wei <fu.wei@linaro.org>
> > 
> > Improve the clarity of the wording introduced in 67831c4c
> > "docs/arm64: update the documentation for loading XSM support"
> > 
> > Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> > CC: Fu Wei <fu.wei@linaro.org>
> > CC: Julien Grall <julien.grall@arm.com>,
> > CC: Stefano Stabellini <sstabellini@kernel.org>
> 
> Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
> 
> Added to my queue.
> 

FYI this patch is already applied last night. I picked this up too when
I committed my queue.

I will leave all the ARM patches to you in the future if they aren't
urgent. That should avoid us racing with each other.

Wei.
Stefano Stabellini April 26, 2016, 9:57 a.m. UTC | #5
On Tue, 26 Apr 2016, Wei Liu wrote:
> On Tue, Apr 26, 2016 at 10:47:34AM +0100, Stefano Stabellini wrote:
> > On Mon, 25 Apr 2016, Ian Jackson wrote:
> > > From: Fu Wei <fu.wei@linaro.org>
> > > 
> > > Improve the clarity of the wording introduced in 67831c4c
> > > "docs/arm64: update the documentation for loading XSM support"
> > > 
> > > Signed-off-by: Ian Jackson <ian.jackson@eu.citrix.com>
> > > CC: Fu Wei <fu.wei@linaro.org>
> > > CC: Julien Grall <julien.grall@arm.com>,
> > > CC: Stefano Stabellini <sstabellini@kernel.org>
> > 
> > Reviewed-by: Stefano Stabellini <sstabellini@kernel.org>
> > 
> > Added to my queue.
> > 
> 
> FYI this patch is already applied last night. I picked this up too when
> I committed my queue.
> 
> I will leave all the ARM patches to you in the future if they aren't
> urgent. That should avoid us racing with each other.

All right, thanks
diff mbox

Patch

diff --git a/docs/misc/arm/device-tree/booting.txt b/docs/misc/arm/device-tree/booting.txt
index cae46eda..f3179d6 100644
--- a/docs/misc/arm/device-tree/booting.txt
+++ b/docs/misc/arm/device-tree/booting.txt
@@ -26,19 +26,24 @@  Each node contains the following properties:
 	Xen will assume that the first module which lacks a more
 	specific compatible string is a "multiboot,kernel".
 
-	Xen will check all the modules for the XSM Magic from the second
-	module that lacks a specific compatible string. According to the
-	result of the detection:
-	- if it's an XSM, Xen will assume its compatible string is
-	  "xen,xsm-policy";
-	- if it's not an XSM, for the second module that lacks a specific
-	  compatible string, Xen will assume its compatible string is
-	  "multiboot,ramdisk"; the third and subsequent modules that
-	  lack a specific compatible string will not receive any special
-	  treatment.
-	This means that if the ramdisk module is present and does not have
-	the compatible string "multiboot,ramdisk", then it must always be
-	the second module.
+	Xen will examine each module, starting from the second
+	module that lacks a specific compatible string.  Xen will
+        check each such module for the XSM Magic number:
+
+	- For a module which has the XSM Magic number: it will be
+          treated by Xen as if its compatible string was
+          "xen,xsm-policy";
+
+	- For a module which does not have the XSM Magic: the second
+          module lacking a compatible string will be treated by Xen as
+          if its compatible string was "multiboot,ramdisk"; for the
+          third and subsequent modules which lack a specific
+          compatible string, Xen will not apply any special treatment.
+
+	This means if the ramdisk module is present and does not have the
+	compatible string "multiboot,ramdisk", then it must always be the
+	second module.
+
 	Note: This XSM Magic detection behavior was introduced by Xen 4.7.
 	Xen 4.6 (and downwards) still requires the XSM module to have the
 	compatible string "xen,xsm-policy".