diff mbox

[v4,4/4] arm64: update the introduction of xen boot commands in docs/grub.texi

Message ID 1462889006-23671-5-git-send-email-fu.wei@linaro.org (mailing list archive)
State New, archived
Headers show

Commit Message

fu.wei@linaro.org May 10, 2016, 2:03 p.m. UTC
From: Fu Wei <fu.wei@linaro.org>

delete: xen_linux, xen_initrd, xen_xsm
add: xen_module

This update bases on
    commit 0edd750e50698854068358ea53528100a9192902
    Author: Vladimir Serbinenko <phcoder@gmail.com>
    Date:   Fri Jan 22 10:18:47 2016 +0100

        xen_boot: Remove obsolete module type distinctions.

Also bases on the module loading mechanism of Xen code:
488c2a8 docs/arm64: clarify the documention for loading XSM support
67831c4 docs/arm64: update the documentation for loading XSM support
ca32012 xen/arm64: check XSM Magic from the second unknown module.

Signed-off-by: Fu Wei <fu.wei@linaro.org>
---
 docs/grub.texi | 33 ++++++++++-----------------------
 1 file changed, 10 insertions(+), 23 deletions(-)

Comments

Julien Grall May 16, 2016, 11:28 a.m. UTC | #1
Hi Fu Wei,

(CC Stefano)

On 10/05/16 15:03, fu.wei@linaro.org wrote:
> From: Fu Wei <fu.wei@linaro.org>
>
> delete: xen_linux, xen_initrd, xen_xsm
> add: xen_module
>
> This update bases on
>      commit 0edd750e50698854068358ea53528100a9192902
>      Author: Vladimir Serbinenko <phcoder@gmail.com>
>      Date:   Fri Jan 22 10:18:47 2016 +0100
>
>          xen_boot: Remove obsolete module type distinctions.
>
> Also bases on the module loading mechanism of Xen code:
> 488c2a8 docs/arm64: clarify the documention for loading XSM support
> 67831c4 docs/arm64: update the documentation for loading XSM support
> ca32012 xen/arm64: check XSM Magic from the second unknown module.
>
> Signed-off-by: Fu Wei <fu.wei@linaro.org>
> ---
>   docs/grub.texi | 33 ++++++++++-----------------------
>   1 file changed, 10 insertions(+), 23 deletions(-)
>
> diff --git a/docs/grub.texi b/docs/grub.texi
> index 82f6fa4..df6018a 100644
> --- a/docs/grub.texi
> +++ b/docs/grub.texi
> @@ -3861,9 +3861,7 @@ you forget a command, you can run the command @command{help}
>   * videoinfo::                   List available video modes
>   @comment * xen_*::              Xen boot commands
>   * xen_hypervisor::              Load xen hypervisor binary
> -* xen_linux::                   Load dom0 kernel for xen hypervisor
> -* xen_initrd::                  Load dom0 initrd for dom0 kernel
> -* xen_xsm::                     Load xen security module for xen hypervisor
> +* xen_module::                  Load xen modules for xen hypervisor
>   @end menu
>
>
> @@ -5141,30 +5139,19 @@ verbatim as the @dfn{kernel command-line}. Any other binaries must be
>   reloaded after using this command.
>   @end deffn
>
> -@node xen_linux
> -@subsection xen_linux
> +@node xen_module
> +@subsection xen_module
>
> -@deffn Command xen_linux file [arguments]
> -Load a dom0 kernel image for xen hypervisor at the booting process of xen.
> +@deffn Command xen_module [--nounzip] file [arguments]
> +Load a module for xen hypervisor at the booting process of xen.
>   The rest of the line is passed verbatim as the module command line.
> +Modules should be loaded in the following order:
> +The 1st module: dom0 kernel image
> +The 2nd module: dom0 ramdisk (optional, if the ramdisk is present, it must
> +always be the second module)
> +If the XSM is present, it can be loaded at any time after the 1st module.

I find the instruction confusing. You wrote that XSM can be loaded any 
time after the 1st module, but just before you wrote that ramdisk should 
always be the first one.

What about:
"Modules should be loaded in the following order:
  - dom0 kernel image
  - dom0 ramdisk if present
  - XSM policy if present"

Regards,
fu.wei@linaro.org May 20, 2016, 2:14 a.m. UTC | #2
Hi Julien,

