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

From KDE Community Wiki
(→‎Installing Craft: Antivirus conflicts)
(20 intermediate revisions by 6 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 a embedded Python version sufficient for most packages, we recommend a full installation of Python. The current version is 3.6. [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+]  


=== Setting up a powershell ===
=== Setting up a powershell ===
Powershell is required to be at least version 3.0. You can check the version with $PSVersionTable.PSVersion .
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 with <tt>$PSVersionTable.PSVersion</tt> .
 
[https://www.microsoft.com/en-us/download/details.aspx?id=50395 Download Powershell]
or
[https://docs.microsoft.com/en-us/powershell/scripting/setup/installing-powershell-core-on-windows?view=powershell-5.1 Download Powershell Core]
 
=== 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.
Line 17: Line 23:


=== Installing Craft===
=== Installing Craft===
* Start a powershell environment as administrator.
* Start a powershell environment.
* Allow execution of powershell scripts.
* Allow execution of powershell scripts.
   Set-ExecutionPolicy RemoteSigned
   Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
* Exit the administrator powershell instance.
* Start a powershell environment as a user.
* Install Craft and folow the instructions
* Install Craft and folow the instructions
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
  iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
* 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).
=== 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 ==
== 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:
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
  C:\CraftRoot\craft\craftenv.ps1
 
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):
 
PS C:\kderoot\craft>.\kdeenv.ps1
KDEROOT    : C:\kderoot\
KDECOMPILER : msvc2015
KDESVNDIR  : C:\kderoot\download\svn
KDEGITDIR  : C:\kderoot\download\git
DOWNLOADDIR : C:\kderoot\download
PYTHONPATH  : C:\kderoot\python
PS C:\kderoot\>
 
=== Common Craft commands ===
* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">craft packagename</syntaxhighlight>
* '''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>
 
== Troubleshooting ==
 
If a package fails to build, you'll be greeted with something like:
 
  ...
  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.


Or have a look at the log file located in <tt> %USERPROFILE%\.craft</tt> which will contain much more details.
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):


Search for "error", or "error:" in the file.
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

Revision as of 00:31, 22 March 2018

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 a embedded Python version sufficient for most packages, we recommend a full installation of Python. The current version is 3.6. 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 with $PSVersionTable.PSVersion .

Download Powershell or Download Powershell Core

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

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

  • Start a powershell environment.
  • Allow execution of powershell scripts.
 Set-ExecutionPolicy -Scope CurrentUser RemoteSigned
  • Install Craft and folow the instructions
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))
  • 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).

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