Building on Windows / Windows 環境でのビルド
Overview / 概要
This document explains how to build the OpenOffice.org source code on Windows systems.
ここでは、Windows 環境で、OpenOffice.orgのソースコードをビルドする方法を説明しています。 |
For building OpenOffice.org Cygwin is needed, a Windows program that emulates a complete Unix command line environment. To use this document you need to be familiar with a command line, but you need not to be a UNIX shell wizard.
OpenOffice.orgをビルドするには、Cygwin 環境が必要です。Cygwin 環境は、Unix のコマンドラインツールを完全にエミュレートしています。ここに書かれている内容を理解するには、コマンドラインツールになれている必要がありますが、Unix シェルに精通している必要はありません。
If you have never used a Unix shell, you might want to take a look at the shell introduction at TLDP.
Unix シェルを使いたい場合は、shell introduction at TLDP(英語)をご覧ください。 |
$SRC_ROOT will denote the directory in which the source code of OpenOffice.org is stored.
|
You are advised to check the release notes for the release you are building to inform yourself about changes since previous releases.
ビルドするリリースが、前回のリリースからどのように変更されているかは、リリースノートを参照してください。 |
Requirements / システム要件
hardware requirements / ハードウェア
- 1 or more reasonable fast CPUs (x-way CPU recommended)
- 1つ以上の高速なCPU(複数のCPUを推奨)
- 1 GB RAM (2 GB recommended)
- 1 GB のメモリ(2 GBを推奨)
- 10 GB free disk space (20 GB when debugging)
- 10 GB のハードディスク空き容量(デバッグ時には 20 GB)
software requirements / ソフトウェア
- Windows XP/Vista
- Windows XPまたはVista
The following table is placed here, so you can come back to it easily, when you want to use a link. The items are explained below. Here's the list of files to download (with links) and the locations in the source tree where you must put them:
下表は、リンクを辿ってファイルを取得したり、ここにすぐに戻れるようにするために作りました。ここに記載したファイルをダウンロードして、指定した場所に配置してください。
(訳注:「配置する場所」に「(標準)」と書かれているファイルは、アプリケーションです。各サイトの指示や画面の表示に従ってインストールしてください。また、「配置する場所」に「external/gdiplus」などと書かれている場合は、ダウンロードしたファイルを「$SRC_ROOT
\external\gdiplus」フォルダに解凍したり保存してください。)
Where to get / ダウンロード | Place in / 配置する場所 |
---|---|
Cygwin: Cygwin Toolkit with (dll version 1.5.10) or later | (default)
(標準) |
C/C++ Compiler: Visual C++ 2008 Express Compiler (basic install, no optional parts required)
C/C++ コンパイラ: Visual C++ 2008 Express Compiler (標準インストールのみ。オプションの製品は必要ありません) |
(default)
(標準) |
Java: JDK 1.6 for DEV300 milestones >= m37 and all OOo310 versions (older milestones will fail in the hsqldb module)
Java: JDK 1.6(訳注:Java SE Development Kit 6 (JDK 6)です。)OpenOffice.org DEV300 の m37 以降、OOo310 の全バージョンをビルドする場合に必要です。(それより古いソースコードでは、hsqldb モジュールのビルドに失敗します。) |
(default)
(標準) |
Windows SDK for Windows Server 2008⧼cite_reference_link⧽
Windows SDK for Windows Server 2008⧼cite_reference_link⧽ |
|
GDI+ Redistributable (Genuine Windows Validation required)
GDI+ Redistributable (使用している Windows が正規品かどうかを確認する必要があります) |
external/gdiplus
external/gdiplus |
Only for OOo2.x but due to Issue 88652 in configure still needed for 3.x: unicows.dll from (Microsoft Layer for Unicode)⧼cite_reference_link⧽
OOo2.x をビルドする場合にのみ必要なファイルですが、Issue 88652 にあるとおり、OOo3.x の configure 実行時に必要です: unicows.dll from (Microsoft Layer for Unicode)⧼cite_reference_link⧽ |
external/unicows
external/unicows |
dbghelp.dll⧼cite_reference_link⧽
dbghelp.dll⧼cite_reference_link⧽ |
external/dbghelp
external/dbghelp |
instmsiw.exe and instmsia.exe | external/msi
external/msi |
for 2005 compiler: msvcp80.dll and msvcr80.dll (found in c:\WINDOWS/WinSxS/x86_Microsoft.VC80.CRT_1fc8b3b9a1e18e3b_8.0.50727.42_x-ww_0de06acd/msvc
Visual C++ 2005 コンパイラを使用する場合: msvcp80.dll と msvcr80.dll(それぞれc:\WINDOWS/WinSxS/x86_Microsoft.VC80.CRT_1fc8b3b9a1e18e3b_8.0.50727.42_x-ww_0de06acd/msvc フォルダに保存されています) |
external/msvcp80
external/msvcp80 |
for 2008 compiler (until DEV300 m22): msvcp90.dll and msvcr90.dll (found in $(msvcdir)\Vc\redist\x86\Microsoft.VC90.CRT)
Visual C++ 2008 コンパイラを使用する場合(かつ、DEV300 m22以前のソースコードをビルドする場合): msvcp90.dll と msvcr90.dll(それぞれ(Visual C++ 2008 コンパイラのインストールフォルダ)\Vc\redist\x86\Microsoft.VC90.CRT フォルダに保存されています) |
external/msvcp90
external/msvcp90 |
for 2008 compiler starting with DEV300m23: Microsoft_VC90_CRT_x86.msm and policy_9_0_Microsoft_VC90_CRT_x86.msm for non debug builds and Microsoft_VC90_DebugCRT_x86.msm and policy_9_0_Microsoft_VC90_DebugCRT_x86.msm for debug builds⧼cite_reference_link⧽. These merge modules are available in VS08 Express Edition and VS08 Professional Edtion. All *.msm files are located at c:\Program Files\Common Files\Merge Module.
Visual C++ 2008 コンパイラを使用する場合(かつ、DEV300 m23以降のソースコードをビルドする場合): 通常のビルド用に、Microsoft_VC90_CRT_x86.msm と policy_9_0_Microsoft_VC90_CRT_x86.msm、デバッグビルド用に Microsoft_VC90_DebugCRT_x86.msm と policy_9_0_Microsoft_VC90_DebugCRT_x86.msm⧼cite_reference_link⧽. このファイルは、Visual C++ 2008 Express Edition と Professional Edition をインストールすると、C:\Program Files\Common Files\Merge Modules フォルダに保存されます。 |
external/msm90
external/msm90 |
Apache Ant (version 1.6.5 or later) | (default)
(標準) |
Mozilla binary distribution
(WNTMSCIruntime.zip,WNTMSCIlib.zip,WNTMSCIinc.zip) (WNTMSCIruntime.zip,WNTMSCIlib.zip,WNTMSCIinc.zip) |
moz/zipped
moz/zipped |
msvcr71.dll and msvcp71.dll for Mozilla libraries (Search for them in the Web or on your PC. These files should be named as all lower case. Sometimes when downloaded they are upper case and this will cause 'file not found' errors towards the end of the build))
Mozilla ライブラリ用に msvcr71.dll と msvcp71.dll(このファイルは、インターネットか、お使いのパソコンから探してください。なお、ファイル名はすべて小文字にしてください。ダウンロード時に大文字になっている場合があり、そのときはビルドの最後で 'file not found' エラーが発生することがあります。) |
external/msvcp71
external/msvcp71 |
optional: Nullsoft Scriptable Install System (NSIS)⧼cite_reference_link⧽
オプション: Nullsoft Scriptable Install System (NSIS)⧼cite_reference_link⧽ |
|
optional: Microsoft DirectX SDK⧼cite_reference_link⧽
オプション: Microsoft DirectX SDK⧼cite_reference_link⧽ |
adding required files to the build tree / ソースツリーをビルドする際に必要なファイルを追加するには
Installation and Preparation of Build Tools / ビルド用ツールのインストールと準備
setting up cygwin / cygwin の設定
Go to http://www.cygwin.com/ and download and install the current version.
http://www.cygwin.com/ にアクセスして、cygwin の最新バージョンをダウンロードし、インストールしてください。
Make sure that you keep the filetype set to “Unix/binary”.
インストールする際、“Default Text File Type”は、“Unix / binary (RECOMMENDED)”のままにしてください。 |
required additional packages / 必要な追加パッケージ
Cygwin consists of some basic and a lot of optional packages. As building OOo needs some of these optional packages you have to select them in the installer.
Cygwin には、いくつかの基本的なパッケージと、多数のオプションパッケージがあります。OOo をビルドするには、Cygwin のインストール時に、いくつかのオプションパッケージを選択します。
Here's a complete list of the needed packages:
必要なパッケージは以下の通りです:
- Category Archive:
- Category Archive:
- unzip
- unzip
- zip
- zip
- Category Devel :
- Category Devel :
- autoconf
- autoconf
- bison
- bison
- flex
- flex
- gcc-g++
- gcc-g++
- gperf
- gperf
- make
- make
- openssl-devel (only needed for perl modules for CWS tooling, see below)
- openssl-devel (CWS ツール用の perl モジュールにのみ必要です。下記参照)
- cvs (for 2.x code line and 3.0 code line)
- cvs (OOo 2.x 系と 3.0 系のビルドに必要です)
- subversion (for 3.x code line, minimum version 1.5.5)
- subversion (OOo 3.x 系のビルドに必要です。最低でも subversion 1.5.5 が必要です。)
- Category Libs
- Category Libs
- openssl
- openssl
- Category Net
- Category Net
- openssh
- openssh
- ncftp
- ncftp
- Category Perl
- Category Perl
- perl
- perl
- Category Shells
- Category Shells
- rxvt
- rxvt
- Category Utils
- Category Utils
- patch
- patch
- gnupg
- gnupg
- Category Web
- Category Web
- lynx
- lynx
- wget
- wget
Unfortunately the list of packages mentioned at http://website.openoffice.org/support/en/howtos/1.html#1 is incomplete, some more are listed at http://tools.openoffice.org/dev_docs/build_windows_tcsh.html#BuildRequirements .
残念なことに、http://website.openoffice.org/support/en/howtos/1.html#1 で説明しているように、この一覧は不完全です。http://tools.openoffice.org/dev_docs/build_windows_tcsh.html#BuildRequirements に追加のパッケージが記載されています。 |
breaking links to executables / 実行ファイルのリンクを切る
Within the Cygwin Toolkit, some executables might be symlinks: awk.exe and gunzip.exe, tar.exe (in older releases only). This can lead to a break of the build later, and the symlinks should be replaced by copies of the command they link to.
Cygwin Toolkit では、awk.exe、gunzip.exe(訳注:gunzip です)、tar.exe(古いリリースの場合のみ)は、シンボリックリンクになっているかもしれません。シンボリックリンクになっている場合はビルドが失敗するため、シンボリックリンクを実際のファイルに置き換える必要があります。
To check this, execute:
シンボリックリンクになっているか確認します。awk.exe がシンボリックリンクになっているかどうかを確認する場合は、Cygwin で次のコマンドを実行してください:
ls -l /bin/awk.exe ls -l /bin/awk.exe
whether e.g. awk.exe is a symlink. In version 1.5.24-2 awk.exe is a link to gawk.exe. The shell will show this by putting out “awk.exe -> gawk.exe”. In this case gawk.exe must be copied to awk.exe by executing:
バージョン 1.5.24-2 の awk.exe は、gawk.exe へのシンボリックリンクになっています。上記のコマンドを実行すると、“awk.exe -> gawk.exe”と表示されます。この場合、次のようにして gawk.exe を awk.exe としてコピーします。
cd /bin cd /bin rm awk.exe rm awk.exe cp gawk.exe awk.exe cp gawk.exe awk.exe
In case you overlook something here or you have a newer Cygwin version with additional symlinks not mentioned here it's not a problem. You will get a helpful error message about an existing link in the configuration step (configure) later. The message will tell you which link you have to remove and you can do it following the advice given above for the awk.exe/gawk.exe pair.
ここまでに何かを見落としていたり、新しい Cygwin になってシンボリックリンクになっているファイルが増えていたりしても、心配することはありません。configure ツールを使うときにシンボリックリンクが残っていたら、丁寧なメッセージが表示されます。そのメッセージを読めば、上記の awk.exe と gawk.exe のようにシンボリックリンクを切る方法がわかるようになっています。
installing additional perl modules in cygwin / cygwin で perl の追加モジュールをインストールする
As explained some perl modules must be installed with CPAN. The necessary command in the cygwin shell is
perl のモジュールをいくつか CPAN からインストールします。Cygwin の shell で次のコマンドを実行してください
perl -MCPAN -e shell perl -MCPAN -e shell
If this command is executed the first time CPAN will ask for configuration. Choose autoconfiguration.
はじめて CPAN を実行したときは、設定に関する質問が表示されます。自動設定(automatic configuration)を実行してください。
At the end the CPAN shell appeared and is ready to accept commands for installations. Each module is installed by typing install $MODULENAME
. The modules that must be installed are:
設定が終わると CPAN シェル(訳注:cpan[x])が表示され、インストール用のコマンドを入力できるようになります。以下のモジュールは、install (モジュール名)
と入力するとインストールされます。インストールするモジュールは次のとおりです:
- Archive::Zip
- Archive::Zip
- XML::Parser (though it seems that this is already installed; doesn't hurt to do it)
- XML::Parser (このモジュールはインストール済みのように見えますが、実行しても悪いことはありません)
- URI
- URI
- LWP::UserAgent
- LWP::UserAgent
- Crypt::SSLeay
- Crypt::SSLeay
- SOAP::Lite
- SOAP::Lite
CPAN will detect if a selected module depends on other modules and it will offer to download them also. As explained please just confirm this.
CPAN は、選択したモジュールに必要なそのほかのモジュールを見つけて、ダウンロードするように提案してくれます。この提案についても確認してください。
The last three modules are only needed if you want to use the cws tooling. These tools are necessary if you want to create and maintain your own Child Workspaces or if you want to build one of them. I recommend to install them anyway as sooner or later you want to work on a child workspace.
最後の3つのモジュールは、cws ツールを使用するときにのみ必要です。cws ツールは、Child Workspaces を作成したりメンテナンスするときや、Child Workspaces をビルドするときに必要です。最後の3つのモジュールは、child workspace の作業をするときにインストールすることをオススメします。 |
Full Builds / フルビルド
configure
Finally the configure
tool is used to create the environment. It checks that all software, hardware, and system requirements for the build are satisfied, and creates configuration files called winenv.set (for tcsh) and winenv.set.sh (for bash) that are used to set all necessary build environment variables. Before running configure, make sure that all needed programs are in the system path or start configure with the appropriate command line switches. If configure detects a problem it will stop and give you a useful hint how to fix it.
You will find the configure
script in $SRC_ROOT
. The resulting configuration files are created there too.
sample configure calls
./configure \ --disable-directx \ --with-cl-home="/cygdrive/d/develop/msvc/VC" \ --disable-activex \ --disable-atl \ --disable-build-mozilla \ --with-frame-home="/cygdrive/d/develop/MSDK/v6.1" \ --with-psdk-home="/cygdrive/d/develop/MSDK/v6.1" \ --with-midl-path="/cygdrive/d/develop/MSDK/v6.1/Bin" \ --with-asm-home="/cygdrive/d/develop/msvc/VC" \ --with-jdk-home="/cygdrive/d/develop/j2sdk1.4.2_11" \ --with-csc-path="/cygdrive/c/Windows/Microsoft.NET/Framework/v3.5" \ --with-ant-home=/ant
./configure --disable-build-mozilla --disable-activex --with-win32 --with-cl-home="/cygdrive/c/Program Files/Microsoft Visual Studio 9.0/VC" --with-midl-path="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin" --with-csc-path="/cygdrive/c/WINDOWS/Microsoft.NET/Framework/v3.5" --with-frame-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1" --with-asm-home="/cygdrive/c/Program Files/Microsoft Visual Studio 9.0/VC/Bin" --with-jdk-home="/cygdrive/c/j2sdk1.4.2_11" . --disable-directx --disable-epm --with-ant-home=/cygdrive/c/apache-ant-1.6.5 --with-psdk-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1"
(訳注:私のところでは以下のようになりました。
./configure --disable-nss-module --disable-build-mozilla --disable-activex --with-win32 \ --with-cl-home="/cygdrive/c/Program Files/Microsoft Visual Studio 9.0/VC" \ --with-midl-path="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1/Bin" \ --with-csc-path="/cygdrive/c/Windows/Microsoft.NET/Framework/v3.5" \ --with-frame-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1" \ --with-asm-home="/cygdrive/c/Program Files/Microsoft Visual Studio 9.0/VC/Bin" \ --with-jdk-home="/cygdrive/C/Program Files/Java/jdk1.6.0_17" \ --with-directx-home="/cygdrive/c/Program Files/Microsoft DirectX SDK (August 2007)" \ --disable-epm \ --with-ant-home=/cygdrive/d/apache-ant-1.7.1 \ --with-psdk-home="/cygdrive/c/Program Files/Microsoft SDKs/Windows/v6.1"
Apache Antのフォルダが少し違うかもしれませんが、だいたいこんな感じになると思います。)
configure settings tips
Paths to dependencies might be different for your installation. The pathes containing "msvc" and "msdk" should be self-explanatory. |
There are a number of options that you can use with the configure script. To display these options, type the following command:
./configure --help |
csc.exe comes from the c:\WINDOWS\Microsoft.NET\Framework\v1.1.4322 directory, you might need --with-csc-path .
|
If you fail to getting together a working installation of Cygwin, one possibility is to use a known-to-work combination of Cygwin packages, i.e. a direct copy of some other user's Cygwin tree. User:TorLillqvist has such a tree (from late 2006) zipped up at http://download.go-oo.org/tstnvl/tml/tml-cygwin.zip . Don't hesitate to ask for advice if necessary. |
bootstrap
After running configure you must create the dmake make utility that is needed for the build of OpenOffice.org. This done from the SRC_ROOT directory by calling
./bootstrap
setting the enviroment
When the configure script has been run successfully a file winenv.Set.sh
was created⧼cite_reference_link⧽. Do this:
source winenv.Set.sh
to set up the enviroment for the build.
starting the build
Build the software by typing the following in $SRC_ROOT
⧼cite_reference_link⧽:
dmake
The building procedure will take at least an hour (on a 3 GHz Quad-Core with 8GB RAM).
There are some special things in the way how OOo builds its modules. Every module has an “output” folder (with some subfolders for the different kinds of generated output) that is created the first time a build is done in the module. The name of this folder is “wntmsci10.pro” for builds with MSVC++2003, “wntmsci11.pro” for builds with MSVC++2005 and "wntmsci12.pro" for builds with MSVC++2008 (for the meaning of the "pro" extension see below). After a successful build of a module some of the generated files are copied to the output folder of the “solver” module by executing a tool called “deliver” (this is automatically called by build --all for each of the modules). Other modules will take these “delivered” files (header files, libraries etc.) to resolve their dependencies. The content of the solver module will also be used to pack the installation sets in the final step.
Using some not quite latest cygwin releases (1.5.18/1.5.19) can lead to tcsh freezing in places - the build will appear to hang. You can fix this by running ls /proc/$nnn/fd where $nnn is the number of the process. Or just run
ls /proc/*/fd to "unhang" the process. See Issue 51560 for more info... |
Partial Builds
There are two ways to do partial builds:
- compatible
- incompatible
Only do compatible partial builds if you know exactly what you are doing.
For more information, see Compatible Builds. |
rebuilding from a module (incompatible build)
If you decide to change a module in an incompatible way, you will need to rebuild all modules depending on it (directly or indirectly):
cd $SRC_ROOT/instsetoo_native build --from $INCOMPATIPLEMODULE --prepare build --from $INCOMPATIBLEMODULE
rebuilding a module (compatible build)
To rebuild a module you can delete all output directories with, rebuild and redeliver into the solver with:
cd $MODULE build --from $MODULE --prepare build && deliver
A simple build
in $SRC_ROOT/instsetoo_native
will recreate the installation sets, provided all other modules have already been build.⧼cite_reference_link⧽
Building a Module with Debug Information
To rebuild a module with debug information and additional assertions and checks, run:
cd $MODULE build --from $MODULE --prepare # removes old output trees and solver build debug=true --from $MODULE
Drop the newly created binaries into an existing installation. Building an installation set with them will not help, as binaries are stripped on packing by default.
For details, see Windows Debugging. |
Finding the Installation Sets
After a successful build you will find the OOo installation set in
instsetoo_native/wntmscixx.pro/OpenOffice/msi/Install/en-US
“instsetoo_native” is the module that packs the installation set.
If you already have a version of OOo installed you can install your freshly built version in parallel by installing it with setup /a that just unpacks all files without any system registration. |
Tips And Tricks
ccache
For Windows: download from here, do the following:
export CCACHE_DIR="some/place/with/space" ccache -M 2G -F 10000 export CCACHE_CPP2=TRUE export CXX="guw.pl ccache cl" # export USE_PCH= if you experience trouble with precompiled headers
dependencies
nodep
If you set the environment variable nodep
to TRUE
, then dependendy information files are not created - the build finishes faster.
But only enable that on a clean build. Once you have built OOo and then made modifications, unset the variable again to be on the safe side. |
NO_HIDS
Similar to the nodep
variable, this one prevents the generation of HIDs (Help IDs) that are mainly used for automated testing - if you only want to build OOo, you don't need those.
parallel builds
If you have a multiprocessor machine or similar, you can run a parallel build. There are two levels of parallelism - one operating on makefile (directory) level, the other one on the global level. The two levels of parallelism result from the two-step build procedure in the OOo build environment. The build script runs through all the directories it reads from the build.lst files in all modules and calls dmake for every directory.
parallelism on the global level
For parallelism on the global level, you have to run build from $SRC_ROOT>/instsetoo_native
with the -P<number>
switch, for example:
build -P2
This takes build how many dmake processes it is allowd to start in parallel.
parallelism on the directory level
export MAXPROCESS=<numer or processes>
This tells dmake how many targets it is allowed to build in parallel. When you don't use build.pl but build a single directory (single makefile), you can achieve the same with
dmake -P2
combining both levels
If you want to have parallelism on both levels, you can call
build -P2 -- -P2
"--" is a special build.pl parameter that passes every further parameters to the dmake processes it starts.
Recommendation
Experience tells that using the doubled number of cores in your machine is a good choice, using more threads does not make a big difference, except if the combined option is chosen. So even on single core machines using two threads will speed up the build considerably.
create prebuilt mozilla
For the mozilla-components you have the choice to either build from mozilla sources, to use precompiled packages or to use system-mozilla (the one installed on your buildsystem, not everything might work, depending on the version you got installed). You can easily create your own version of the prepacked binaries if you wish to do so (either because you cannot use the official ones because of mismatch of compiler version used to build them/other technical reasons or because you want to use stuff you didn't build yourself). To do so:
- build the
moz
module from the mozilla sources - use
--enable-build-mozilla
when running configure and put the mozilla-source tarball tomoz/download
- in
moz
rundmake zip
to create the zip files - you'll find the zips in
{platform}.pro/zipped
Copy them to a location of your liking.
Now instead of using --enable-build-mozilla
, use --disable-build-mozilla
and copy the zips you created or downloaded to moz/zipped
and these will be used when compiling.
This will greatly reduce build-time (you save the time that would otherwise be spent on compiling mozilla).
See Also
⧼cite_references_prefix⧽ ⧼cite_references_link_many⧽ ⧼cite_references_link_many⧽ ⧼cite_references_link_many⧽ ⧼cite_references_link_many⧽ ⧼cite_references_link_many⧽ ⧼cite_references_link_many⧽ ⧼cite_references_link_one⧽ ⧼cite_references_link_one⧽ ⧼cite_references_link_one⧽ ⧼cite_references_suffix⧽
Content on this page is licensed under the Public Documentation License (PDL). |