[Linaro-uefi,v6,4/4] arm64: update the introduction of xen boot commands in docs/grub.texi

Message ID 1469524423-7082-5-git-send-email-fu.wei@linaro.org
State New
Headers show

Commit Message

Fu Wei Fu July 26, 2016, 9:13 a.m.
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>
Reviewed-by: Julien Grall <julien.grall@arm.com>
---
 docs/grub.texi | 32 +++++++++-----------------------
 1 file changed, 9 insertions(+), 23 deletions(-)

Comments

Daniel Kiper Nov. 3, 2016, 3:25 p.m. | #1
On Tue, Jul 26, 2016 at 05:13:43PM +0800, 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>
> Reviewed-by: Julien Grall <julien.grall@arm.com>
> ---
>  docs/grub.texi | 32 +++++++++-----------------------
>  1 file changed, 9 insertions(+), 23 deletions(-)
>
> diff --git a/docs/grub.texi b/docs/grub.texi
> index 82f6fa4..85c913e 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,18 @@ 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:
> + - dom0 kernel image
> + - dom0 ramdisk if present
> + - XSM policy if present

What happens if somebody wants to use XSM without ramdisk?

Please do not forget to mention somewhere that xen_hypervisor and
xen_module commands are ARM specific.

Daniel

Patch

diff --git a/docs/grub.texi b/docs/grub.texi
index 82f6fa4..85c913e 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,18 @@  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:
+ - dom0 kernel image
+ - dom0 ramdisk if present
+ - XSM policy if present
 @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