From: Juergen Gross Date: Fri, 2 Sep 2016 08:56:47 +0000 (+0200) Subject: mini-os: update README to reflect recent changes X-Git-Tag: xen-4.8.0-rc1~4 X-Git-Url: http://xenbits.xensource.com/gitweb?a=commitdiff_plain;h=2038d20ecae19f72327527800efd1bfefc86fa38;p=mini-os.git mini-os: update README to reflect recent changes Add some notes to README regarding configuration of Mini-OS via config files. Signed-off-by: Juergen Gross Reviewed-by: Samuel Thibault --- diff --git a/README b/README index 7e9c07a..abd8440 100644 --- a/README +++ b/README @@ -19,6 +19,37 @@ This includes: - to build it just type make. +- Mini-OS can be configured in various ways by specifying a config file: + + MINIOS_CONFIG=config-file make + + config-file can contain various CONFIG_* items set to either "y" or "n". + Their defaults can be found in Config.mk. + It is possible to specify the interface version of Xen via setting + + XEN_INTERFACE_VERSION= + + in the config file. This defaults to 0x00030205, which is the minimal + version supported. The latest available version is specified by setting + + XEN_INTERFACE_VERSION=__XEN_LATEST_INTERFACE_VERSION__ + +- By typing + + make testbuild + + it is possible to test builds of various configurations. This should be + done always after modifying Mini-OS. + + The configurations which are build tested can be found in the directory + arch/*/testbuild with one file per configuration. Those configurations are + being built for each sub-architecture (e.g. x86_32 and x86_64 for the + x86 architecture). + + Please update the current configuration files when adding a new CONFIG_ + item and maybe even add a new configuration file if the new item interacts + with other CONFIG_ items. + - to build it with TCP/IP support, download LWIP 1.3.2 source code and type make LWIPDIR=/path/to/lwip/source