Difference between revisions of "Guidelines and HOWTOs/Build from source/Windows"

 
(41 intermediate revisions by 16 users not shown)
Line 2: Line 2:
  
 
== Setting up craft ==
 
== Setting up craft ==
== Installing python?==
+
=== Installing python ===
While Craft is capable of installing a embedded Python version we recommend to install Python yourself.
+
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+]  
The embedded version is completely sufficient for most packages, some may require a full installation of Python.
+
 
[https://www.python.org/downloads/ Download Python 3.6+]  
+
Note that some packages may still depend on Python2.7, so if you see following error make sure to install it and update CraftSettings.ini file:
 +
 
 +
    DEBUG Craft was unable to locate: python2.7, in None
 +
    CRITICAL Please have a look on C:\CraftRoot\etc\CraftSettings.ini and make sure that
 +
        [Paths]
 +
        PYTHON27
 +
    Points to a valid Python installation.
 +
 
 +
 
  
 
=== Setting up a powershell ===
 
=== Setting up a powershell ===
 
Powershell is required to be at least version 5.0.  
 
Powershell is required to be at least version 5.0.  
If your running Windows 10 you most probably won't need to update Powershell.
+
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.
  
You can check the version with <tt>$PSVersionTable.PSVersion</tt> .
+
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].
  
