From patchwork Thu Nov 12 17:35:22 2009 Content-Type: text/plain; charset="utf-8" MIME-Version: 1.0 Content-Transfer-Encoding: 7bit X-Patchwork-Submitter: wolfgang.mauerer@siemens.com X-Patchwork-Id: 59609 Received: from vger.kernel.org (vger.kernel.org [209.132.176.167]) by demeter.kernel.org (8.14.2/8.14.2) with ESMTP id nACHWtsZ006361 for ; Thu, 12 Nov 2009 17:32:55 GMT Received: (majordomo@vger.kernel.org) by vger.kernel.org via listexpand id S1753527AbZKLRcs (ORCPT ); Thu, 12 Nov 2009 12:32:48 -0500 Received: (majordomo@vger.kernel.org) by vger.kernel.org id S1753518AbZKLRcs (ORCPT ); Thu, 12 Nov 2009 12:32:48 -0500 Received: from lizzard.sbs.de ([194.138.37.39]:22760 "EHLO lizzard.sbs.de" rhost-flags-OK-OK-OK-OK) by vger.kernel.org with ESMTP id S1753516AbZKLRcr (ORCPT ); Thu, 12 Nov 2009 12:32:47 -0500 Received: from mail2.sbs.de (localhost [127.0.0.1]) by lizzard.sbs.de (8.12.11.20060308/8.12.11) with ESMTP id nACHWpb4026474 for ; Thu, 12 Nov 2009 18:32:52 +0100 Received: from localhost.localdomain (mchn315c.mchp.siemens.de [139.25.109.82]) by mail2.sbs.de (8.12.11.20060308/8.12.11) with ESMTP id nACHWpbj017790 for ; Thu, 12 Nov 2009 18:32:51 +0100 From: Wolfgang Mauerer To: kvm@vger.kernel.org Subject: [PATCH] kvm-kmod: Document the build process (take 2) Date: Thu, 12 Nov 2009 18:35:22 +0100 Message-Id: <1258047322-5750-1-git-send-email-wolfgang.mauerer@siemens.com> X-Mailer: git-send-email 1.6.4 In-Reply-To: <4AE16033.5080906@siemens.com> References: <4AE16033.5080906@siemens.com> Sender: kvm-owner@vger.kernel.org Precedence: bulk List-ID: X-Mailing-List: kvm@vger.kernel.org diff --git a/README b/README new file mode 100644 index 0000000..bef7586 --- /dev/null +++ b/README @@ -0,0 +1,37 @@ +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. +Notice that two kernels are involved: One from which the KVM sources +are taken (kernel A), and one for which the module is built (kernel B). +For out-of-tree module builds, it is well possible that kernel A is more +recent than kernel B. + +- To build from a release (this is the default case), simply + use ./configure (possibly with any arguments that are required for + your setup, see ./configure --help) and make. The kernel specified + with --kerneldir refers to kernel B, that is, the kernel for which + the module is built. + +- Building from a cloned git repository (most likely useful for developers + only) requires a kernel tree with the main kvm sources (kernel A) 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 this can be + changed in the git configuration. + + 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/kernel/A + + LINUX specifies the path to kernel A from which the KVM sources are taken. + The directory must point to a local git tree, not to a plain directory + containing the kernel sources. If LINUX is unset, the default value + is linux-2.6/, i.e., the git submodule.