View source for Compiling the new chart module

The first step anyone need to achieve before starting to develop on the chart module
is compiling OpenOffice.org with the needed modifications for the new chart module.
OpenOffice.org provides two main ways to compile it : the "Vanilla" way and the 
"OOoBuild" way. Let's explain what they are and the differences between those two 
ways.

= Compiling OpenOffice.org : the theory =

== Vanilla ==

Vanilla is the "standard" way to compile OOo. To compile OOo the "Vanilla" way,
you only need to download the sources, unzip them, and follow the instructions given
on the page [Add a link to the build steps from]. We will give Chart-specific details
about this in the following sections.

== OOoBuild ==

To make it simple, OOoBuild is a "wrapper" around the OpenOffice.org build process
to make compiling OOo more straight-forward. Some of the enhancements added are :

* patches for known compiling problems
* integration with "[[ccache]]" and "[[icecream]]" to speed-up the process
* linux distribution specific compiling steps (specific splash screen for Fedora...)

So, to compile OOo with OOoBuild, just just need to download OOoBuild and put the
OOo standard sources in a specific directory.

= Compiling OpenOffice.org : the practice =

== Commmon steps ==

=== Getting the sources ===

==== Introduction ====

Once you have all the dependencies installed, you will need to download the sources
of OOo. When working on a specific cws (for us, the "chart2mst3" cws) you will need
to follow two steps :

* downloading the OOo sources at a specific milestone
* downloading the specific modifications for the cws from the repository

==== Download the milestone ====

For the new chart module, you will need to download the SRC680_m213 milestone or higher.

To download the milestone, you have several choices.

* Download from the cvs servers
* Download a pre-packaged version
* Download from the main OOo servers

Have a look at the following page for more explanations :
http://wiki.services.openoffice.org/wiki/Getting_It

Some advices :

I would recommend that you download a pre-packaged version from the 
following link :
http://go-ooo.org/packages/SRC680/

This will save you time compared to downloading the cvs version.


If you still want to download it from the cvs, you can use the following :
<pre>
cvs -z3 co -r SRC680_m213 OpenOffice
</pre>

==== Update the CWS modifications ====


Once you downloaded the "standard" sources (also called HEAD), you need to update
them because the chart module modifications are in a separated cws called chart2mst3.
You need to update only the modified modules. To know which modules have been modified,
check the 
[http://eis.services.openoffice.org/EIS2/cws.ShowCWS?Id=1074&Path=SRC680%2Fchart2mst3 EIS page related to the chart module.]
On this page, you will find a section called "Modules & Files" which describes the
modified modules.

For each module (subdir) you will need to do :

<pre>
cd name_of_the_module
cvs -z3 update -dP -r cws_src680_chart2mst3
</pre>

See also cws-extract from oobuild, if you want/need to
work with diffs (which will get HUGE, though)

Note : cwsclone ??? What's its use ??

=== dependencies ===

First of all before starting to compile anything, you will need to install all the
dependencies and tools needed for the compiling steps. On the Tools project page, 
you should find all the information on the "Building the source" section :

http://tools.openoffice.org/

There, you should read the different sub-sections, they will give you a nice 
introduction on how everything works. You should also notice that the steps are
different on each OS.

== Vanilla ==

=== Configuring ===

Once you downloaded all the sources, you can start configuring the build.


<pre>
cd config_office
./configure
</pre>

If you forgot to install some dependencies, the configure will remind you
which one are lacking. You can check the one needed on the 
[http://tools.openoffice.org/ tool page]


A nice trick for configuring OOo is to create a script in which you write
all the options activated for your build. This helps if you want to see
which options where enabled during the build some days after you compiled
everything. Here is an example :

<pre>
#! /usr/bin/batch
./configure  --with-jdk-home="/home/pagalmes/bin/jdk1.5.0_06/"  --with-ant-home="/usr/bin/ant" --with-lang="en fr"
</pre>

=== Building the tools (dmake...) ===

During the compiling step, the compiling process needs some tools to achieve
the build. Before compiling, you need to build those tools. For example,

* dmake
* ...

To compile the tools, just type :

<pre>
cd openOffice.org_m172/
./bootstrap
</pre>

=== Setting the environment ===

Before starting to compile OOo, you need to set all the environment variables

<pre>
tcsh
source LinuxIntelEnv.Set
setenv nodep "TRUE" ; setenv NO_HIDS "TRUE" ; setenv MAXPROCESS 2
rehash
</pre>

* '''nodep'''  : inhibits generation of dependency files
* '''maxprocess''' : sets the number of parallel dmakes per dir
* '''NO_HIDS''' prevents generation of HIDs (that's used for automated testing)

=== Compiling (finally...;-) ===

<pre>
cd instsetoo_native
build -P2 --dlv_switch -link --all
</pre>

* ''' -P2''' : fires up more than one dmake in _different_ dirs - thus, you end up with a maximum for 4 parallel compilations
* '''--dlv_switch -link''' : tells deliver not to copy files to solver, but link instead -> saves space

=== Smoke tests ===

Once everything compiled, you should launch the "smoke tests". Those are
tests to verify that the basic functions of OpenOffice.org work. To
launch the smoke tests, issue the following command lines :

<pre>
cd smoketestoo_native/
setenv TEMP "/home/pagalmes/workspace/chart2_m172_exec"
dmake noremove
</pre>

Note : sometimes those tests will fail but you can just ignore them.

== OOoBuild ==

For this section, you should read the part called "Getting started with OOo development" on the wiki :
http://wiki.services.openoffice.org/wiki/Main_Page

=== Downloading OOoBuild ===

=== Downloading the sources ===