Changes between Initial Version and Version 1 of BuildingExamples

Timestamp:

Feb 23, 2010, 7:15:12 PM (15 years ago)

Author:

becoulet

Comment:

--

BuildingExamples

@@ +1 @@
+= Building examples applications =
+
+MutekH comes with some examples applications available in [source:trunk/mutekh/examples].
+This page briefly explains how to build these examples.
+
+== Required tools ==
+
+Building MutekH requires the following software packages:
+
+ - A GNU compiler or cross-compiler. You can use the [source:trunk/mutekh/tools/crossgen.mk] script to compile and install a tool chain easily.
+ - GNU make and a perl interpreter available in most GNU/Linux and BSD operating system.
+
+Some builds may require the following additional tools
+
+ - The [FlattenedDeviceTree flattened device tree] compiler (dtc): http://git.jdl.com/gitweb/
+ - The heterogeneous linker found in [source:trunk/mutekh/tools/hlink]
+
+You may need real hardware or a simulator to run MutekH:
+
+ - [http://www.qemu.org/ Qemu] to run native x86 binaries
+ - [https://www.soclib.fr/ SoCLib] to experiment with various multiprocessor platforms
+
+You may need extra tools to deals with kernel images for some targets:
+
+ - GNU mtools or mkisofs to create a x86 bootable disk images.
+ - GNU grub or etherboot to boot a compiled kernel images.
+
+The [source:trunk/mutekh/tools/x86_cdrom.sh] and [source:trunk/mutekh/tools/x86_floppy.sh] scripts are available to easily create boot disk images.
+
+== Building examples ==
+
+Each example comes with its own config file which is used to configure
+the MutekH kernel build. This file contains application specific
+configuration to enable kernel features.
+
+Some other configuration options are related to target
+architecture. Some ready to use configuration sets for specific
+targets are factored in the [source:trunk/mutekh/common] directory. These configuration
+files are organized in sections that can be enabled from the build
+command line. Look at the chosen example config file to determine if
+it contains custom standalone configuration or if it relies on common
+configuration sets by including files from [source:trunk/mutekh/common].
+
+Please read the BuildSystem page for in depth description of the build system.
+
+=== Using standalone and specific configuration file ===
+
+Here is a make invocation for the hello example using a custom and
+standalone config file which targets x86 Linux process (see QuickStartUnix):
+
+{{{
+$ make CONF=examples/hello/config_emu
+}}}
+
+=== Relying on common configuration files ===
+
+Here are make invocations for various target architectures to build
+examples which are using common configuration files:
+
+
+ - As unix process (see QuickStartUnix), on x86_64 machine running Linux:
+{{{
+$ make CONF=examples/hello/config BUILD=emu-linux-x86_64
+}}}
+
+ - Pc, x86 machine boot image
+{{{
+$ make CONF=examples/hello/config BUILD=ibmpc-x86
+}}}
+
+ - For SoCLib simulator (see [wiki:Arch/Soclib/Tutorial MutekH/SoCLib tutorial]), Mips32 Little endian, for caba-vgmn-mutekh_soclib_tutorial or caba-vgmn-mutekh_kernel_tutorial platforms:
+{{{
+$ make CONF=examples/hello/config BUILD=soclib-mips32el:pf-tutorial
+}}}
+
+ - Heterogeneous builds for SoCLib simulator, Mips32 and Arm processors for caba-vgmn-mutekh_kernel_tutorial platform:
+{{{
+$ make kernel-het CONF=examples/hello_het/config BUILD=pf-het EACH=soclib-mips32el:soclib-arm
+}}}