[https://www.microsoft.com/en-us/download/details.aspx?id=50395 Download Powershell]
+
The latest version of the standard powershell can be found [https://www.microsoft.com/en-us/download/details.aspx?id=50395 here].
  
 
=== Setting up a compiler ===
 
=== Setting up a compiler ===
Currently Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
+
Currently, Craft supports both the MinGW and Microsoft Visual Studio (msvc) compiler.
 
While MinGW can be installed by Craft, [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 ===
+
''Please note that in case you or the package you are a trying to build needs QtWebEngine, you'll have to use Visual Studio(!). MinGW is [https://bugreports.qt.io/browse/QTBUG-42725 not supported].''
 +
 
 +
For Visual Studio, make sure the following components are selected at the minimum:
 +
* MSVC build tools
 +
* Windows SDK
 +
* C++ CMake tools for Windows
 +
* C++ Clang tools for Windows
 +
 
 +
=== 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 [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.
 
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.
 +
 +
=== (Optional) Enable development mode ===
 +
Windows 10 supports the creation of symbolic links, but only if the development mode is activated.
 +
Allowing symbolic links allows faster (much faster) extraction of archives.
 +
[https://docs.microsoft.com/en-us/windows/uwp/get-started/enable-your-device-for-development Enable development mode]
  
 
=== Installing Craft===
 
=== Installing Craft===
* Start a powershell environment.
+
# [https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell?view=powershell-7 Start a PowerShell environment] (Do not use PowerShell ISE, it doesn't work very well with python). It might be required to run it [https://docs.microsoft.com/en-us/powershell/scripting/windows-powershell/starting-windows-powershell?view=powershell-7#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 -Scope CurrentUser RemoteSigned
+
#:<pre>Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</pre>
* Install Craft and folow the instructions
+
# 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'))
+
#: <pre>iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))</pre>
 +
# Consider adding exception for the entire craft root directory to your antivirus' exceptions, otherwise build of some packages can fail (example: build of <code>kde/frameworks/tier2/kdoctools</code> when AVG is used).
  
== Using Craft ==
 
To use Craft you need to start a Powershell window, point that to <tt>KDEROOT\craft </tt> and run the initalization script. For example:
 
  
C:\KDEROOT\craft\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 Craft about your environment settings (e.g. paths). It will load your configuration from <tt>KDEROOT\etc\kdesettings.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):
+
=== 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\craft>.\kdeenv.ps1
+
To activate the SDK mode adapt the [QtSDK] section in your etc/CraftSettings.ini to something like:
KDEROOT     : C:\kderoot\
+
    [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\>
+
    ## 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
  
=== Common Craft commands ===
+
== Using Craft ==
* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">craft packagename</syntaxhighlight>
+
To use Craft you need to start a Powershell window, point that to <tt>KDEROOT\craft </tt> and run the initalization script. For example:
* '''Updating an installed package''': Once you have ''packagename'' built, type <syntaxhighlight lang="text">craft -i packagename</syntaxhighlight> to update <tt>packagename</tt>.
 
* '''Updating Craft''':<syntaxhighlight lang="text">craft craft</syntaxhighlight>
 
  
== Advanced tips ==
+
C:\CraftRoot\craft\craftenv.ps1
  
 +
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):
  
To build a non default version, append a line to [https://phabricator.kde.org/source/craft/browse/master/kdesettings.ini;3e3b3817deb9f17d2779d2275382d453104ed9e6$99 kderoot/etc/kdesettings.ini] of form:
+
PS C:\CraftRoot\craft>.\craftenv.ps1
 +
Craft              : C:\CraftRoot
 +
Version            : master
 +
ABI                : windows-msvc2017_64-cl
 +
Download directory  : C:\CraftRoot\download
  
category/packagename = branch
+
Then [https://community.kde.org/Craft start crafting]
 
 
For example, to install master branch of kdevelop, the line to be appended should look like:
 
extragear/kdevelop = master
 
 
 
To find the category of the package you want to install, run this in powershell:
 
craft --search packagename
 
The second line of the output will be of form: <tt>category/packagename</tt>
 
  
 
== Troubleshooting ==
 
== Troubleshooting ==
  
If a package fails to build, you'll be greeted with something like:
+
If craft seems stalled for prolonged period of time, you may want need hit Enter in the Powershell terminal to give it a nudge.
 
 
  ...
 
  craft warning: while running make cmd: jom
 
  craft warning: Action: compile for libs/qt5/qtbase FAILED
 
  *** Craft all failed: all of libs/qtbase failed after 0:07:25 ***
 
  craft error: fatal error: package libs/qtbase all failed
 
  
In order to figure out ''what'' failed, grep the command line output ''above'' for errors.
+
== Virtual Machines ==
  
Or have a look at the log file located in <tt> %USERPROFILE%\.craft</tt> which will contain much more details.
+
If you don't have windows - not to worry! Grab one of Microsoft's VM for development.
  
Search for "error", or "error:" in the file.
+
* Get a VM
 +
** Windows VM https://developer.microsoft.com/en-us/windows/downloads/virtual-machines/
 +
*** This VM comes with Visual Studio pre-installed as well as a whole bunch of other crap you may or may not need. You need to modify VS to install modules needed to build KDE software. @sitter suggests this
 +
** Edge VM https://developer.microsoft.com/en-us/microsoft-edge/tools/vms/
 +
*** Much less cruft but you need to manually install Visual Studio and whatever else you might need. @ervin suggests this
 +
* Import into VM software + install guest addons if necessary and applicable
 +
* In windows search the start menu for 'Visual Studio Installer' and start it
 +
* Modify VS and select the components mentioned on the Craft page. For particularly easy access you can simply pick the 'desktop development with c++' and 'linux development with c++' workloads instead of the individual components
 +
* Setup Craft as described above

Latest revision as of 15:36, 4 October 2020

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+

Note that some packages may still depend on Python2.7, so if you see following error make sure to install it and update CraftSettings.ini file:

   DEBUG Craft was unable to locate: python2.7, in None
   CRITICAL Please have a look on C:\CraftRoot\etc\CraftSettings.ini and make sure that
       	[Paths]
       	PYTHON27
   Points to a valid Python installation.


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.

Please note that in case you or the package you are a trying to build needs QtWebEngine, you'll have to use Visual Studio(!). MinGW is not supported.

For Visual Studio, make sure the following components are selected at the minimum:

  • MSVC build tools
  • Windows SDK
  • C++ CMake tools for Windows
  • C++ Clang tools for Windows

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.

(Optional) Enable development mode

Windows 10 supports the creation of symbolic links, but only if the development mode is activated. Allowing symbolic links allows faster (much faster) extraction of archives. Enable development mode

Installing Craft

  1. Start a PowerShell environment (Do not use PowerShell ISE, it doesn't work very well with python). 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 kde/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/CraftSettings.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               : C:\CraftRoot
Version             : master
ABI                 : windows-msvc2017_64-cl
Download directory  : C:\CraftRoot\download

Then start crafting

Troubleshooting

If craft seems stalled for prolonged period of time, you may want need hit Enter in the Powershell terminal to give it a nudge.

Virtual Machines

If you don't have windows - not to worry! Grab one of Microsoft's VM for development.

  • Get a VM
  • Import into VM software + install guest addons if necessary and applicable
  • In windows search the start menu for 'Visual Studio Installer' and start it
  • Modify VS and select the components mentioned on the Craft page. For particularly easy access you can simply pick the 'desktop development with c++' and 'linux development with c++' workloads instead of the individual components
  • Setup Craft as described above

This page was last edited on 4 October 2020, at 15:36. Content is available under Creative Commons License SA 4.0 unless otherwise noted.
-->