Documentation/Building Guide/Building on MacOSX

From Apache OpenOffice Wiki
Jump to: navigation, search

This document tries to wrap-up the build process for OpenOffice.org on Mac OS X using the native windowing-toolkit of the platform named Aqua.

Prerequisites

This document was derived from the description of the X11 build thanksworthy provided by Eric Hoch in this document: MacOSXBuildInstructions.

Here we would like to outline the things you need to build the Aqua Version (besides the OS).

Mandatory

Mac OS X version

=> Minimal version for AquaBuild is Mac OS X 10.4 (aka Tiger).

If you are building on Mac OS X 10.5 (aka Leopard), you will need to be aware of User:Dyrcona/LeopardBuild#flex.

Xcode

This is the only mandatory part to be installed to build Aqua version of OpenOffice.org.

Current verified working version is XCode 2.4.1. Older are deprecated.

Java

Aqua version of OpenOffice.org does not build yet using Java SDK 1.6.0.

Please use either J2SDK 1.4.2 or 1.5.0

To change the Java version -> go into folder : Applications -> Utilities -> Java and modify.


Else, you'll meet unfixed build breakers (patches are welcome anyway)

Note: If you are interested in helping us with Java 1.6 a patch which enables the build using java 1.6 is available here. e.g. several known build issues have to be fixed e.g. hsqldb, but probably other modules are concerned.

Be aware that it may impact important work and/or incompatibilities will occur. Feel free to submit your patches at mac@porting mailing list.

gperf

You need a build of [gperf] in your path for some modules.

Recommended

ccache

If you intend to build OpenOffice.org several times, you probably can benefit of ccache since it will speed up your future builds. The first time you make a build with ccache you won't notice it, but the next time the build will go up to five times faster.

You can install it using Fink. It is simply named "ccache". For MacPorts users the package is called "ccache".

If you don't use fink, you can download and build it yourself using the source provided at http://ccache.samba.org/

In order to use ccache you need to change the following environment variables assuming you're using bash, and just before doing configure command line: 

export CC="ccache gcc"
export CXX="ccache g++"

Get the source and prepare to build it...

The instructions below are for the current milestone "m33" of the master workspace "DEV300"

The source needs about 1.6GB, the full build needs about 6GB.
The directory name should not contain any spaces, otherwise building it might be troublesome.

Get the source from SVN

For milestones after m31

-> subversion ( aka svn ) is mandatory 

svn checkout svn://svn.services.openoffice.org/ooo/tags/DEV300_m33

Current known issue : parallel build is broken with DEV300_m33


OBSOLETE : Get the source from CVS ( milestones before DEV300m32 )

For previous milestones (means before m31) : cvs is mandatory

=> Prepare a directory for the source download 


mkdir DEV300_m30
cd DEV300_m30


export CVSROOT=":pserver:anoncvs@anoncvs.services.openoffice.org:/cvs"
cvs login
(password is 'anoncvs' )  + Enter

cvs -z3 co -r DEV300_m30 OpenOffice3 swext apache-commons tomcat hyphen  hunspell cppunit # don't forget the "3" !!

Note: swext, tomcat, etc. in the cvs checkout are needed to prevent breakages at buildtime

Additional dependencies for current milestone builds

prebuilt Mozilla archives

To enable the use of macros (disabled by default for security reasons), you'll have to put the prebuilt archives of mozilla binaries in moz/zipped directory after renaming them properly.

Note: archives are Intel only for now. UB will be proposed later

Archives to be downloaded :

http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIinc.zip

http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIlib.zip

http://eric.bachard.free.fr/mac/moz/seamonkey_Intel/MACOSXGCCIruntime.zip


IMPORTANT : if you want to build an old version of OpenOffice.org on Mac OS X (especially for SRC680 versions) ,

you MUST use these mozilla archives instead :

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBinc.zip

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBlib.zip

http://tools.openoffice.org/moz_prebuild/680/MACOSXGCCUBruntime.zip


If you want to build using them on PowerPC or Intel architecture (with Tiger) please rename them this way :

Archive Name in Intel architecture Name on PowerPC architecture
headers MACOSXGCCIinc.zip MACOSXGCCPinc.zip
runtime MACOSXGCCIruntime.zip MACOSXGCCPlib.zip
libs MACOSXGCCIlib.zip MACOSXGCCPlib.zip


