Difference between revisions of "Getting Started/Build/Windows/emerge"

Jump to: navigation, search
(Emerge works, now what?)
(Check out using the 'git' command: use /d switch for CD to also change the drive, if %KDEROOT% is not on C:)
(71 intermediate revisions by 10 users not shown)
Line 5: Line 5:
 
* it is easy for people to join us:
 
* it is easy for people to join us:
 
Before emerge it was quite some work to set a system up for development. There were some quirks, which were documented in some mailing lists, but you had to remember them or you ran into an already solved problem again, etc.
 
Before emerge it was quite some work to set a system up for development. There were some quirks, which were documented in some mailing lists, but you had to remember them or you ran into an already solved problem again, etc.
Now to get a development machine you need a Windows computer, need to install Python and Subversion and do the emerge checkout. Then execute emerge to build what you want to build. This is easy for developers coming from Windows to KDE, and also for KDE developers coming to Windows.
+
Now to get a development machine you need a Windows computer, need to install Python and Git and do the emerge checkout. Then execute emerge to build what you want to build. This is easy for developers coming from Windows to KDE, and also for KDE developers coming to Windows.
 
* it is easy for us to do (nightly/continuous/release/reproducable/...) builds:
 
* it is easy for us to do (nightly/continuous/release/reproducable/...) builds:
 
With emerge you can build the whole software stack (low-level libs, Qt, kdelibs, things above that) with only one command. You can start that build, and some hours later you can check if it worked, or if something broke. So we can spot problems easier and earlier. We can also start with a "naked" Windows computer without any other installed software and bootstrap kde on it. That ensures, that no hidden dependencies on some pieces of software sneak in, because then the builds on a "naked" computer would break and show the problem.
 
With emerge you can build the whole software stack (low-level libs, Qt, kdelibs, things above that) with only one command. You can start that build, and some hours later you can check if it worked, or if something broke. So we can spot problems easier and earlier. We can also start with a "naked" Windows computer without any other installed software and bootstrap kde on it. That ensures, that no hidden dependencies on some pieces of software sneak in, because then the builds on a "naked" computer would break and show the problem.
Line 18: Line 18:
  
 
=== Python interpreter ===
 
