Apache OpenOffice Wiki - User contributions [en]

User:AlbinoNeto

2013-05-05T14:56:37Z

AlbinoNeto: /* Where do I contribute */

= Albino B Neto =

ID Apache: bino28
IRC: bino
E-mail: binoanb [at] gmail [dot] com
identi.ca: @binoanb
Homepage: albinopcs.wordpress.com

== Where do I contribute ==

* [[PT-BR|Brazilian community]]
* Translation pt_BR (L10N)
* Codes
* QA
* Users
* Marketing

User:AlbinoNeto

2013-05-05T14:55:33Z

AlbinoNeto:

Documentation/Building Guide AOO/Step by step

2013-05-05T14:50:19Z

AlbinoNeto:

{{DISPLAYTITLE:Step by step building guides for different platforms}}

__TOC__

This page is intended as a collection of simple step-by-step recipes to build Apache OpenOffice from source code. A more thorough explanation of what the individual steps do and why they are necessary can be found in the [[Documentation/Building_Guide_AOO|building guide]].

=Ubuntu 12.04=

*Setup VirtualBox with Ubuntu 12.04 64 bit on Windows7 64bit host. A native installation is of course fine, too.
*Let updater update ca. 380 packages. Restart.
*Get the source. You can start with the source release or by checking out from SVN:
{| class="prettytable"
|-
! Source release
! SVN
|- valign="top"
| Build from source release if you want to build OpenOffice once but don't want to do any development.
| Build from SVN if you want to development work with OpenOffice.
|- valign="top"
|
* Download AOO 3.4.1 source tarball from
http://people.apache.org/~jsc/developer-snapshots/r1372282/src/aoo-3.4.1-incubating-src.tar.bz2

* Optional: Download signature from
http://people.apache.org/~jsc/developer-snapshots/r1372282/src/aoo-3.4.1-incubating-src.tar.bz2.asc

and verify the source tarball with
gpg --verify aoo-3.4.1-incubating-src.tar.bz2.asc \
aoo-3.4.1-incubating-src.tar.bz2
Note that you have to have the keys already imported to your key chain.
The keys can be found on the download page:

http://www.apache.org/dist/incubator/ooo/KEYS

* Unpack source:
cd /tmp
tar -xjf ~/Downloads/aoo-3.4.1-incubating-src.tar.bz2
cd aoo-3.4.1/main
|
* Start with creating a parent directory for the source code. Don't use <code>/tmp</code> because that is deleted on every boot:
sudo mkdir /source
sudo chown <your-user-name> /source
cd /source
* Install subversion and checkout the source:
sudo apt-get install subversion
svn co https://svn.apache.org/repos/asf/incubator/ooo/trunk aoo-trunk
cd aoo-trunk/main
|}

* Install requirements (this will also install packages that are not listed):
sudo apt-get install g++ gcc bison flex libarchive-zip-perl libcups2-dev \
libpam0g-dev gperf libfreetype6-dev libxaw7-dev libfontconfig1-dev \
libxrandr-dev patch libgconf2-dev libgnomevfs2-dev ant libgtk2.0-dev \
junit junit4 libidl-dev liborbit2-dev openjdk-6-jdk libwww-perl \
libxml-parser-perl autoconf libssl-dev

* Run autoconf to generate configure script:
autoconf