As you can see, P means PowerPC, and I means Intel (replacing U or the UB (it depends on the builder) in the original name)

.. and put them into <ooo build directory>/DEV300_m28/moz/zipped Once done, you'll obtain milestone m28 from DEV300.

OpenOffice.org should detect and use them if you respect the configure command line as described in Milestone build.

One-Time preparations and scripts

OpenOffice.org's build environment is configured using the popular open-source configuration-management package 'autoconf'. So you can do your beloved './configure' command, but in our case this is done in the 'config_office' subdirectory. To save the configure parameters and use them with different milestones I used to link-in my shellscript to fire up the ./configure line.

My directory-structure looks like this: 

bin/
DEV300_m30/ 
DEV300_m18/
DEV300_m0/
SRC680_m248/
...

Now I go to the 'config_office' subdir and link in my startscript: 

cd DEV300_m30/config_office/
ln -s ../../bin/build.sh

And this is how 'build.sh' (to be written) looks like : 

#!/bin/sh
export BASE=`pwd|sed 's/\/config_office//'`
export OOVERSION=`echo $BASE|sed 's/^\/.*\///'`
echo Building from     : $BASE
echo OpenOffice Version: $OOVERSION
./configure \
--with-lang="en-US de fr" \
--disable-odk \
--disable-pasf \
--disable-gtk \
--disable-headless \
--disable-build-mozilla \
--with-build-version=$OOVERSION-`date +%d-%m-%y` \
--disable-fontconfig \
--without-nas \
--with-use-shell=bash \
--with-jdk-home=/System/Library/Frameworks/JavaVM.framework/Home \
--with-stlport=no \
--disable-mediawiki \
--enable-werror \ 
--disable-vba

Note :

--disable-vba since CWS sb87   (was building by chance only)

--disable-mediawiki because ant version requirement to build the swext is now 1.7.0

--disable-neon has been removed since m217   resync. See Issue 78206 --disable-neon breaks aqua build

--disable-odk : disables SDK build, and will avoid you to download some windows dll which is not needed for aqua-build.

--disable-pasf : pasf stands for Portable Audio System file. As we want to use system library rather than portable ones, we disabled this. However, at this time not all functionality will be available with pasf disabled. You might willing to use --with-pasf if you want working audio in your build.

--without-nas : nas stands for Network Audio System, it uses X11, if you want to use it in your build, just remove this flag. You will need to install the X11 package provided in your CDs/DVD Mac OS X installation. X11 SDK from xCode tools is not required for build this.