=== Python interpreter ===
<tt>emerge.bat</tt> invokes an <tt>emerge.py</tt> script written in [http://en.wikipedia.org/wiki/Python_%28programming_language%29 Python] programming language, so you first need to [http://www.python.org/download/ install the Python 2.6 Interpreter]. The ''python'' installation directory will be added to the PATH later by <tt>%KDEROOT%\etc\kdesettings.bat</tt> script.
+
<tt>emerge.bat</tt> invokes an <tt>emerge.py</tt> script written in [http://en.wikipedia.org/wiki/Python_%28programming_language%29 Python] programming language, so you first need to [http://www.python.org/download/ install the Python 3.2 Interpreter]. The ''python'' installation directory will be added to the PATH later by <tt>%KDEROOT%\etc\kdesettings.bat</tt> script.
 +
''Beginning from the KDE 4.8 (including master and the frameworks branch) Python 3.2 will be required.''
  
=== Subversion client ===
+
=== Git client ===
The latest source code for Windows ''emerge'' and the rest of KDE is stored in a repository created and managed using the [http://subversion.tigris.org/ Subversion] version control tool. You need a Subversion client for the first checkout. There are at least two applications:
+
The latest source code for Windows ''emerge'' and a lot of the rest of KDE is stored in a repository created and managed using the [http://git-scm.com/ Git] version control tool. You need a git client for the first checkout of emerge. There are at least two applications:
*a command line client, available at [http://subversion.tigris.org/servlets/ProjectDocumentList?folderID=91 subversion.tigris.org] '''(required by emerge to get the source code from KDE Subversion repository)''', aimed at developers or power users accustomed with the command line,
+
*a command line client, available at [http://code.google.com/p/msysgit/downloads/list?can=3 subversion.apache.org], aimed at developers or power users accustomed with the command line,
*GUI program like [http://tortoisesvn.tigris.org/ TortoiseSVN], optional, useful for displaying differences between various versions of files in the repository in a graphical way.
+
*a GUI program like [http://code.google.com/p/tortoisegit/ TortoiseGit], optional, useful for displaying differences between various versions of files in the repository in a graphical way.
  
Note 1: If you experience problems with the checkout of Qt (Subversion doesn't work correctly) please remove any other Subversion binaries out of the path that you do have. '''The different versions of the Apache portable runtime (APR) are incompatible!'''
+
Emerge uses its own git client for checking out all KDE source code. You can find it in %KDEROOT%\dev-utils\git\bin. It will be used by emerge even if you have another git executable installed.
  
Note 2: Make sure to use a copy of Subversion that was built on Windows so that checked-out files do not use UNIX line endings.  If you check out with UNIX line endings, the ''patch'' program will fail when attempting to apply a patch whose line endings don't match the system's.
+
=== Getting the ''emerge'' tool ===
 +
The source code of the ''emerge'' tool and the recipes for creating KDE packages are located at <tt>git://anongit.kde.org/emerge.git</tt>, which is an URL based on the git-specific ''git'' protocol.
  
=== Check out the ''emerge'' tool ===
+
You need to check out the source code from the ''emerge'' Subversion directory into a new directory below your root directory (the root directory is normally called %KDEROOT% here) or get it inside a self extracting archive (not tested yet).
The source code of the ''emerge'' tool and the recipes for creating KDE packages are located at <tt>svn://anonsvn.kde.org/home/kde/trunk/kdesupport/emerge</tt>, which is an URL based on Subversion-specific ''svn'' protocol.
+
  
You need to check out the source code from the ''emerge'' Subversion directory into a new directory, which in this example we will call %KDEROOT%.
+
==== Check out using the 'git' command ====
  
==== Check out using the 'svn' command ====
+
*Option 1: With the ''git'' command line tool, you can accomplish this with the following commands:<pre>cd /d %KDEROOT%</pre>
 +
**if you will only use anonymous (read-only) access to the KDE git repository:<pre>git clone git://anongit.kde.org/emerge.git</pre>
 +
**if the git and ssh ports are blocked, and only http is allowed, it is better to clone over the http port for getting (read-only) access to the KDE git repository:<pre>git clone http://anongit.kde.org/emerge.git</pre>
 +
**or, if you plan to use write access (commit) to the emerge repository using your existing account & OpenSSH private key: <pre>git clone git@git.kde.org:emerge.git</pre>
  
*Option 1: With the ''svn'' command line tool, you can accomplish this with the following commands:<pre>cd %KDEROOT%</pre>
+
=== Configure the ''emerge'' tool ===
**if you will only use anonymous (read-only) access to the KDE svn repository:<pre>svn co svn://anonsvn.kde.org/home/kde/trunk/kdesupport/emerge</pre>
+
# Create the directory <tt>%KDEROOT%\etc</tt>.
**or, if you plan to use write access (commit) to the KDE svn repository
+
# Copy the file <tt>%KDEROOT%\emerge\kdesettings-example.bat</tt> as <tt>%KDEROOT%\etc\kdesettings.bat</tt> and change its contents according to your needs. The options are described in the ''rem'' lines in the file itself.
***via https:<pre>svn co --username yourusername https://svn.kde.org/home/kde/trunk/kdesupport/emerge</pre>
+
***via a [[Getting_Started/Build/KDE4/Windows/subversion|puTTY tunnel]] using your existing account & OpenSSH private key: <pre>svn co svn+putty://svn.kde.org/home/kde/trunk/kdesupport/emerge</pre>
+
  
 +
The kdesettings.bat script will be called by the main kdeenv.bat script.
  
This would result with:
+
Note 0: '''Read the comments in that file very carefully'''
  
Error validating server certificate for '<nowiki>https://svn.kde.org:443</nowiki>':
+
Note 1: '''Be sure that you neither have the msys/bin nor the cygwin/bin in your path. If so you have to definitely remove it from the path.'''
  - The certificate is not issued by a trusted authority. Use the
+
    fingerprint to validate the certificate manually!
+
Certificate information:
+
  - Hostname: svn.kde.org
+
  - Valid: from Wed, 11 May 2005 09:08:21 GMT until Sat, 09 May 2015 09:08:21 GMT
+
  - Issuer: SVN, KDE e.V., Nuernberg, Bavaria, DE
+
  - Fingerprint: xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx:xx
+
(R)eject, accept (t)emporarily or accept (p)ermanently?
+
  
enter ''p'' here to permanently accept the certificate:
+
Note 2 '''from a user: The applications gimp, inkscape and graphviz are also a problem. To make sure that there's nothing wrong I stripped my path to contain only what I needed to build.'''
  
Authentication realm: <<nowiki>https://svn.kde.org:443</nowiki>> KDE SVN account
+
Note 3 '''from another user: be careful when renaming the file to "kdesettings.bat" it is easy to end up with "kdesettings.bat.bat" instead of what you want since Windows(by default) will not show the the file extension part of a file.'''
Password for 'yourusername': ***************
+
A    emerge\kdeenv.bat
+
A    emerge\portage
+
A    emerge\portage\kdesupport
+
[....]
+
  
The password and cache for the certificates is saved in <tt>%APPDATA%\Subversion\auth</tt> directory.
+
emerge has several branches which contain specific package versions. E.g. if you want to build the 4.8 branch of KDE (or one of the 4.8 releases) you should checkout the ''kde-4.8'' branch of emerge; in the ''master'' branch, you can find KDE ''master/trunk''. To view all branches, use the following command:
 +
<pre>git branch -a</pre>
 +
To change the branch of emerge, do the following:
 +
<pre>cd emerge && git checkout kde-4.8</pre>
  
==== Check out using the TortoiseSVN ====
+
=== [Optional, Advanced] emergehosts.conf ===
 +
Add a file emergehosts.conf in the <tt>%KDEROOT%\etc</tt> directory. The format of this file is a typical config file with only two entries per section:
 +
The first entry is the ''host'' as mentioned in the portage file for the package. The second entry is called ''replace'' and is the replace string for the host string.
  
*Option 2: If you use TortoiseSVN:
+
As an example, here is how to checkout all gitorious based repos of the kde-developers group using a push url instead of the anonymous access:
*#right-click on your %KDEROOT% folder and select ''SVN Checkout...'' command from the context menu,
+
<syntaxhighlight lang="text">
*#paste <tt>svn://anonsvn.kde.org/home/kde/trunk/kdesupport/emerge</tt> URL into the ''URL of repository'' text box (replace with <tt><nowiki>https://svn.kde.org/home/kde/trunk/kdesupport/emerge</nowiki></tt> for read-write access)
+
[qt gitorious]
*#add <tt>\emerge</tt> to the folder name in the ''Checkout directory'' box and click OK to continue
+
host: git://gitorious.org/+kde-developers/
*#if you picked the read-write access, you will be asked for accepting the SSL certificate of the SVN server (click "Premanent") and then for username and password. For convenience select "Save authentication" checkbox too (the password and cache for the certificates will be saved in <tt>%APPDATA%\Subversion\auth</tt> directory).
+
replace: git@gitorious.org:+kde-developers/
 +
</syntaxhighlight>
  
After the checkout you should have the directory <tt>%KDEROOT%\emerge</tt>. If you don't, you move your ''emerge'' directory to that location.
+
As a second example here is how to checkout with a ssh user from a subversion repository:
 +
<syntaxhighlight lang="text">
 +
[svn.example.com]
 +
host: svn://svn.example.com/
 +
replace: svn+ssh://user@svn.example.com/
 +
</syntaxhighlight>
  
=== Configure the ''emerge'' tool ===
+
The name of the section doesn't matter and can be used for descriptions.
# Create the directory <tt>%KDEROOT%\etc</tt>.
+
# Copy the file <tt>%KDEROOT%\emerge\kdesettings-example.bat</tt> as <tt>%KDEROOT%\etc\kdesettings.bat</tt> and change its contents according to your needs. The options are described in the ''rem'' lines in the file itself.
+
  
The kdesettings.bat script will be called by the main kdeenv.bat script.
+
=== [Optional, Advanced] emerge-boost-config.jam ===
 +
Add a file emerge-boost-config.jam in the <tt>%KDEROOT%\etc</tt> directory to build boost in a specific way. The only current use case is for the following problem:
 +
If you build 32bit binaries with emerge on a 64bit system you need to link boost-python against a 32bit python library. In case your standard python installation is 64bit though, you can specify the python installation in the following way:
 +
<syntaxhighlight lang="text">
 +
# ---------------------
 +
# Python configuration.
 +
# ---------------------
  
Note 1: '''Be sure that you neither have the msys/bin nor the cygwin/bin in your path. If so you have to definitely remove it.'''
+
# Configure specific Python version.
 +
using python : 3.2 : C:\\Python32_x86 ;
 +
</syntaxhighlight>
 +
This way boost-python would be using the headers & libraries from C:\\Python32_x86 instead of the default one.
 +
Please remember that for mingw compilers you must regenerate the import library for the python dll (also for the mingw 64bit compiler):
 +
<syntaxhighlight lang="text">
 +
R:\> emerge pexports
 +
R:\> pexports C:\Python32_x86\python32.dll > C:\Python32_x86\libs\python32.def
 +
</syntaxhighlight>
 +
NOTE: In case you generate the import library for the 64bit compiler, add the following line to the file python32.def:
 +
<syntaxhighlight lang="text">
 +
Py_InitModule4 = Py_InitModule4_64
 +
</syntaxhighlight>
 +
For both compilers you should now run:
 +
<syntaxhighlight lang="text">
 +
dlltool -d C:\Python32_x86\libs\python32.def -l C:\Python32_x86\libs\libpython32.dll.a
 +
</syntaxhighlight>
 +
Now you should be able to do emerge -i boost-python-src without errors.
  
Note 2 from a user: The applications gimp, inkscape and graphviz are also a problem. To make sure that there's nothing wrong I stripped my path to contain only what I needed to build.
+
== Using emerge ==
 
+
Note 3(from another user): be careful when renaming the file to "kdesettings.bat" it is easy to end up with "kdesettings.bat.bat" instead of what you want since Windows(by default) will not show the the file extension part of a file. 
+
 
+
I am getting the following error even though subversion is installed:
+
emerge fatal error: required subversion package not installed
+
 
+
== Running emerge ==
+
  
 
To use emerge you need to start a console window and point that to <tt>%KDEROOT%\emerge</tt>. For example:
 
To use emerge you need to start a console window and point that to <tt>%KDEROOT%\emerge</tt>. For example:
Line 109: Line 124:
 
  KDECOMPILER : mingw
 
  KDECOMPILER : mingw
 
  KDESVNDIR  : C:\kderoot\svn
 
  KDESVNDIR  : C:\kderoot\svn
  PYTHONPATH  : C:\python25
+
  PYTHONPATH  : C:\python32
 
  DOWNLOADDIR : C:\kderoot\download
 
  DOWNLOADDIR : C:\kderoot\download
  
 
  C:\kderoot\emerge>
 
  C:\kderoot\emerge>
 +
 +
Next, if you have configured your kdesettings.bat to use svn+ssh for your subversion checkout, then you need to run:
 +
 +
<syntaxhighlight lang="text">plink <your-svn-username>@svn.kde.org
 +
plink <your-kde-username>@git.kde.org</syntaxhighlight>
 +
 +
This will prompt you to accept the fingerprint of the server, otherwise svn will hang forever when trying to download from the server.
  
 
Now you should be able to use emerge. Type
 
Now you should be able to use emerge. Type
Line 131: Line 153:
  
 
=== Install the MinGW compiler with emerge ===
 
=== Install the MinGW compiler with emerge ===
Let emerge install the MinGW compiler:
+
Let emerge install the MinGW compiler, as soon as emerge needs MinGW it will automatically fetch the correct version for you.
 
+
To install the MinGW ("Minimalist GNU for Windows") compiler with emerge, type
+
emerge mingw4
+
and wait until it is finished.
+
 
+
If you encounter an error like
+
Assertion failed: hunk, file ../patch-2.5.9-src/patch.c, line 354
+
try to edit line 51 of file <tt>mingw-x.y.z.py</tt> (<tt>%KDEROOT%\emerge\portage\dev-util\mingw</tt>) by adding the <tt>--binary</tt> after <tt>-p1</tt> parameter. The line should then look like this:
+
cmd = "cd %s && patch -p1 --binary < %s" % \
+
This is probably because the different line break types (Linux vs Dos) in the files and the bug in patch.exe. Althought this is an ugly hack and should be fixed somewhere else, it works for the current versions of patch (2.5.9) and mingw (3.4.5).
+
 
+
If you encounter an error like:
+
  IOError: [Errno 2] No such file or directory: 'c:\\kderoot\\bin\\mingwm10.dll'
+
Then try creating the c:\kderoot\bin directory first.
+
  
 
=== Install MS Visual C++ ===
 
=== Install MS Visual C++ ===
 
Read [[../MS_Visual_Studio#The_Compiler|here]].
 
Read [[../MS_Visual_Studio#The_Compiler|here]].
  
=== Point to an existing MinGW installation ===
 
* Point emerge to an existing MinGW installation:
 
  
'''This option is not recommended for now''', because it only adds one more point of failure, and does not gain something in comparison to the option above.<br/>NOTE from a user: be sure that path to \mingw\bin has been set correctly, by default it is pointing to: %KDEROOT%\mingw\bin which does not apply to most installations. If you see an error about <tt>cc1plus</tt> not being found, either add MinGW's <tt>\libexec\gcc\mingw32\3.4.5</tt> to your ''PATH'' (in command line <tt>set PATH=%PATH%;path\to\directory</tt>) variable or copy the contents of this directory to MinGW's <tt>bin</tt> directory.  The prior is preferred.<br/><br/>Under Vista, the mingw directory may need to be moved to c:\ in order to compile properly.
 
  
 
=== Point to an existing MS Visual C++ installation ===
 
=== Point to an existing MS Visual C++ installation ===
You need to point emerge to an existing msvc installation. To do that, execute vcvarsall.bat before running <tt>%KDEROOT%\emerge\kdeenv.bat</tt>. In recent versions this is run automatically for you from kdeenv.bat if configured properly in kdesettings.bat. Check your kdesettings.bat file to know if you need to run this manually or not.
+
You need to point emerge to an existing msvc installation. This is run automatically for you from kdeenv.bat if configured properly in kdesettings.bat. Check your kdesettings.bat file to know where to set it.
 
+
Notes related to Vista:
+
*Note that for debug builds MS Visual Studio 2005 Service Pack 1 is required due to the use of manifest files and using pre-built packages for some dependecies.
+
*Notes related to Vista: If you open the command prompt under Vista by right clicking and running as administrator, you don't get the UAC issues with Vista trying to unsuccesfully run patch as an installer in a seperate environment. You may want run Visual Studio with administrative rights anyway under Vista, as this is recommended by Microsoft (perhaps Visual Studio 2008 would not force you to do that...).
+
  
== Emerge works, now what? ==
+
== Installing the base system ==
 
Once you have emerge and a compiler installed and working, try:
 
Once you have emerge and a compiler installed and working, try:
* ''emerge --help'' for a list of available commands
+
* <tt>emerge --help</tt> for a list of available commands
* ''emerge --print-installable'' to get a list of available packages
+
* <tt>emerge --print-installable</tt> to get a list of available packages
* ''emerge --print-installed'' to get a list of currently installed packages
+
* <tt>emerge --print-installed</tt> to get a list of currently installed packages
 +
Further options are described below.
  
You are now ready to start building KDE, it is recommended to do so preogessively, relying on emerge to automatically resolve the required dependencies at each set step:
+
You are now ready to start building KDE, it is recommended to do so progressively, relying on emerge to automatically resolve the required dependencies at each set step:
  
* Enter ''emerge qt''.  This will fetch and install Windows versions of numerous UNIX-like utilities and libraries, then checkout, compile and install Qt.  This will take several hours.
+
* Enter <tt>emerge qt</tt>.  This will fetch and install Windows versions of numerous UNIX-like utilities and libraries, then checkout, compile and install Qt.  This will take several hours.
* Enter ''emerge kdelibs''.  This will checkout, compile and install the required kdesupport modules and then kdelibs.
+
* Enter <tt>emerge kdelibs</tt>.  This will checkout, compile and install the required kdesupport modules and then kdelibs.
* Enter ''emerge kdebase-apps''. This will checkout, compile and install kdebase-runtime, and kdebase-apps
+
* Enter <tt>emerge kde-baseapps</tt>. This will checkout, compile and install kdebase-runtime, and kdebase-apps.
  
You will know have successfully installed a base KDE system and can now install other KDE modules as required.
+
You will now have successfully installed a base KDE system and can now install other KDE modules as required.
  
Note that this will install the trunk version of KDE, if you wish to install a particular stable branch then you must prefix the KDE package names with the required version, i.e. ''emerge kde-4.5/kdelibs''.  You can force emerge to always default to a given branch by setting the set EMERGE_DEFAULTCATEGORY varibale in your kdesettings.bat file.  You should not mix kde packages from different branches.
+
Note that this will install the development version of KDE (trunk in svn repositories, master in git repositories), if you wish to install a particular stable branch then you should change the branch of emerge to the specific branch of that release. '''NOTE:''' You should not mix kde packages from different branches.
  
It is strongly recommened you do not choose to manually install any of the utilities and libraries yourself, as you may install the wrong version and cause installation failures.  Instead allow emerge to resolve the dependencies for you.
+
It is strongly recommended you do not choose to manually install any of the utilities and libraries yourself, as you may install the wrong version and cause installation failures.  Instead allow emerge to resolve the dependencies for you.
  
Every time you want to update or install a packake, you should first update your emerge checkout to ensure you are using the latest package recipies.
+
Every time you want to update or install a package, you should first update your emerge checkout (simply run emerge --update emerge) to ensure you are using the latest package recipies.
  
 
== What emerge does ==
 
== What emerge does ==
'''emerge ''package'' ''' performs the separate actions <tt>--fetch</tt>, <tt>--unpack</tt>, <tt>--compile</tt>, <tt>--install</tt>, <tt>--manifest</tt>, and <tt>--qmerge</tt>.
+
'''emerge ''packageName'' ''' performs the separate actions <tt>--fetch</tt>, <tt>--unpack</tt>, <tt>--compile</tt>, <tt>--install</tt>, and <tt>--qmerge</tt>.
 +
 
 +
The <tt>--fetch</tt> action will retrieve either a binary or the source code for the package:
 +
* If a binary package, this will be downloaded into the <tt>DOWNLOADDIR</tt> defined in your <tt>kdesettings.bat</tt>, which is usually <tt>%KDEROOT%\download</tt>.
 +
* If a non-KDE source package, the source repository will be checked-out into <tt>%DOWNLOADDIR%\svn-src</tt>, e.g. Qt source may be found in <tt>C:\kderoot\download\svn-src\qt</tt>.
 +
* If a KDE source package from the <tt>svn.kde.org</tt> repository, then the source will be checked-out into the <tt>KDESVNDIR</tt> defined in your <tt>kdesettings.bat</tt>, which is usually <tt>%KDEROOT%\svn</tt>.
  
 
== ''emerge'' command line options and settings ==
 
== ''emerge'' command line options and settings ==
Line 198: Line 205:
 
|width="5%"|
 
|width="5%"|
 
|This option sets the verbosity level. Currently the highest verbosity level is 3 (<tt>-v -v -v</tt>). A verbosity level of 0 should give no output and equals to <tt>-q</tt>. You can set <tt>EMERGE_VERBOSE=3</tt> instead in the environment of the commandline or within your <tt>kdesettings.bat</tt> file.
 
|This option sets the verbosity level. Currently the highest verbosity level is 3 (<tt>-v -v -v</tt>). A verbosity level of 0 should give no output and equals to <tt>-q</tt>. You can set <tt>EMERGE_VERBOSE=3</tt> instead in the environment of the commandline or within your <tt>kdesettings.bat</tt> file.
|-valign="top"
 
|<tt>--nocopy</tt>
 
|<tt>EMERGE_NOCOPY</tt>
 
|
 
|This very useful option suppresses copying the sources from the local Subversion tree to a directory within the build directory. It shouldn't be used while packaging; in the other cases it reduces the amount of harddisk used though and removes the copying time. You can set <tt>EMERGE_NOCOPY=True</tt> or <tt>=False</tt> instead.
 
 
|-valign="top"
 
|-valign="top"
 
|<tt>--offline</tt>
 
|<tt>--offline</tt>
Line 214: Line 216:
 
|This option enables or disables KDE4 buildtests for KDE modules. Other packages will not change. Use <tt>EMERGE_BUILDTESTS=True</tt> or <tt>=False</tt>.
 
|This option enables or disables KDE4 buildtests for KDE modules. Other packages will not change. Use <tt>EMERGE_BUILDTESTS=True</tt> or <tt>=False</tt>.
 
|-valign="top"
 
|-valign="top"
|<tt>--buildtype=</tt>
+
|<tt>--print-targets</tt>
|<tt>Debug</tt>
+
 
|
 
|
|This option enables full debugging mode for the build. '''Recommended if you plan to debug the runtime or provide more valuable feedback to developers about software defects.''' You can also change the 'set EMERGE_BUILDTYPE=RelWithDebInfo' line in the <tt>kdesettings.bat</tt> file.
+
|
 +
|This option will display all "targets" a certain package has. Normally targets are fixed releases or different branches. They are defined in the portage file.
 +
|-valign="top"
 +
|<tt>--target=TARGET</tt>
 +
|
 +
|
 +
|This sets a specific target for this package. If not added, the default target is used, which can be checked by looking at the output of '''--print-targets'''.
 +
|-valign="top"
 +
|<tt>-i</tt>
 +
|
 +
|
 +
|This option ignores that a package is already installed. It builds it completely new, but keeps the dependencies.
 +
|-valign="top"
 +
|<tt>--update</tt>
 +
|
 +
|
 +
|This option ignores that a package is already installed but doesn't cleanup an already existing build directory. Thus you will only rebuild files that have changed since the last build.
 
|}
 
|}
  
 
== Hints ==
 
== Hints ==
===Updating packages===
+
=== Updating packages ===
*Once you have ''packagename'' built, type <code>emerge --unmerge packagename --noclean --target=svnHEAD packagename</code> to update <tt>packagename</tt> from the Subversion and compile it without removing the build dir.
+
*Once you have ''packagename'' built, type <syntaxhighlight lang="text">emerge --update packagename</syntaxhighlight> to update <tt>packagename</tt> from the Subversion and compile it without removing the build dir or <syntaxhighlight lang="text">emerge --update-all</syntaxhighlight> to update all packages that can be rebuild (they are rebuild with --update).
  
===Altering locale and country settings===
+
=== General setup ===
*To change locale for all users within the KDE environment, edit KDEROOT/share/config/kdeglobals file and add:
+
For Fine Tuning see here:
<code>
+
[[Projects/KDE_on_Windows/Installation#Fine-tuning|Fine-tuning]]
[Locale]
+
Country=**
+
Language=**
+
</code>
+
Replace ** with your lowercase [http://en.wikipedia.org/wiki/ISO_3166-1_alpha-2 alpha-2 country code], e.g. pl for Poland. You can edit your $HOME/.kde/share/config/kdeglobals file instead to alter your local settings, not for all users.
+
  
 
== Notes ==
 
== Notes ==
Line 243: Line 255:
  
 
Windows ''emerge'' is derived from the Gentoo portage system, but we are currently not enforcing compatibility. If you have questions about that please contact us at the channel #kde-windows on irc.freenode.net.
 
Windows ''emerge'' is derived from the Gentoo portage system, but we are currently not enforcing compatibility. If you have questions about that please contact us at the channel #kde-windows on irc.freenode.net.
 +
 +
last reviewed by [[User:SaroEngels|SaroEngels]] 22:52, 26th July 2011 (UTC)
  
 
==Vista issues==
 
==Vista issues==

Revision as of 23:28, 5 October 2012

emerge is a tool to build the KDE sources and its third-party requirements on MS Windows. It is the easy way to build KDE on MS Windows.

Contents

Introduction

Emerge is a tool that can build the different parts of KDE and its dependencies under Windows. We created this tool to automate and simplify the build process under Windows. We try to build all packages that we offer in the KDE installer with emerge. That has some advantages for us:

  • it is easy for people to join us:

Before emerge it was quite some work to set a system up for development. There were some quirks, which were documented in some mailing lists, but you had to remember them or you ran into an already solved problem again, etc. Now to get a development machine you need a Windows computer, need to install Python and Git and do the emerge checkout. Then execute emerge to build what you want to build. This is easy for developers coming from Windows to KDE, and also for KDE developers coming to Windows.

  • it is easy for us to do (nightly/continuous/release/reproducable/...) builds:

With emerge you can build the whole software stack (low-level libs, Qt, kdelibs, things above that) with only one command. You can start that build, and some hours later you can check if it worked, or if something broke. So we can spot problems easier and earlier. We can also start with a "naked" Windows computer without any other installed software and bootstrap kde on it. That ensures, that no hidden dependencies on some pieces of software sneak in, because then the builds on a "naked" computer would break and show the problem.

  • it is easier to collaborate:

We can test the same emerge build description for a package on different Windows versions/computers before we do binary releases. People can also add build descriptions for new packages to the Subversion repository.

This emerge tool was inspired by the Gentoo emerge tool.

Set up the environment

Root directory

Create a directory if possible in your harddrive's root e.g. C:\kderoot or D:\kderoot (You will need this PATH later). This directory will contain the whole kde installation later. We will refer to it as %KDEROOT%.

Python interpreter

emerge.bat invokes an emerge.py script written in Python programming language, so you first need to install the Python 3.2 Interpreter. The python installation directory will be added to the PATH later by %KDEROOT%\etc\kdesettings.bat script. Beginning from the KDE 4.8 (including master and the frameworks branch) Python 3.2 will be required.

Git client

The latest source code for Windows emerge and a lot of the rest of KDE is stored in a repository created and managed using the Git version control tool. You need a git client for the first checkout of emerge. There are at least two applications:

  • a command line client, available at subversion.apache.org, aimed at developers or power users accustomed with the command line,
  • a GUI program like TortoiseGit, optional, useful for displaying differences between various versions of files in the repository in a graphical way.

Emerge uses its own git client for checking out all KDE source code. You can find it in %KDEROOT%\dev-utils\git\bin. It will be used by emerge even if you have another git executable installed.

Getting the emerge tool

The source code of the emerge tool and the recipes for creating KDE packages are located at git://anongit.kde.org/emerge.git, which is an URL based on the git-specific git protocol.

You need to check out the source code from the emerge Subversion directory into a new directory below your root directory (the root directory is normally called %KDEROOT% here) or get it inside a self extracting archive (not tested yet).

Check out using the 'git' command

  • Option 1: With the git command line tool, you can accomplish this with the following commands:
    cd /d %KDEROOT%
    • if you will only use anonymous (read-only) access to the KDE git repository:
      git clone git://anongit.kde.org/emerge.git
    • if the git and ssh ports are blocked, and only http is allowed, it is better to clone over the http port for getting (read-only) access to the KDE git repository:
      git clone http://anongit.kde.org/emerge.git
    • or, if you plan to use write access (commit) to the emerge repository using your existing account & OpenSSH private key:
      git clone git@git.kde.org:emerge.git

Configure the emerge tool

  1. Create the directory %KDEROOT%\etc.
  2. Copy the file %KDEROOT%\emerge\kdesettings-example.bat as %KDEROOT%\etc\kdesettings.bat and change its contents according to your needs. The options are described in the rem lines in the file itself.

The kdesettings.bat script will be called by the main kdeenv.bat script.

Note 0: Read the comments in that file very carefully

Note 1: Be sure that you neither have the msys/bin nor the cygwin/bin in your path. If so you have to definitely remove it from the path.

Note 2 from a user: The applications gimp, inkscape and graphviz are also a problem. To make sure that there's nothing wrong I stripped my path to contain only what I needed to build.

Note 3 from another user: be careful when renaming the file to "kdesettings.bat" it is easy to end up with "kdesettings.bat.bat" instead of what you want since Windows(by default) will not show the the file extension part of a file.

emerge has several branches which contain specific package versions. E.g. if you want to build the 4.8 branch of KDE (or one of the 4.8 releases) you should checkout the kde-4.8 branch of emerge; in the master branch, you can find KDE master/trunk. To view all branches, use the following command:

git branch -a

To change the branch of emerge, do the following:

cd emerge && git checkout kde-4.8

[Optional, Advanced] emergehosts.conf

Add a file emergehosts.conf in the %KDEROOT%\etc directory. The format of this file is a typical config file with only two entries per section: The first entry is the host as mentioned in the portage file for the package. The second entry is called replace and is the replace string for the host string.

As an example, here is how to checkout all gitorious based repos of the kde-developers group using a push url instead of the anonymous access:

[qt gitorious]
host: git://gitorious.org/+kde-developers/
replace: git@gitorious.org:+kde-developers/

As a second example here is how to checkout with a ssh user from a subversion repository:

[svn.example.com]
host: svn://svn.example.com/
replace: svn+ssh://user@svn.example.com/

The name of the section doesn't matter and can be used for descriptions.

[Optional, Advanced] emerge-boost-config.jam

Add a file emerge-boost-config.jam in the %KDEROOT%\etc directory to build boost in a specific way. The only current use case is for the following problem: If you build 32bit binaries with emerge on a 64bit system you need to link boost-python against a 32bit python library. In case your standard python installation is 64bit though, you can specify the python installation in the following way:

# ---------------------
# Python configuration.
# ---------------------
 
# Configure specific Python version.
using python : 3.2 : C:\\Python32_x86 ;

This way boost-python would be using the headers & libraries from C:\\Python32_x86 instead of the default one. Please remember that for mingw compilers you must regenerate the import library for the python dll (also for the mingw 64bit compiler):

R:\> emerge pexports
R:\> pexports C:\Python32_x86\python32.dll > C:\Python32_x86\libs\python32.def

NOTE: In case you generate the import library for the 64bit compiler, add the following line to the file python32.def:

Py_InitModule4 = Py_InitModule4_64

For both compilers you should now run:

dlltool -d C:\Python32_x86\libs\python32.def -l C:\Python32_x86\libs\libpython32.dll.a

Now you should be able to do emerge -i boost-python-src without errors.

Using emerge

To use emerge you need to start a console window and point that to %KDEROOT%\emerge. For example:

C:
cd \%KDEROOT%\emerge

Then you have to execute

kdeenv.bat

This tells emerge about your environment settings (e.g. paths). It will load your configuration from %KDEROOT%\etc\kdesettings.bat. It should not give any error messages, otherwise emerge will not work as expected. The output should look similar to this one (of course with your paths):

C:\kderoot\emerge>kdeenv.bat
kdesettings.bat executed
KDEROOT     : C:\kderoot
KDECOMPILER : mingw
KDESVNDIR   : C:\kderoot\svn
PYTHONPATH  : C:\python32
DOWNLOADDIR : C:\kderoot\download
C:\kderoot\emerge>

Next, if you have configured your kdesettings.bat to use svn+ssh for your subversion checkout, then you need to run:

plink <your-svn-username>@svn.kde.org
plink <your-kde-username>@git.kde.org

This will prompt you to accept the fingerprint of the server, otherwise svn will hang forever when trying to download from the server.

Now you should be able to use emerge. Type

emerge --help

to get some help on usage.

Note: There is a short path option in kdesettings which you will need if you want to build Qt in a directory that has a pathlenght of more then around 5 characters. This problem is due to limitations of the command line length and the Qt build system.

Setting up a compiler

Currently emerge supports both the MinGW and MS Visual C++ (msvc) compilers. We did not add dependencies for the compilers, so you have to make sure to install a compiler by yourself. There are three ways to set up a compiler for emerge. We assumed you have set KDECOMPILER variable properly in the %KDEROOT%\etc\kdesettings.bat.

In the following sections you can find information on how to install or reuse an existing compiler.

Install the MinGW compiler with emerge

Let emerge install the MinGW compiler, as soon as emerge needs MinGW it will automatically fetch the correct version for you.

Install MS Visual C++

Read here.


Point to an existing MS Visual C++ installation

You need to point emerge to an existing msvc installation. This is run automatically for you from kdeenv.bat if configured properly in kdesettings.bat. Check your kdesettings.bat file to know where to set it.

Installing the base system

Once you have emerge and a compiler installed and working, try:

  • emerge --help for a list of available commands
  • emerge --print-installable to get a list of available packages
  • emerge --print-installed to get a list of currently installed packages

Further options are described below.

You are now ready to start building KDE, it is recommended to do so progressively, relying on emerge to automatically resolve the required dependencies at each set step:

  • Enter emerge qt. This will fetch and install Windows versions of numerous UNIX-like utilities and libraries, then checkout, compile and install Qt. This will take several hours.
  • Enter emerge kdelibs. This will checkout, compile and install the required kdesupport modules and then kdelibs.
  • Enter emerge kde-baseapps. This will checkout, compile and install kdebase-runtime, and kdebase-apps.

You will now have successfully installed a base KDE system and can now install other KDE modules as required.

Note that this will install the development version of KDE (trunk in svn repositories, master in git repositories), if you wish to install a particular stable branch then you should change the branch of emerge to the specific branch of that release. NOTE: You should not mix kde packages from different branches.

It is strongly recommended you do not choose to manually install any of the utilities and libraries yourself, as you may install the wrong version and cause installation failures. Instead allow emerge to resolve the dependencies for you.

Every time you want to update or install a package, you should first update your emerge checkout (simply run emerge --update emerge) to ensure you are using the latest package recipies.

What emerge does

emerge packageName performs the separate actions --fetch, --unpack, --compile, --install, and --qmerge.

The --fetch action will retrieve either a binary or the source code for the package:

  • If a binary package, this will be downloaded into the DOWNLOADDIR defined in your kdesettings.bat, which is usually %KDEROOT%\download.
  • If a non-KDE source package, the source repository will be checked-out into %DOWNLOADDIR%\svn-src, e.g. Qt source may be found in C:\kderoot\download\svn-src\qt.
  • If a KDE source package from the svn.kde.org repository, then the source will be checked-out into the KDESVNDIR defined in your kdesettings.bat, which is usually %KDEROOT%\svn.

emerge command line options and settings

There are some options that can be used when building with emerge.

Command line switch Command line argument Description
-v EMERGE_VERBOSE This option sets the verbosity level. Currently the highest verbosity level is 3 (-v -v -v). A verbosity level of 0 should give no output and equals to -q. You can set EMERGE_VERBOSE=3 instead in the environment of the commandline or within your kdesettings.bat file.
--offline This option suppresses the update step of the local tree - which needs some time. Be aware though that you have to have existing sources already if you want to use this option.
-t EMERGE_BUILDTESTS This option enables or disables KDE4 buildtests for KDE modules. Other packages will not change. Use EMERGE_BUILDTESTS=True or =False.
--print-targets This option will display all "targets" a certain package has. Normally targets are fixed releases or different branches. They are defined in the portage file.
--target=TARGET This sets a specific target for this package. If not added, the default target is used, which can be checked by looking at the output of --print-targets.
-i This option ignores that a package is already installed. It builds it completely new, but keeps the dependencies.
--update This option ignores that a package is already installed but doesn't cleanup an already existing build directory. Thus you will only rebuild files that have changed since the last build.

Hints

Updating packages

  • Once you have packagename built, type
    emerge --update packagename
    to update packagename from the Subversion and compile it without removing the build dir or
    emerge --update-all
    to update all packages that can be rebuild (they are rebuild with --update).

General setup

For Fine Tuning see here: Fine-tuning

Notes

emerge can mostly cooperate with the kdewin-installer but we're currently still working on some packages which are packaged in a wrong way. It is not recommended to use another layout then installer for directory_layout in the kdesettings.bat anymore (see that file for more detailed information).

emerge creates lots of files in \kderoot\tmp during build. After a package is successfully installed (check \kderoot\etc\portage\installed or the directory \kderoot\manifest\), you can delete its temporary directory.

Windows emerge is derived from the Gentoo portage system, but we are currently not enforcing compatibility. If you have questions about that please contact us at the channel #kde-windows on irc.freenode.net.

last reviewed by SaroEngels 22:52, 26th July 2011 (UTC)

Vista issues

  • jstaniek 12:02, 15 January 2008 (CET): UAC has infamous heuristics that make programs like patch.exe treat as installers and try to run them with admin rights (!). This heuristics can be tricked by renaming patch.exe to something like pch.exe (example) but we did not want to add item to our infrastructure. Instead it is possibleto turn off the heuristics (see the screenshot here in the security blog calling the heuristics 'severe hole in the design of UAC'). If you happen to disable the UAC, as many annoyed users and devs do (msvc demands admin rights anyway!), patch.exe should already work for you as in older Windows. Alternatively you may want to disable UAC for admins only, but this makes no sense if you are the only user of your machine and use only the admin account.
  • This wiki page lists instructions on how to use program manifest to disable privilege elevation for a single binary and makes patch play nice with UAC. This should eventually be integrated to emerge scripts.

KDE® and the K Desktop Environment® logo are registered trademarks of KDE e.V.Legal