On 16 May 2016 at 19:28, Julien Grall <julien.grall@arm.com> wrote:
> Hi Fu Wei,
>
> (CC Stefano)
>
>
> On 10/05/16 15:03, fu.wei@linaro.org wrote:
>>
>> From: Fu Wei <fu.wei@linaro.org>
>>
>> delete: xen_linux, xen_initrd, xen_xsm
>> add: xen_module
>>
>> This update bases on
>>      commit 0edd750e50698854068358ea53528100a9192902
>>      Author: Vladimir Serbinenko <phcoder@gmail.com>
>>      Date:   Fri Jan 22 10:18:47 2016 +0100
>>
>>          xen_boot: Remove obsolete module type distinctions.
>>
>> Also bases on the module loading mechanism of Xen code:
>> 488c2a8 docs/arm64: clarify the documention for loading XSM support
>> 67831c4 docs/arm64: update the documentation for loading XSM support
>> ca32012 xen/arm64: check XSM Magic from the second unknown module.
>>
>> Signed-off-by: Fu Wei <fu.wei@linaro.org>
>> ---
>>   docs/grub.texi | 33 ++++++++++-----------------------
>>   1 file changed, 10 insertions(+), 23 deletions(-)
>>
>> diff --git a/docs/grub.texi b/docs/grub.texi
>> index 82f6fa4..df6018a 100644
>> --- a/docs/grub.texi
>> +++ b/docs/grub.texi
>> @@ -3861,9 +3861,7 @@ you forget a command, you can run the command
>> @command{help}
>>   * videoinfo::                   List available video modes
>>   @comment * xen_*::              Xen boot commands
>>   * xen_hypervisor::              Load xen hypervisor binary
>> -* xen_linux::                   Load dom0 kernel for xen hypervisor
>> -* xen_initrd::                  Load dom0 initrd for dom0 kernel
>> -* xen_xsm::                     Load xen security module for xen
>> hypervisor
>> +* xen_module::                  Load xen modules for xen hypervisor
>>   @end menu
>>
>>
>> @@ -5141,30 +5139,19 @@ verbatim as the @dfn{kernel command-line}. Any
>> other binaries must be
>>   reloaded after using this command.
>>   @end deffn
>>
>> -@node xen_linux
>> -@subsection xen_linux
>> +@node xen_module
>> +@subsection xen_module
>>
>> -@deffn Command xen_linux file [arguments]
>> -Load a dom0 kernel image for xen hypervisor at the booting process of
>> xen.
>> +@deffn Command xen_module [--nounzip] file [arguments]
>> +Load a module for xen hypervisor at the booting process of xen.
>>   The rest of the line is passed verbatim as the module command line.
>> +Modules should be loaded in the following order:
>> +The 1st module: dom0 kernel image
>> +The 2nd module: dom0 ramdisk (optional, if the ramdisk is present, it
>> must
>> +always be the second module)
>> +If the XSM is present, it can be loaded at any time after the 1st module.
>
>
> I find the instruction confusing. You wrote that XSM can be loaded any time
> after the 1st module, but just before you wrote that ramdisk should always
> be the first one.
>
> What about:
> "Modules should be loaded in the following order:
>  - dom0 kernel image
>  - dom0 ramdisk if present
>  - XSM policy if present"

yes, Thanks for your suggestion, it's simpler and less confused.

will do.

>
> Regards,
>
> --
> Julien Grall
diff mbox

Patch

diff --git a/docs/grub.texi b/docs/grub.texi
index 82f6fa4..df6018a 100644
--- a/docs/grub.texi
+++ b/docs/grub.texi
@@ -3861,9 +3861,7 @@  you forget a command, you can run the command @command{help}
 * videoinfo::                   List available video modes
 @comment * xen_*::              Xen boot commands
 * xen_hypervisor::              Load xen hypervisor binary
-* xen_linux::                   Load dom0 kernel for xen hypervisor
-* xen_initrd::                  Load dom0 initrd for dom0 kernel
-* xen_xsm::                     Load xen security module for xen hypervisor
+* xen_module::                  Load xen modules for xen hypervisor
 @end menu
 
 
@@ -5141,30 +5139,19 @@  verbatim as the @dfn{kernel command-line}. Any other binaries must be
 reloaded after using this command.
 @end deffn
 
-@node xen_linux
-@subsection xen_linux
+@node xen_module
+@subsection xen_module
 
-@deffn Command xen_linux file [arguments]
-Load a dom0 kernel image for xen hypervisor at the booting process of xen.
+@deffn Command xen_module [--nounzip] file [arguments]
+Load a module for xen hypervisor at the booting process of xen.
 The rest of the line is passed verbatim as the module command line.
+Modules should be loaded in the following order:
+The 1st module: dom0 kernel image
+The 2nd module: dom0 ramdisk (optional, if the ramdisk is present, it must
+always be the second module)
+If the XSM is present, it can be loaded at any time after the 1st module.
 @end deffn
 
-@node xen_initrd
-@subsection xen_initrd
-
-@deffn Command xen_initrd file
-Load a initrd image for dom0 kernel at the booting process of xen.
-@end deffn
-
-@node xen_xsm
-@subsection xen_xsm
-
-@deffn Command xen_xsm file
-Load a xen security module for xen hypervisor at the booting process of xen.
-See @uref{http://wiki.xen.org/wiki/XSM} for more detail.
-@end deffn
-
-
 @node Networking commands
 @section The list of networking commands