--disable-build-mozilla: will disable the mozilla build (in the moz module), but mozilla pre-built archives will be used instead (they are mandatory to enable the macro security configuration dialog (see Issue 79885 ).

--enable-dbgutil: add this option to enable assertions and other functionality useful for debugging

--with-jdk-home must be set as above with XCode 3.0

--with-stlport=no uses Apple's built-in STL, but will cause some warnings

We used the bash shell in all example, since to our belief users of the C-shell are smart enough to figure out the differences anyway. If you want to dig deeper into the build process, please have a look at the description OpenOffice.org's Build Environment.

Doing the build (about 4,5 GB)

Fine, now we have a (hopefully) working 'build.sh' in the config_office subdir. We need to run it beforehand: 

cd DEV300_m28/config_office/

./build.sh

This will setup the necessary includefiles and create a couple of files in the parent directory (bootstrap, MacOSXPPCEnv.Set.sh, MacOSXPPCEnv.Set). If you are using the sh, ksh or bash you only need to take care for 'MacOSXPPCEnv.Set.sh'.

Now we need to get back to our base-directory, run the bootstrap script, source our Enviroment (MacOSXPPCEnv.Set.sh) and finally start the build-process:

On Mac Intel

cd ..
./bootstrap
source MacOSXX86Env.Set.sh
cd instsetoo_native
export TMP=/tmp
export SYSTEM_OPENSSL=YES

+ 

build --all -P4 --dlv_switch -link --dontgraboutput

or

build --all -P4

if you run into trouble with --dlv_switch (see: Issue 77360 )

On PowerPC

cd ..
./bootstrap
source MacOSXPPCEnv.Set.sh
cd instsetoo_native
export TMP=/tmp
export SYSTEM_OPENSSL=YES

+ 

build --all -P2 --dlv_switch -link --dontgraboutput

or

build --all -P2
Comments on above

if you run into trouble with --dlv_switch (see: Issue 77360 )

The main purpose of the bootstrap script is to build (if necessary) the dmake utility used. Dmake once was a unix make-clone made by wticorp but got incorporated into OpenOffice since it was orphaned. For more information about dmake, it's history and manpage have a look here: http://tools.openoffice.org/dmake/index.html

Sourcing MacOSXPPCEnv.Set.sh is very important not only for building but also for running svdem later on. Here all the Environment-Variables for the Build will be set up. For a detailed description see Environment_Variables. Please note that on Intel machines, 'MacOSXPPCEnv.Set.sh' should be substituted with 'MacOSXX86Env.Set.sh'.

This Build process takes on my box (Dual 1.8 GHz G5, 1.5GB RAM) roughly 10 hours, and 3 to 6 hours on Mac Intel (3:30h on a 2GHz DualCore INTEL iMac). Be patient.

If you want to see how the progress on that build is you can use two build options to get a comfortable view: 

build ... <see above> ... --html --html_path /Users/$USER/Sites

where $USER is your user name. Then you can load in Firefox (not Safari!) the HTML file unxmacxi.pro.build.html via the in Mac OS X included Apache web server or diretctly form the directory /Users/$USER/Sites/. This file is automatically being updated and is showing the status of the build and also the time needed since the build started.

Installing, preparing and running OpenOffice.org

Find the Bundle

Once the build completed, the final product ( en-US version ) is named : OOo_3.0.0_*_MacOSXIntel_install.dmg ( for version 3.0beta e.g.)

And is located in instsetoo_native/unxmacxi.pro/OpenOffice/dmg/install/en-US directory ( replace en-US with your locale )

Bundle Location3.0beta.jpg

Install the new Build

  • double click on the *.dmg icon
  • drag the OpenOffice.org icon into a folder of your choice

Run the new Build

  • double click the application icon in that folder

Screenshots

Now you can start to work with this amazing productivity suite.

Contribute by finding, isolating, debugging or solving issues

Isolate a problem

Reduce a problem

  • make a problem reproducable
  • reduce it to a test case that is as small and simple as possible
  • if a problem is specific to a document then please attach it to the issue. A mininal excerpt of the document that still shows the problem is even better.
  • a screenshot of is a good idea if it clearly shows the problem

Using application switches

Application switches are often valuable for isolating a problem. Most of OpenOffice.org's options can be found its Tools->Options menu.

Some switches are so special that there is no user interface to change them. They are only useful for debugging and isolating a problem, but they are very valuable a that. So a developer might suggest to isolate a problem by setting an environment variable before running the application. E.g. for isolating problems with the menubar a developer might suggest to set the environment variable AQUA_NATIVE_MENUS to false. This is done by typing these commands into a terminal:

  • cd <INSTALL_DIR>/OpenOffice.org/Contents/MacOS
  • export AQUA_NATIVE_MENUS=false
  • ./soffice.bin

Provide a call stack for crash problems

Please note that bugs involving crashes should provide a description of how to reproduce the problem and a callstack. There are several ways to provide the callstack:

  • the preferred method is to use OOo"s builtin crash reporting tool
  • developers may provide a gdb backtrace of the problem
  • if the above two methods don"t work then please attach a file with the details provided by the AppleCrashReporter

Check against known issues

Check the list of open issues

Report a new issue

Report new issues after you have isolated the problem

Debug a problem

Debugging problems is often easier in an development environment:

Please note that XCode still has some problems with the executable named soffice.bin (because of the dot in the name). The issue has been reported to xcode-users list.

Current Work in progress (Aqua specific work only)

With OOO300 the Aqua port becomes a mainstream port, so most Aqua issues will be handled in regular GSL-Layer childworkspaces instead of dedicated Aqua CWSses. Other CWSses that are purely Aqua specific are being tracked below:

Child WorkSpaces in development

All patches that developers have that need testing or peer review should be added here.

Child WorkSpaces in testing (closed for development)

Concerned modules : extensions scp2

Child WorkSpaces waiting for integration

Child Workspaces integrated into OpenOffice.org's trunk

A historical overview of old Aqua specific ChildWorkspaces.

Known build issues

  • Tiger: no known issues
  • Leopard: no known issues

External links

Retrieved from "https://wiki.openoffice.org/w/index.php?title=Documentation/Building_Guide/Building_on_MacOSX&oldid=97254"
Personal tools