Document the interaction of x32 ABI support and hvm64 tests

Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>

diff --git a/docs/mainpage.dox b/docs/mainpage.dox
index 75294a0996508fb64dd702b5bc87a6ce719cd9d6..c3257f52c823a41645cf32c54db2daf5793be6a8 100644 (file)
--- a/docs/mainpage.dox
+++ b/docs/mainpage.dox
@@ -38,6 +38,13 @@ Requirements:
     - Clang may be used, via `CC="clang"`
 - Python
 
+Optionally:
+- A toolchain with x32 support.
+    - `hvm64` tests would prefer to use the `elf32-x86-64` format, so they
+      both load and disassemble correctly.  In the absence of x32 support,
+      `elf32-i386` will be used which will load correctly, but disassemble
+      incorrectly.
+
 To obtain and build:
 
     $ git clone git://xenbits.xen.org/xtf.git