source: trunk/documents/UserDoc/DocBookUsersGuides/ForApplicationDeveloper/xml/Appendix/tipsCompilation.xml@ 1324

<!-- ******************************************************** -->
<!--                                                          -->
<!--  [History]                                               -->
<!--    Converted to DocBook: Katsuya Amako, Aug-2006         -->
<!--                                                          -->
<!-- ******************************************************** -->


<!-- ******************* Section (Level#1) ****************** -->
<sect1 id="sect.TpPrgCmp">
<title>
Tips for Program Compilation
</title>

<para>
This section is dedicated to illustrate and justify some of the
options used and fixed by default in the compilation of the Geant4
toolkit. It is also meant to be a simple guide for the
user/installer to avoid or overcome problems which may occur on
some compilers. Solutions proposed here are based on the experience
gained while porting the Geant4 code to different
architectures/compilers and are specific to the OS's and compiler's
version valid at the current time of writing of this manual.
</para>

<para>
It's well known that each compiler adopts its own internal
techniques to produce the object code, which in the end might be
more or less perfomant and more or less optimised, depending on
several factors also related to the system architecture which it
applies to.
</para>

<para>
After the installation of the libraries, we strongly suggest to
always distinguish between the installation directory (identified
by $G4INSTALL) and the working directory (identified by
$G4WORKDIR), in order not to alter the installation area.
</para>

<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.TpPrgCmp.UnxLnxGpp">
<title>
Unix/Linux - g++
</title>

<para>
OS: Linux
</para>

<para>
Compiler: GNU/gcc
</para>

<para>
Strict ISO/ANSI compilation is forced (<literal>-ansi -pedantic</literal>
compiler flags), also code is compiled with high verbosity
diagnostics (<literal>-Wall</literal> flag). The default optimisation level
is <literal>-O2</literal>. The flag <literal>G4OPTDEBUG</literal>, if set
in the environment, allows for optimised build of the libraries but
including debug symbols (<literal>-O -g</literal> compilation option).
</para>

<note>
<title>Note</title>

<para>
Additional compilation options (<literal>-march=XXX
-mfpmath=sseYYY</literal>) to adopt chip specific floating-point
operations on the SSE unit, can be activated by adapting the
<literal>XXX, YYY</literal> options and uncommenting the relevant
part in the <literal>Linux-g++.gmk</literal> configuration script.
By doing so, it has been verified a greater stability of results,
making possible reproducibility of exact outputs between debug,
non-optimised and optimised runs. A little performance improvement
(in the order of 2%) can also be achieved in some cases. To be
considered that binaries built using these chip-specific options
will likely NOT be portable cross platforms; generated applications
will only run on the specific chip-based architectures.
</para>
</note>

</sect2>


<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.TpPrgCmp.WndMsVslCpp">
<title>
Windows - MS Visual C++
</title>

<para>
OS: MS/Windows
</para>

<para>
Compiler: MS-VC++
</para>

<para>
Since version .NET 7.0 of the compiler, ISO/ANSI compliance is
required.
</para>

<para>
See <xref linkend="sect.ClassCate" /> of the Installation Guide for 
more detailed information.
See also <xref linkend="sect.BldMSV" /> for more tips.
</para>

</sect2>


<!-- ******************* Section (Level#2) ****************** -->
<sect2 id="sect.TpPrgCmp.McXCpp">
<title>
MacOS-X - g++
</title>

<para>
OS: MacOS/Darwin
</para>

<para>
Compiler: GNU/gcc
</para>

<para>
The setup adopted for the <literal>g++</literal> compiler on MacOS
resembles in most parts the one for Linux systems.
</para>

<para>
The default optimisation level in this case is <literal>-O2</literal>.
</para>

<para>
Dynamic libraries (<literal>.dylib</literal>) are supported as well; once
built, in order to run the generated application, the user must
specify the absolute path in the system where they're installed
with the <literal>DYLD_LIBRARY_PATH</literal> system variable.
</para>


</sect2>
</sect1>