D:\my\source> winenv.bat

In this example, the script winenv.bat is executed in the directory D:\my\source under a 4NT shell. Unless stated otherwise, all commands appearing in this document should be entered from a 4NT shell (the exception is the configure script which has to be run from a cygwin bash shell). $SRC_ROOT will denote the directory in which the source code of OpenOffice.org is stored.

Basically, there is the choice to build OpenOffice.org from two different branches: a stable branch, which results in the release version, or a less stable developer branch (latest release see here). Links to the different sources are given in the document.

Table of Contents

• Overview
  • of Performing a Full Build
  • of Building an Individual Project
• Build Requirements
  • External Components
  • Get the Source Code
  • Generating the Build Environment and Build Tools
• Build Instructions
  • Building a Full Build
  • Building Individual Projects with a Prebuilt
  • Building a Project with Debug Information
• Instructions to Build an Installation Set
• Building Localised Versions of OpenOffice.org

Overview

This section is meant as a reminder or checklist for those who have some experience in building OpenOffice.org. Everybody else should jump to the Build Requirements section.

Even experienced builders are well advised to check the release notes at http://download.openoffice.org/index.html and the section Build Requirements in this document to inform yourself about changes since the previous releases.

Detailed step-by-step build descriptions are given from the next section on.

You can perform a full build, or you can build an individual project using a prebuilt version.

Overview of Performing a Full Build

To perform a full build, you need to follow these steps:

