]> xenbits.xensource.com Git - people/iwj/xen.git/commitdiff
INSTALL: Mention kconfig
authorIan Jackson <ian.jackson@citrix.com>
Fri, 21 Sep 2018 14:40:19 +0000 (15:40 +0100)
committerIan Jackson <ian.jackson@eu.citrix.com>
Mon, 8 Oct 2018 14:23:13 +0000 (15:23 +0100)
Firstly, add a reference to the documentation for the kconfig system.

Secondly, warn the user about the XEN_CONFIG_EXPERT problem.

CC: Wei Liu <wei.liu2@citrix.com>
CC: Andrew Cooper <andrew.cooper3@citrix.com>
CC: Jan Beulich <JBeulich@suse.com>
Signed-off-by: Ian Jackson <ian.jackson@citrix.com>
Reviewed-by: Doug Goldstein <cardoe@cardoe.com>
---
v2: Fix typos

INSTALL

diff --git a/INSTALL b/INSTALL
index 9aa9ebdddc90ec9963bd0e6461a44eb3705175b5..e28348509f3b5894efb5e2d061642c4038b45186 100644 (file)
--- a/INSTALL
+++ b/INSTALL
@@ -19,6 +19,26 @@ following compile process. Once configure is done, make(1) has to be
 called. Also make(1) recognizes certain arguments. The following sections
 will give an overview.
 
+Xen Hypervisor
+==============
+
+Xen itself is configured via a `kconfig' system borrowed from Linux.
+See docs/misc/kconfig.txt.
+
+Note that unlike with Linux, and contrary to that document, you cannot
+look at Kconfig files, or the default or generated config files etc.,
+to find available configuration options.  This is because it is only
+supported (and security supported) by the Xen Project, to change a
+small subset of the options.  Attempts to change other options will be
+silently overridden.  The only way to find which configuration options
+are available is to run `make menuconfig' or the like.
+
+You can counter-override this behaviour by setting XEN_CONFIG_EXPERT=y
+in your environment.  However, doing this is not supported and the
+resulting configurations do not receive security support.  If you set
+this variable there is nothing stopping you setting dangerously
+experimental combinations of features - not even any warnings.
+
 Options recognized by configure
 ===============================