Guidelines and HOWTOs/Build from source/Windows: Difference between revisions

From KDE Community Wiki
(→‎Setting up a compiler: Some grammar fixes.)
m (Fix minor typos)
(44 intermediate revisions by 16 users not shown)
Line 1: Line 1:
''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.
''Craft'' is a tool to build the sources and its third-party requirements. It is the '''easy''' way to build software.
 
== Setting up craft ==
=== Installing python ===
While Craft is capable of installing an embedded Python version sufficient for most packages, we recommend a full installation of Python. The current version is 3.7. [https://www.python.org/downloads/ Download Python 3.6+]
 
=== Setting up a powershell ===
Powershell is required to be at least version 5.0.
If you're running Windows 10 you most probably won't need to update Powershell.
 
You can check the version by invocating <tt>$PSVersionTable.PSVersion</tt> in a Powershell terminal.
 
In case you need a newer one, we recommend
[https://docs.microsoft.com/en-us/powershell/scripting/install/installing-powershell-core-on-windows?view=powershell-6 Powershell Core].
 
The latest version of the standard powershell can be found [https://www.microsoft.com/en-us/download/details.aspx?id=50395 here].


== Setting up emerge ==
=== Setting up a compiler ===
=== Setting up a compiler ===
Currently emerge supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
Currently, Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
While MinGW is can be installed by emerge, [https://www.visualstudio.com/ Visual Studio] must be installed independently by the user.
While MinGW can be installed by Craft, [https://www.visualstudio.com/ Visual Studio] must be installed independently by the user.


=== Direct X SDK ===
=== Direct X SDK (only for MinGW setups) ===
In order to compile the Qt5 ''qtbase'' package with MinGW, you will also need to install the [https://www.microsoft.com/en-us/download/details.aspx?id=6812 Microsoft DirectX SDK], make sure to open a new command line window after the installation.
If you are using the MinGW compiler, in order to compile the Qt5 ''qtbase'' package you will also need to install the [https://www.microsoft.com/en-us/download/details.aspx?id=6812 Microsoft DirectX SDK]. Make sure to open a new command line window after the installation for the environment variables to be set.


=== Installing Emerge ===
=== Installing Craft===
* Start a powershell environment as administrator.
# [https://docs.microsoft.com/en-us/powershell/scripting/setup/starting-windows-powershell?view=powershell-6 Start a PowerShell environment]. It might be required to run it [https://docs.microsoft.com/en-us/powershell/scripting/setup/starting-windows-powershell?view=powershell-6#with-administrative-privileges-run-as-administrator as administrator].
* Allow execution of powershell scripts.
# Allow execution of powershell scripts by executing the following command:
  Set-ExecutionPolicy RemoteSigned
#:<pre>Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</pre>
* Exit the administrator powershell instance.
# Install Craft and follow the instructions by executing the following command:
* Start a powershell environment as a user.
#: <pre>iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))</pre>
* Install emerge and folow the instructions
# Consider adding exception for the entire craft root directory to your antivirus' exceptions, otherwise build of some packages can fail (example: build of <code>frameworks/tier2/kdoctools</code> when AVG is used).
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/emerge/master/setup/install_emerge.ps1'))


== Using emerge ==
To use emerge you need to start a Powershell window, point that to <tt>KDEROOT\emerge</tt> and run the initalization script. For example:


C:\KDEROOT\emerge\kdeenv.ps1
Note: For Microsoft Visual Studio compiler, it's necessary to have VCTOOLSREDISTDIR environment variable pointing to:
"C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\xx.xx.xxxxx" for MSVS 2017 and
VCINSTALLDIR environment pointing to "C:\Program Files (x86)\Microsoft Visual Studio\2015\Community\VC\" for MSVS 2015.


This tells emerge about your environment settings (e.g. paths). It will load your configuration from <tt>KDEROOT\etc\kdesettings.ini</tt>. 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):
=== Using the stock Qt SDK===
This will skip all Qt packages and use the official Qt builds instead.
It will work fine for most CMake based recipes but definitely cause problems with QMake based projects.
You will of course also miss all patches we usually apply to Qt.
This is only recommended when you know what you are doing and you won't get support for in our channel.


PS C:\kderoot\emerge>.\kdeenv.ps1
To activate the SDK mode adapt the [QtSDK] section in your etc/kdesettings.ini to something like:
KDEROOT     : C:\kderoot\emerge
    [QtSDK]
KDECOMPILER : msvc2015
    ## Whether to use prebuild Qt binaries.
KDESVNDIR  : C:\kderoot\download\svn
    Enabled = True
KDEGITDIR  : C:\kderoot\download\git
    ## The path to the Qt sdk.
DOWNLOADDIR : C:\kderoot\download
     Path = C:\Qt
PYTHONPATH  : C:\kderoot\python
    ## The version of Qt.
    Version = 5.9
PS C:\kderoot\emerge>
    ## The compiler version, if you are not sure what to use, have a look at the directory set in QtSDK/Path.
    ## The compiler must be of the same type as General/KDECOMPILER.
    ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
    Compiler = msvc2017_64


=== Installing the base system ===
== Using Craft ==
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:
To use Craft you need to start a Powershell window, point that to <tt>KDEROOT\craft </tt> and run the initalization script. For example:


* Enter <tt>emerge qt5</tt>.  This will fetch and install Windows versions of numerous UNIX-like utilities and libraries, then checkout, compile and install Qt.  This will take up to several hours.
  C:\CraftRoot\craft\craftenv.ps1
* Enter <tt>emerge frameworks</tt>. This will checkout, compile and install the kde frameworks 5 modules.


You will now have successfully installed a base KDE system and can now install other KDE modules as required.
This tells Craft about your environment settings (e.g. paths). It will load your configuration from <tt>CraftRoot\etc\CraftSettings.ini</tt>. If there are any error messages Craft will not work as expected. The output should look similar to this one (of course with your paths):


Every time you want to update or install a package, you should first update your emerge checkout (simply run
PS C:\CraftRoot\craft>.\craftenv.ps1
  cd C:\kderoot\emerge
Craft Root          : C:\CraftRoot
  git pull
Craft              : R:\
to ensure you are using the latest package recipes.
Version            : master
ABI                : windows-msvc2017_64-cl
  Svn directory      : C:\CraftRoot\download\svn
  Git directory      : Q:\
Download directory  : C:\CraftRoot\download


=== Common emerge commands ===
Then [https://community.kde.org/Craft start crafting]
* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">emerge packagename</syntaxhighlight>
* '''Updating an installed package''': Once you have ''packagename'' built, type <syntaxhighlight lang="text">emerge -i packagename</syntaxhighlight> to update <tt>packagename</tt>.

Revision as of 18:56, 8 February 2019

Craft is a tool to build the sources and its third-party requirements. It is the easy way to build software.

Setting up craft

Installing python

While Craft is capable of installing an embedded Python version sufficient for most packages, we recommend a full installation of Python. The current version is 3.7. Download Python 3.6+

Setting up a powershell

Powershell is required to be at least version 5.0. If you're running Windows 10 you most probably won't need to update Powershell.

You can check the version by invocating $PSVersionTable.PSVersion in a Powershell terminal.

In case you need a newer one, we recommend Powershell Core.

The latest version of the standard powershell can be found here.

Setting up a compiler

Currently, Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler. While MinGW can be installed by Craft, Visual Studio must be installed independently by the user.

Direct X SDK (only for MinGW setups)

If you are using the MinGW compiler, in order to compile the Qt5 qtbase package you will also need to install the Microsoft DirectX SDK. Make sure to open a new command line window after the installation for the environment variables to be set.

Installing Craft

  1. Start a PowerShell environment. It might be required to run it as administrator.
  2. Allow execution of powershell scripts by executing the following command:
    Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
  3. Install Craft and follow the instructions by executing the following command:
    iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
  4. Consider adding exception for the entire craft root directory to your antivirus' exceptions, otherwise build of some packages can fail (example: build of frameworks/tier2/kdoctools when AVG is used).


Note: For Microsoft Visual Studio compiler, it's necessary to have VCTOOLSREDISTDIR environment variable pointing to: "C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\xx.xx.xxxxx" for MSVS 2017 and VCINSTALLDIR environment pointing to "C:\Program Files (x86)\Microsoft Visual Studio\2015\Community\VC\" for MSVS 2015.

Using the stock Qt SDK

This will skip all Qt packages and use the official Qt builds instead. It will work fine for most CMake based recipes but definitely cause problems with QMake based projects. You will of course also miss all patches we usually apply to Qt. This is only recommended when you know what you are doing and you won't get support for in our channel.

To activate the SDK mode adapt the [QtSDK] section in your etc/kdesettings.ini to something like:

   [QtSDK]
   ## Whether to use prebuild Qt binaries.
   Enabled = True
   ## The path to the Qt sdk.
   Path = C:\Qt
   ## The version of Qt.
   Version = 5.9
   ## The compiler version, if you are not sure what to use, have a look at the directory set in QtSDK/Path.
   ## The compiler must be of the same type as General/KDECOMPILER.
   ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
   Compiler = msvc2017_64

Using Craft

To use Craft you need to start a Powershell window, point that to KDEROOT\craft and run the initalization script. For example:

C:\CraftRoot\craft\craftenv.ps1

This tells Craft about your environment settings (e.g. paths). It will load your configuration from CraftRoot\etc\CraftSettings.ini. If there are any error messages Craft will not work as expected. The output should look similar to this one (of course with your paths):

PS C:\CraftRoot\craft>.\craftenv.ps1
Craft Root          : C:\CraftRoot
Craft               : R:\
Version             : master
ABI                 : windows-msvc2017_64-cl
Svn directory       : C:\CraftRoot\download\svn
Git directory       : Q:\
Download directory  : C:\CraftRoot\download

Then start crafting