1. Get the source code, either from the download webpage (http://download.openoffice.org/index.html) or alternatively via a check-out from the cvs tree against a release tag, e.g. OpenOffice_1_1_4.
2. Run the configure script to check all requirements and to create the script LinuxIntelEnv.Set.SolarisSparcEnv.Set.winenv.set.
3. Run the configure script in a cygwin bash shell to check all requirements and to create the script winenv.bat.
4. Run the LinuxIntelEnv.SetSolarisSparcEnv.Setwinenv.setwinenv.bat (under 4NT) script to set all environment variables.

   Please see the last screen from the configure script for more specific information on setting up for your platform.

5. Create the build tools using bootstrap.
6. Build typing dmake in $SRC_ROOT, or build --all in the instsetoo module, or build followed by deliver in the individual modules.

Overview of Building an Individual Project

You can use a prebuilt version to build an individual project. Having a prebuilt version is necessary because the individual project you want to build could depend on other projects. A project builds a particular component of OpenOffice.org. For example, the Word Processing project builds the Word Processing application. To build an individual project, you must follow these steps:

1. Download the appropriate solver tarballs from the download webpage (http://download.openoffice.org/index.html) e.g., for 643B the solver tarball solver643B_linux_intel.tar.gz. solver643B_solaris_sparc.tar.gz. solver643B_win32intel.tar.gz. solver643B_win32intel.tar.gz.

   643 is a very old release. Please use the latest version.

2. Check out the modules for the project that you want to build from the OpenOffice.org cvs tree. If your project uses the resources module, res, check out this module also. You can, of course, also download the entire source from the download webpage (http://download.openoffice.org/index.html). However, it is not possible to download individual modules there.
3. Check out the module config_office. This is always necessary to create the build environment.
4. Also check out the modules dmake, external, sal, solenv, soltools, vos, tools, rsc and xml2cmp. These are required by bootstrap (see below).
5. Unpack the solver tarball in the $SRC_ROOT directory.
6. Run the configure script to check all requirements and to create the settings file LinuxIntelEnv.Set. SolarisSparcEnv.Set. winenv.set.
7. Run the configure script in a cygwin bash shell to check all requirements and to create the script winenv.bat.

   Note that all paths should NOT contain spaces. This will confuse dmake later.

8. Run in tcsh source LinuxIntelEnv.Set or in bash source LinuxIntelEnv.Set.sh in tcsh source SolarisSparcEnv.Set or in bash source SolarisSparcEnv.Set.sh in tcsh source winenv.set and rehash afterwards or in bash source winenv.set.sh winenv.bat to set all environment variables and build dmake.exe.
9. Create the build tools using ./bootstrap.
10. Build each module against the prebuilt solver using the build tool, followed by deliver.

Build Requirements

Before you start building, you must ensure that your system satisfies the recommended software and hardware requirements for the type of system you are working on. For Linux, Solaris, Windows, Windows, these are as follows:

Perl - Optional requirements

For committers who want to use the CWS tooling. Install them like this.

External Components

The code contains some further external components which are already provided. If you are interested in details about these, look at the External Components webpage at http://tools.openoffice.org/ext_comp.html.

Get the source code

You have two options to get the source code:

• Download the source code tarball (http://download.openoffice.org/index.html), e.g. oo_643B_src.tar.gz in case of the 643B release.

  Unpack the tarballs as follows (for the 643B example):

  > tar -xvzf oo_643B_src.tar.gz
  > cd oo_643B_src 
  

  This will be $SRC_ROOT from now on.

• Another possibility is to check out the code from the cvs tree. If you don't have a username and password, you can still do a checkout as anoncvs:

  > cvs -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs login
  Just press enter when prompted for the password.
  > cd $SRC_ROOT
  $SRC_ROOT> cvs /
      -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs /
      co -r OpenOffice_1_1_4 OpenOffice
  

  The non-bold slash means that the command should be in one line. It is possible to update an already existing older copy to a newer release:

  $SRC_ROOT> cvs /
      -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs /
      update -r OpenOffice_1_1_4 OpenOffice
  

• If you're only interested in building individual modules, you won't need the entire source code. You can check out individual modules from the cvs tree:

  $SRC_ROOT> cvs /
      -d:pserver:anoncvs@anoncvs.services.openoffice.org:/cvs /
      co -r OpenOffice_1_1_4 (module-name)
  

• A note on the tags (i.e. the argument to the -r option in the cvs commands listed above): If HEAD is used as a tag, you will get the newest latest source code. This, however, will most likely not build since development is going on there. See http://tools.openoffice.org#CWS for a description of the development process with child workspaces and Environment Information System for the current child workspaces and milestones.

Generating the Build Environment and Build Tools

CC=/your/path/to/gcc
CXX=/your/path/to/g++
export CC CXX

CC=/your/path/to/cc
CXX=/your/path/to/CC
export CC CXX

$SRC_ROOT> cd config_office
config_office> ./configure

$SRC_ROOT> cd config_office
config_office> ./configure --with-cl-home="/cygdrive/c/Programme/Microsoft Visual Studio .NET 2003/Vc7"
--with-asm-home=/cygdrive/c/ml --with-jdk-home=/cygdrive/c/j2sdk1.4.1_02
--with-use-shell=tcsh

config_office> ./configure --help

config_office> bash configure --help

$SRC_ROOT> tcsh

$SRC_ROOT> source LinuxIntelEnv.Set
$SRC_ROOT> source SolarisSparcEnv.Set
$SRC_ROOT> source winenv.set

$SRC_ROOT> rehash

$SRC_ROOT> cd config_office
config_office> cvs update configure.in
config_office> autoreconf

$SRC_ROOT> cd config_office
config_office> cvs update configure.in
get a bash shell
config_office>bash autoconf
exit the bash shell

$SRC_ROOT> ./bootstrap

$SRC_ROOT> dmake

   rm -rf */unxlngi4.pro

$SRC_ROOT/(module)> build
$SRC_ROOT/(module)> deliver

$SRC_ROOT> tar -xzvf solver643B_linux_intel.tar.gz


$SRC_ROOT> gunzip solver643B_solaris_sparc.tar.gz
$SRC_ROOT> tar -xvf solver643B_solaris_sparc.tar


$SRC_ROOT> tar -xvzf solver643B_win32int.tar.gz

$SRC_ROOT/(module-name)> build
$SRC_ROOT/(module-name)> deliver

$SRC_ROOT/(module)> rm -rf unxlngi4.prounxsols3.prowntmsci9.pro
$SRC_ROOT/(module)> build debug=true

$SRC_ROOT/instsetoo> rm -rf unxlngi4.prounxsols3.prowntmsci9.pro

$SRC_ROOT> cd instsetoo/unxlngi4.prounxsols3.prowntmsci9.pro/01/normal
normal> ./setupnormal> setup.exe

$SRC_ROOT/solver/641/unxlngi4.pro/pck.$SRC_ROOT/solver/641/unxsols3.pro/pck.$SRC_ROOT/solver/641/wntmsci9.pro/pck.

$SRC_ROOT/instsetoo/unxlngi4.prounxsols3.prowntmsci9.pro/01/normal, 

$SRC_ROOT/instsetoo/unxlngi4.prounxsols3.prowntmsci9.pro/33/normal.