diff mbox

[2/2] kvm-kmod: Document the build process

Message ID 1256040699-27468-2-git-send-email-wolfgang.mauerer@siemens.com (mailing list archive)
State New, archived
Headers show

Commit Message

wolfgang.mauerer@siemens.com Oct. 20, 2009, 12:11 p.m. UTC
None
diff mbox

Patch

diff --git a/README b/README
new file mode 100644
index 0000000..40a72d3
--- /dev/null
+++ b/README
@@ -0,0 +1,26 @@ 
+Building the KVM kernel module is performed differently depending on whether
+you are working from a clone of the git repository or from a source release.
+
+- To build from a release, simply use ./configure (possibly with any
+  arguments that are required for your setup, see ./configure --help)
+  and make.
+
+- Building from a cloned git repository requires a kernel tree with the main
+  kvm sources that is included as a submodule in the linux-2.6/ directory.  By
+  default, the KVM development tree on git.kernel.org is used, but you can
+  change this setting in .gitmodules
+
+  Before the kvm module can be built, the linux submodule must be initialised 
+  and populated. The required sequence of commands is
+
+  git submodule init
+  git submodule update
+  ./configure
+  make sync
+  make
+
+  Notice that you can also specify an existing Linux tree for the
+  synchronisation stage by using
+
+  make sync LINUX=/path/to/tree
+