Re: [Xenomai-core] Two patches for the documentation

[Gilles Chanteperdrix <gilles.chanteperdrix@xenomai.org>]

[-- Attachment #1: message body and .signature --]
[-- Type: text/plain, Size: 650 bytes --]

Niklaus Giger wrote:
 > xeno.patch is a shorter way how to cross-compile using the CROSS_COMPILE 
 > variable.

The CROSS_COMPILE prefix is not used by the configure script of branch
2.1 of Xenomai (though it works with branch 2.0), the --host option of
configure should be used instead.

 > Also contains a hint to use O=../a-build-dir to compile the linux kernel.

Maybe this would look more apropriate in section 1.2, entitled "Configuring and
building Linux kernel" ?

The attached patch, for your review, attempt to reword the paragraph I
had written on cross-compilation, and reflect the last two remarks.

-- 


					    Gilles Chanteperdrix.

[-- Attachment #2: xeno.readme.patch --]
[-- Type: application/octet-stream, Size: 3729 bytes --]

Index: README.INSTALL
===================================================================
--- README.INSTALL	(revision 398)
+++ README.INSTALL	(working copy)
@@ -76,6 +76,14 @@
 
 Once configured, the kernel should be built as usual.
 
+It might be a good idea to put all the output into a different build
+directory as to build from from linux source several targets. For each
+target add O=../build-<target> to each make invocation.
+
+In order to cross-compile the Linux kernel, pass an ARCH and
+CROSS_COMPILE variable on make command line. See sections 2.2, 2.3 and
+2.4 for examples.
+
 1.3 Building the user-space support
 -----------------------------------
 
@@ -144,33 +152,29 @@
 -----------------------
 
 Passing a --host option to the configure script allows to select the
-architecture for which the libraries and programs are built. The --build option
-allow to choose the architecture on which the compilation tool are run, i.e. the
-system running the configure script. Using the --build option should not be
-needed, but if you do not use it, configure emit a warning, which may be
-confusing.
+architecture for which the libraries and programs are built. The
+--build option allow to choose the architecture on which the
+compilation tool are run, i.e. the system running the configure
+script. Using the --build option should not be needed, but if you do
+not use it, configure emit a warning, which may be confusing.
 
-The easiest way to build a GNU cross-compiler might involve using Dan Kegel 
-crosstools found at http://kegel.com/crosstool.
+The easiest way to build a GNU cross-compiler might involve using Dan
+Kegel crosstools found at http://kegel.com/crosstool.
 
-Since cross-compiling requires specific tools, such tools are generally prefixed
-with the host architecture name; for example, a compiler for the power PC
-architecture may be named powerpc-405-linux-gnu-gcc.
+Since cross-compiling requires specific tools, such tools are
+generally prefixed with the host architecture name; for example, a
+compiler for the power PC architecture may be named
+powerpc-405-linux-gnu-gcc.
 
-configure will automatically use powerpc-405-linux-gnu- as a prefix too all compilation
-tools names and deduce the architecture name. If configure is unable to deduce
-the architecture name from this prefix, you will have to manually pass the name
-of all compilation tools on configure command line. As in:
+When passing the option --host=powerpc-405-linux-gnu to configure,
+configure will automatically use powerpc-405-linux-gnu- as a prefix to
+all compilation tools names and infer the host architecture name from
+this prefix. If configure is unable to infer the architecture name
+from the cross-compilation tools prefix, you will have to manually
+pass the name of all compilation tools on configure command line. 
 
-It might be a good idea to put all the output into a differen build directory
-as to build from from linux source several targets. For each target add 
-O=../build-<target> to each make invocation.
-configure CROSS_COMPILE=powerpc-405-linux-gnu-
+See sections 2.2, 2.3 and 2.4 for examples.
 
-For more details:
-http://sourceware.org/autobook/autobook/autobook_264.html#SEC264
-http://sourceware.org/autobook/autobook/autobook_266.html#SEC266
-
 2. Typical installation procedures
 ----------------------------------
 
@@ -217,7 +221,7 @@
 $ make CROSS_COMPILE=powerpc-405-linux-gnu- O=../build-powerpc-405-2.6.14 bzImage modules 
 # then install as needed
 $ mkdir $build_root && cd $build_root
-$ $xenomai_root/configure CROSS_COMPILE=powerpc-405-linux-gnu-
+$ $xenomai_root/configure --build=i686-linux --host=powerpc-405-linux-gnu
 $ make install
 
 2.3 Building for the IPF