[Xen-devel] [PATCH] docs, arm: add documentation on available defconfigs

[Xen-devel] [PATCH] docs, arm: add documentation on available defconfigs

[Volodymyr Babchuk]

As build system now have *_defconfig targets defined,
lets describe available defconfig files for the Arm architecture.

Signed-off-by: Volodymyr Babchuk <volodymyr_babchuk@epam.com>
---
 docs/misc/arm/defconfigs.txt | 23 +++++++++++++++++++++++
 1 file changed, 23 insertions(+)
 create mode 100644 docs/misc/arm/defconfigs.txt

diff --git a/docs/misc/arm/defconfigs.txt b/docs/misc/arm/defconfigs.txt
new file mode 100644
index 0000000000..46c5039eba
--- /dev/null
+++ b/docs/misc/arm/defconfigs.txt
@@ -0,0 +1,23 @@
+Xen hypervisor for Arm architecture have a number of defconfigs, which
+can be used by issuing
+
+    make xxxxx_defconfig
+
+Those defconfigs are located in xen/arch/arm/configs.
+
+Generally, you don't need to use any particular defconfig if you want
+to build default version of Xen. This is because default Xen
+configuration is intended to run on any supported platform.
+
+Anyways, there is a number of defconfig files which have special use:
+
+ - arm32_defconfig is the special defconfig file used by build system as
+   the default configuration for the arm32 sub-architecture.
+
+ - arm64_defconfig is the same as arm32_defconfig, but for arm64 builds.
+
+ - tiny64_defconfig configures Xen hypervisor for the minimal possible
+   build for arm64 architecture. It disables most of the configuration
+   options, except the credit scheduler. Use 'make menuconfig' to
+   enable features needed for your platform, or produced image will
+   be non-functional.
-- 
2.21.0

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

Re: [Xen-devel] [PATCH] docs, arm: add documentation on available defconfigs

[Julien Grall]

Hi Volodymyr,

Sorry for the late answer.

On 14/06/2019 16:23, Volodymyr Babchuk wrote:
> As build system now have *_defconfig targets defined,
> lets describe available defconfig files for the Arm architecture.
> 
> Signed-off-by: Volodymyr Babchuk <volodymyr_babchuk@epam.com>
> ---
>   docs/misc/arm/defconfigs.txt | 23 +++++++++++++++++++++++
>   1 file changed, 23 insertions(+)
>   create mode 100644 docs/misc/arm/defconfigs.txt
> 
> diff --git a/docs/misc/arm/defconfigs.txt b/docs/misc/arm/defconfigs.txt
> new file mode 100644
> index 0000000000..46c5039eba
> --- /dev/null
> +++ b/docs/misc/arm/defconfigs.txt
> @@ -0,0 +1,23 @@
> +Xen hypervisor for Arm architecture have a number of defconfigs, which

s/have/has/

> +can be used by issuing
> +
> +    make xxxxx_defconfig
> +
> +Those defconfigs are located in xen/arch/arm/configs.
> +
> +Generally, you don't need to use any particular defconfig if you want
> +to build default version of Xen. This is because default Xen
> +configuration is intended to run on any supported platform.

This paragraph is a bit hard to read. I would suggest to drop it and add a 
paragraph at the end of the file stating that if no defconfig is specified, then 
arm64_defconfig and arm32_defconfig will be used.

> +
> +Anyways, there is a number of defconfig files which have special use:

NIT: s/is/are/ I think.

> +
> + - arm32_defconfig is the special defconfig file used by build system as
> +   the default configuration for the arm32 sub-architecture.

Here you describe arm32 as a sub-architecture but below you describe arm64 as an 
architecture. The architecture is called Arm and 64-bit/32-bit are executions 
state. How about the following wording:

"arm32_defconfig will configure the build system to generate a binary booting on 
any supported 32-bit platform. This can be used as a base for downstream 
distribution to package Xen hypervisor".

> +
> + - arm64_defconfig is the same as arm32_defconfig, but for arm64 builds.

I would prefer if you avoid to relate arm64_defconfig to arm32_defconfig. They 
may have different options enabled.

> +
> + - tiny64_defconfig configures Xen hypervisor for the minimal possible
> +   build for arm64 architecture. It disables most of the configuration
> +   options, except the credit scheduler. Use 'make menuconfig' to
> +   enable features needed for your platform, or produced image will
> +   be non-functional.

I would suggest to mention the platform configuration (see 
arch/arm/platforms/Kconfig) that help a user to select all the CONFIG_* for a 
specific platform.

Cheers,

-- 
Julien Grall

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