]> xenbits.xensource.com Git - people/royger/xen-test-framework.git/commitdiff
Document the build requirements
authorAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 15 Feb 2016 15:33:23 +0000 (15:33 +0000)
committerAndrew Cooper <andrew.cooper3@citrix.com>
Mon, 15 Feb 2016 15:33:23 +0000 (15:33 +0000)
Signed-off-by: Andrew Cooper <andrew.cooper3@citrix.com>
docs/mainpage.dox

index de7e211d698bbfa288221465d19abd4615ea9f1c..bb80749ff87e0f4b807f358e24799232766f3fe9 100644 (file)
@@ -31,13 +31,18 @@ Environment | Guest | Width | Paging
 
 @section getting-started Getting Started
 
+Requirements:
+- GNU Make >= 3.81
+- GNU comaptible toolchain, capable of `-std=gnu99`, `-m64`, and `-m32`
+    - Clang may be used, via `CC="clang -no-integrated-as"`
+
 To obtain and build:
 
     $ git clone git://xenbits.xen.org/people/andrewcoop/xen-test-framework.git
     $ cd xen-test-framework
     $ make -j4
 
-To run tests: (see @ref errata first)
+To run tests on a Xen host: (see @ref errata first)
 
     # cd tests/example
     # xl create test-pv64-example.cfg