* Configure (see the building guide section on [[Documentation/Building_Guide_AOO#Configuration_and_bootstrapping|configuration]] for further options):
./configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://epm.sourcearchive.com/downloads/3.7-1/epm_3.7.orig.tar.gz \
--disable-odk \
--disable-binfilter

* Finish configuration and download missing tarballs and extensions:
./bootstrap

* Include the configured environment:
source LinuxX86-64Env.Set.sh

* Build:
cd instsetoo_native/
build --all
This may take a while to complete. Several hours are not uncommon. To speed things up you may want to run 'build' like this
build --all -P<n> -- -P<n>
to start a parallel build. Replace <n> with the number of CPU cores.

* Install:
sudo dpkg -i unxlngx6.pro/Apache_OpenOffice/deb/install/en-US/DEBS/*.deb
sudo dpkg -i unxlngx6.pro/Apache_OpenOffice/deb/install/en-US/DEBS/desktop-integration/openoffice.org3.4-debian-menus_3.4-9593_all.deb

* Start Apache OpenOffice:
/opt/openoffice.org3/program/soffice

=Windows 7=

*Install cygwin
**Browse to http://cygwin.com.
**Click on the setup.exe link (most recent Cygwin DLL at the moment is 1.7.16-1) to download the installer and run it.
**Click through the questions.
**On the "Choose A Download Site" select a nearby download server.
**Expect a "Setup Alert" dialog box on the first cygwin install on the computer.
**Click OK to close it.
**On the page that allows you to select additional packages just select wget (enter wget in the Search box and select the wget enty in the Web/Default section.
**Click Next to finish package selection.
**Click Next to resolve dependencies.
**After installation is finished click the Finish button to close the dialog.

*Start cygwin bash in a terminal
::One way to do this is:
::*Press WindowsKey-R
::*Enter c:\cygwin\Cygwin.bat
::*Hit Return.

* Install Java.
::Choose between JDK 1.6 (JDK 1.7 does not work because of hsqldb, 2013-02) or OpenJDK.
::*If you chose JDK 1.6: Download the current JDK from www.oracle.com/technetwork/java/javase/downloads/index.html.
::*Download and run the 32-bit Windows version (currently this is jdk-6u35-windows-i586.exe).

* Install Ant
**Browse to http://ant.apache.org/bindownload.cgi
**Chose a mirror near you.
**Download the zip archive (currently that is apache-ant-1.8.4-bin.zip).
**Open downloaded archive in file explorer and unzip it to a location of your choice, eg <code>c:\</code>. Note that <code>C:\Program Files (x86)</code> will not work due to problems of quoting the spaces and parentheses.

* Prepare to install missing cygwin packages by installing apt-cyg from googlecode.com<pre>cd to /cygdrive/c/temp</pre>(or any other temporary directory of your choice)<pre>wget http://apt-cyg.googlecode.com/svn/trunk/apt-cyg
chmod +x apt-cyg
mv apt-cyg /usr/local/bin/</pre>
* Use apt-cyg to install missing cygwin packages<pre>apt-cyg install perl zip unzip gperf autoconf rsync gcc4-g++ bison flex patch</pre> If you will use git, you need in addition the packages<pre>git git-svn</pre>

* Replace symlinked awk with copy of gawk.exe:<pre>rm /usr/bin/awk
mv /usr/bin/gawk.exe /usr/bin/awk.exe</pre>Note that if the <code>rm</code> command fails then the <code>mv</code> is not necessary.

* Install Visual C++ 2008 Express SP1
**Browse to http://www.microsoft.com/en-us/download/details.aspx?id=10986
**Download the vcssetup.exe installer and run it to install Visual C++ Express. This will download another 400MB during installation.
**Alternatively download the iso image http://www.microsoft.com/en-us/download/details.aspx?id=20955. Burn it to a dvd or unzip it.

* Install <del>Windows SDK for Windows Server 2008</del> Microsoft Windows SDK for Windows 7 and .NET Framework 3.5. SP1 (recommend by Microsoft)
** <del>Browse to http://www.microsoft.com/en-us/download/details.aspx?id=11310.</del> Browse to http://www.microsoft.com/en-us/download/details.aspx?id=3138.
** Download Setup.exe and run the web installer (note that it will be saved as Setup(1).exe to disambiguate from the previously downloaded cygwin installer.) You can use the default values in the installation dialog.
** Alternatively download the iso image http://www.microsoft.com/en-us/download/details.aspx?id=18950. Burn it to a dvd or unzip it.

* Download MS Visual C++ 2008 SP1 Redistributable Package (x86)
**<del>Browse to http://www.microsoft.com/en-us/download/details.aspx?id=5582</del> http://www.microsoft.com/en-us/download/details.aspx?id=26368 ( There have been security updates, which are not included in older versions.)
**Download files vcredist_x86.exe and vcrestist_x64.exe If you download the most actual version of Apache OpenOffice and unpack it, you will find the files vcredist_x86.exe and vcredist_x64.exe in folder redist. You can use them as well.

* Optional: Install DirectX SDK (for graphics hardware support in the slide show)
** Browse to http://www.microsoft.com/en-us/download/details.aspx?displaylang=en&id=6812
** Download and run DXSDK_Jun10.exe

* Optional: Install NSIS installer (for creating the EXE installer)
** Browse to http://nsis.sourceforge.net
** Download and run the installer.

* Get AOO source code. You can use the source release or check out from SVN. Build from source release if you want to build OpenOffice once but don't want to contribute patches. If you will contribute patches, you need to generate them against an actual version of trunk. In this case check out from SVN to be able to rebase before generating patches. You can work with subversion or with git-svn.

::; Source release :
::* Browse to http://www.openoffice.org/download/other.html#tested-sdk and locate the table row that starts with "Source code"
::* Download source code in an archive format of your choice (note that tar.bz2 is typically smaller than tar.gz and zip)
::* Optional: Verify the archive
::** Browse to http://www.openoffice.org/download/checksums/3.4.1_checksums.html#checksums-sdk
::** Click on the "Source code" link or navigate manually to the "Source code" section.
::** Follow instructions for verifying your archive.
::* Unpack source (in cygwin-terminal). Use the file name exactly as downloaded.<pre>cd /tmp
tar -xjf <download-location>/aoo-3.4.1-incubating-src.tar.bz2
cd aoo-3.4.1/main
</pre>

::; Checkout from SVN using subversion :
::*Get subversion (only first time)<pre>apt-cyg install subversion</pre>
::*Start with creating a parent directory for the source code: <pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache SVN repository<pre>svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo-trunk
cd aoo-trunk/main</pre>

::; Checkout from SVN using git-svn :
::*Get git and git-svn (only first time)<pre>apt-cyg install git git-svn</pre>
::*Get the actual revision number from http://svn.apache.org/viewvc/OpenOffice/trunk/, e.g. 1234567
::*Create an empty directory and change to it, e.g.<pre>mkdir /cygdrive/c/source
cd /cygdrive/c/source</pre>
::*Check out source from Apache SVN repository<pre>git svn clone --revision 1234567:HEAD https://svn.apache.org/repos/asf/openoffice/trunk
cd trunk/main</pre>

* Remember the source path:<pre>SourceMain=`pwd`</pre> [Why? I have not used it. [[User:Regina|Regina]] ([[User talk:Regina|talk]]) 21:42, 24 February 2013 (UTC)]

* Optional: Get dbghelp.dll (for using the <code>--enable-dbgutil</code> configure option)
** This dll is part of MS Visual Studio.
** Copy file to <code>main/external/dbghelp</code>. Use Windows file manager or in cygwin terminal<pre>cp /cygdrive/c/Program\ Files\ $x86$/Microsoft\ Visual\ Studio\ 9.0/Common7/IDE/dbghelp.dll $SourceMain/external/dbghelp</pre>

* Copy vcredist_x86.exe and vcredist_x64.exe (see above) to main/external/vcredist.
** Use Windows file manager or in cygwin terminal<pre>cp <download-location>/vcredist_x86.exe $SourceMain/external/vcredist
cp <download-location>/vcredist_x64.exe $SourceMain/external/vcredist</pre>

* Get GDI+ redistributable.
**Browse to http://www.microsoft.com/en-us/download/details.aspx?id=18909
**Download WindowsXP-KB975337-x86-ENU.exe
**Run WindowsXP-KB975337-x86-ENU.exe
**Enter a temporary path (eg c:\temp\gdiplus) in the dialog and click OK to extract files
**Copy gdiplus.dll to main/external<pre>cp /cygdrive/c/temp/gdiplus/asms/10/msft/windows/gdiplus/gdiplus.dll $SourceMain/external/gdiplus/</pre>
** Remove the temporary path<pre>cp -fr /cygdrive/c/temp/gdiplus</pre>

* Get msvcr100.dll:<pre>cp /c/Windows/System32/msvcr100.dll $SourceMain/external/msvcp100</pre>

* Make sure that you are in the main source directory:<pre>cd $SourceMain</pre>

* Run autoconf to create the configure script:<pre>autoconf</pre>

* Call configure
** Run configure (adapt paths as necessary)<pre>MSVC_HOME="/cygdrive/c/Program Files (x86)/Microsoft Visual Studio 9.0"
SDK_PATH="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1"
./configure \
 --with-cl-home="$MSVC_HOME/VC" \
 --with-mspdb-path="$MSVC_HOME/Common7/IDE" \
 --with-asm-home="$MSVC_HOME/Bin" \
 --with-csc-path="$MSVC_HOME/SDK/v3.5" \
 --with-frame-home="$SDK_PATH" \
 --with-psdk-home="$SDK_PATH" \
 --with-midl-path="$SDK_PATH/bin" \
 --with-directx-home="C:/Program Files (x86)/Microsoft DirectX SDK (June 2010)" \
 --with-jdk-home="/cygdrive/c/Program Files (x86)/Java/jdk1.6.0_35" \
 --with-ant-home="/cygdrive/c/apache-ant-1.8.4" \
 --with-dmake-url="http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2" \
 --with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz \
 --enable-pch \
 --disable-atl \
 --disable-activex \
 --disable-binfilter \
 --without-junit</pre>If you have not installed the optional DirectX SDK then remove the <code>--with-directx-home switch</code>
*Finish configuration and download missing external source tarballs and extensions<pre>./bootstrap</pre>
* Include the configured environment<pre>source winenv.set.sh</pre>
* Build<pre>cd instsetoo_native/
build --all</pre>Depending on your computer this will take one or more hours to finish.

* Install There are three options:
*# Regular install with integration into Windows. This allows only one instance of AOO to be installed.
*#* Start setup.exe and click through dialog: <pre>$SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/msi/install/en-US/setup.exe</pre>
*#* Apache OpenOffice can be started via the Windows start menu.
*# Install without integration into Windows. This allows several instance of AOO, based on the same version, to be installed side by side. It still requires Administrator permissions.
*#* Start <code>setup.exe</code> with option <code>-a</code>: <pre>$SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/msi/install/en-US/setup.exe -a</pre>
*#* Enter an installation path into the dialog and click through the dialog to finish installation.
*#* Start AOO by running <pre><installation-path>/program/soffice.exe</pre>
*# Unpack archive without installation. This does not require Administrator permissions
*#* Go to installation directory: <pre>cd <installation-target></pre>
*#* Unzip archive: <pre>unzip $SourceMain/instsetoo_native/wntmsci12.pro/OpenOffice/archive/install/en-US/Apache_OpenOffice_incubating_3.5.0_Win_x86_install-arc_en-US.zip</pre>
*#* Start AOO by running: <pre>./Apache_OpenOffice_incubating_3.5.0_Win_x86_install-arc_en-US/program/soffice.exe</pre>

[[Category:Documentation]][[Category:Development]][[Category:Porting]]

Documentation/Building Guide AOO

2013-01-06T17:52:59Z

AlbinoNeto:

{{DISPLAYTITLE:Apache OpenOffice Building Guide}}

= Preface =
This guide will help you to build Apache OpenOffice from its source code. It details the prerequisites and explains how to download the source code, prepare and then run the build.

Here is the short version for the brave and impatient:
*Download the source: <code>svn co https://svn.apache.org/repos/asf/openoffice/trunk ooo</code>
*Configure: <code>cd main/ ; autoconf ; ./configure <some-switches> ; ./bootstrap</code>
*Build: <code>source <platform-dependend-name>.sh ; cd instsetoo_native ; build --all</code>
*Wait for an hour or more (here you have to be patient)
*Install office
*Enjoy

Operating system specific step-by-step instructions can be found [[Documentation/Building_Guide_AOO/Step_by_step|here]]. The detailed description below gives a broader introduction into the build process and explains for the various steps.

==Status==
This document is loosely based on an older [[Documentation/Building Guide|version]]. I have tried to avoid duplication and to move anything that all platforms have in common to this page. Many details have been removed on purpose because they refer to older version of OpenOffice. However, there are still some things not explained in the necessary detail on this page:
* How to use mozilla and nss.
* How to use ccache

{{Documentation/SeeAlso|*[[How_to_build_Symphony%27s_source_code]] }}

= Getting help =
You can get help by searching this wiki or by asking questions on the [http://openoffice.apache.org/mailing-lists.html#development-mailing-list-public developers mailing list].

You can help us improve this guide by pointing out any errors (preferably after finding a solution).
Or don't be shy and edit (and improve) these pages yourself.

= Basics =

In order to build Apache OpenOffice you need a proper environment. This includes
* a command line interpreter, typically bourne shell compatible (sh or bash) inside a terminal. On Windows you will need to install Cygwin to provide it.
* C++ compiler and linker. The exact choice depends on the operating system.
* Perl interpreter and several modules.
* Many tools from the Unix world like make or sed.

See section [[#General_Build_Requirements | General Build Requirements]]
for an exact list of requirements.

= Getting the source =

The source code is available as SVN repository at https://svn.apache.org/repos/asf/openoffice

Check it out with

svn co https://svn.apache.org/repos/asf/openoffice/trunk aoo

More details about how to check out source code from SVN can be found [http://openoffice.apache.org/source.html here].

The checked out files take up somewhat over 5GB on disk (more than 150000 files in more than 7000 folders and the SVN overhead).

After building this becomes (on Windows7) almost 17GB (more than 406000 files in more than 23000 folders).

= Organization of the source and output tree =

The source code has five top level directories:
;main/:contains most of the so called modules. Each module typically provides one or more libraries. The source code of the writer application for example can be found in main/sd/.
;test/:contains the new [[QA/test_automation_guide | automated testing framework]]
;ext_libraries/:is the new home of modules that build external libraries (libraries maintained outside of Apache OpenOffice and often outside Apache).
;ext_sources/:contains the tar balls (archives) of external libraries. They are included both for convenience and to make sure that specific versions remain available. Note that the source package of the Apache OpenOffice release does not contain any external tar balls.
;extras/:holds the localization data.

Most tools and scripts that are used for building are located below <code>main/solenv/</code>:
*dmake makefiles in <code>main/solenv/inc/</code>
*gmake makefiles in <code>main/solenv/gbuild/</code>
*executables and perl files in <code>main/solenv/bin/</code>
*perl modules in <code>main/bin/modules/</code>

Libraries and other output files that are shared between modules are stored in <code>main/solver/</code>.

=Building=

==Overview==

Building Apache OpenOffice consists of three steps:
;Configuring/bootstrapping:Detect platform, operating system, compiler, etc. and write the information into a shell script for later use. The developer can turn on or off certain features in this phase.
;Building:Compile the source code, transform other input files, apply localization.
;Packing:Create a set of files, the installation set, that can be installed on the respective operating system. This can be msi/cab files for windows, deb or rpm for Linux, dmg for Mac.

The configure step has to be carried out only once. Building and packing is necessary after every source code change. There are short cuts to avoid parts of these steps (when you know what you are doing.)

== General Build Requirements ==

The general requirements for all platforms are
{| class="prettytable"
|-
! Requirement
! Description
! How to install
|-
| Java JDK
| Java Implementation compatible with [http://java.sun.com/j2se/1.5/ JDK 1.5] or [http://java.sun.com/javase/6/ JDK 1.6]. [http://openjdk.java.net/ OpenJDK] is supported as well.
| --with-jdk-home=
|-
| Perl
| Perl 5. Also required are the perl packages
Archive::Zip
LWP::UserAgent
XML::Parser
They can be installed from the shell with (you may have to run it with super user/administrator rights)
perl -MCPAN -e shell
If it is executed for the first time then CPAN will ask for configuration. Choose autoconfiguration.
Eventually the CPAN shell appeares accepts commands. Install missing modules with
install <module-name>
Find more details [http://wiki.services.openoffice.org/wiki/CPAN_install here].6
|-
| CUPS
| cups headers. Provided by a cups-devel package or a libcups2-devel
|-
| PAM
| PAM support. Provided by a pam-devel package or a libpam-dev
|-
| Apache Ant
| [http://ant.apache.org/ Ant 1.7 or later]
| --with-ant-home=
|-
| Archiver
| zip and unzip
|-
| gperf
| [http://www.gnu.org/software/gperf/gperf.html gperf] tool
|-
| Mozilla1
| Some Mozilla libraries are needed. Choose one of the following:
* Get the source from [http://ftp.mozilla.org/pub/mozilla.org/mozilla/releases/mozilla1.7.5/source/ here].2
* Get prebuild libraries from [http://tools.openoffice.org/moz_prebuild/680/ here].3
|-
| NSS4
| Mozilla build tools5 are needed for Windows. They can be obtained [http://ftp.mozilla.org/pub/mozilla.org/mozilla/libraries/win32/MozillaBuildSetup-1.3.exe here].
|-
|}

'''Notes:'''
# If you are a new developer, don't use the libraries. By using the <tt>--disable-mozilla</tt> switch for ./configure you waive the extra functionality.
# Copy the package into <tt>main/moz/download</tt>. The ./configure script will detect the source being present.
# You have to configure with --disable-build-mozilla to enable the use of the prebuild libraries. Place LINUXGCCI{inc,lib,runtime}.zip into <tt>main/moz/zipped</tt>. The files can be reused if the packages were build following the instructions of the previous point. In the latter case they can be found in main/moz/unxlngi6.pro of a successful build.
# The nss module will be introduced in DEV300m57. nss contains a subset of libraries from Mozilla (the moz module). They are supposed to be more current then those in the moz module. To prevent building nss and instead use the libraries from the moz module one can use the configure switch <tt>--disable-nss-module</tt>. '''This switch will be removed soon!'''
# Use the configure switch <tt>--with-mozilla-build</tt> to tell configure where the tools are installed. For example: <tt>--with-mozilla-build=c:/mozilla-build</tt>
# Please note that CPAN is not able to deal with usernames containing spaces. To work around this fact, when CPAN asks you to specify the CPAN build and cache directory, change the default suggestion to /cpan.

See also the platform specific requirements for
*[[Documentation/Building_Guide_AOO/Building_on_Windows|Windows]]
*[[Documentation/Building_Guide_AOO/Building_on_Linux|Linux]]
*[[Documentation/Building_Guide_AOO/Building_on_MacOsX|MacOSX]]

==Configuration and bootstrapping==
This is typically done only once after the source code is checked out. Repeat this after changing your mind about options given to configure.

The call to
autoconf
creates the main/configure script from main/configure.in and some other input files.

The set of options/switches given to configure depends on the platform and your choice of features. A typical call starts like this
configure \
--with-dmake-url=http://dmake.apache-extras.org.codespot.com/files/dmake-4.12.tar.bz2 \
--with-epm-url=http://ftp.easysw.com/pub/epm/3.7/epm-3.7-source.tar.gz \
It tells configure where to find the source code of external tools dmake and epm.

By default only source code under [http://www.apache.org/legal/3party.html#category-a category A] licenses is compiled and included. Besides the Apache License 2.0 this includes for example BSD and MIT/X11 license. If you want to enable features that rely on third party code under [http://www.apache.org/legal/3party.html#category-b category B] licenses (like MPL, CPL, EPL, etc) then add the option
--enable-category-b

For inclusion of externaly hosted dictionary extensions add option
--enable-bundled-dictionaries
Note that
* some of the dictionaries are under (L)GPL license and are therefore
* bundled without modification. They are not compiled.
* Dictionaries rely on a category B third party library (hunspell). Therefore <code>--enable-category-b</code> is a prerequiste for <code>--enable-bundled-dictionaries</code>.

You can run the rat scan while building with option
--with-rat-scan
[[Documentation/Building_Guide_AOO/Rat_Scan|Here]] you can find details.

Finish this step by running
./bootstrap
This will build dmake and epm, download missing source code tar balls of external libraries, and download missing external dictionary extensions.

==Building==
Start by including the environment variables prepared by configure into your current environment with
source <shell-script-name>
where <shell-script-name> depends on your platform:
{| class="prettytable"
|-
!platform id
!<shell-script-name>
|-
| wntmsci12
| winenv.set.sh
|-
| unxlngi6
| LinuxX86Env.Set.sh
|-
| unxlngx6
| LinuxX86-64Env.Set.sh
|-
| unxmacxi
| MacOSXX86Env.Set.sh
|}
Look into main/set_soenv for more platforms. (search for lines <code>$OUTPATH = "<platform>";</code> and the nearby line <code>$outfile = "<shell-script-name>";</code>. Add the suffix <code>.sh</code> for the bash variant.

If you want to build the whole office and the install sets then
cd main/instsetoo_native
build --all
You may want to experiment with the -P options for multi process builds to reduce the build time.
build --all -P<m> -- -P<n>
tells build to use <code>m</code> processes (build up to <code>m</code> modules in parallel) and <code>n</code> threads for each module.

==Partial Builds==

Building the whole office takes a lot of time. Therefore it may be preferable to build only parts after making changes to the source code.
There are two different types of partial builds:
;Compatible:Can be used only when the code changes do not change exported interfaces. Use with care and only when you know what you are doing.
;Incompatible:Use for code changes that modify exported C++ or IDL interfaces, that modify resources that are used by other modules, or when you are not sure.

For the following sections you should be aware that Apache OpenOffice uses two different make systems to build its modules.
*The older one is based on dmake
*The other and newer one is based on GNU make. This system is often referred to as gbuild.
When a module contains, among others, a Makefile and a Module_<module>.mk file then it is a gbuild module.

===Compatible Build===

After changing code in module <module> which does not change any exported interfaces do
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build
deliver
|
cd <module>
make -sr
No explicit call to <code>deliver</code> is necessary for gbuild modules.
|}
to compile and deliver the resulting libraries to <code>main/solver/</code>. You may want to erase the output of a previous compilation:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build --from <module> --prepare
or faster (but without the un-deliver)
cd <module>
rm -fr <platform>/
|
cd <module>
make clean
|}

===Incompatible Build===

Modifications that change exported interfaces require not only the module to be rebuild that contains the modified code. All depending modules (dependencies are defined in <code><module>/prj/build.lst</code>) have to be rebuild as well. This is best done from <code>main/instsetoo_native/</code>:
cd main/instsetoo_native/
build --from <incompatible-module> --prepare
build --from <incompatible-module>
The second line removes the output of all modules that have to be recompiled. The drawback of this command is that the output of modules which are build via gbuild are not removed. Thus, the following additional command performed after the second one will do the trick:
build --from <incompatible-module> --job="make clean; make clean debug=t" --ignore

===Frequently used options===

In order to add debug information to libraries and executables, add the <code>debug</code> switch to any <code>build</code> or <code>make</code> command:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build debug=t
|
cd <module>
make -sr debug=t
|}
Remember that for the gbuild system you have to used the debug flag also when cleaning a module (otherwise eg the wrong precompiled headers are deleted and are not rebuilt):
make clean debug=t

You can force make to rebuild dependency information by first deleting it with the depend option. It is rebuild automatically with the next build:
{|class="prettytable"
|-
!dmake
!gbuild
|-
|
cd <module>
build depend=t
build
|
cd <module>
make -sr depend=t
make -sr
|}
[[Category:Documentation]][[Category:Development]][[Category:Porting]]

User:AlbinoNeto

2013-01-06T17:51:07Z

AlbinoNeto: /* Where do I work */

= Albino Biasutti Neto =

== Where do I live ==

[http://pt.wikipedia.org/wiki/Vila_Velha_(Esp%C3%ADrito_Santo) Vila Velha - Espírito Santo - Brazil]

== Where do I work ==

[http://blog.albino.ws Blog]

== Where do I contribute ==

* [[PT-BR|Brazilian community]]
* [[User_Experience|UX Team]]
* [[Documentation|Documentation]]