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

m (Excessive vertical whitespace)
 
(20 intermediate revisions by 7 users not shown)
Line 3: Line 3:
 
== Setting up craft ==
 
== Setting up craft ==
 
=== Installing python ===
 
=== 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+]  
+
While Craft is capable of installing an embedded Python version sufficient for most packages, we recommend a full installation of Python. Python is currently releasing new versions in the Python 3 series. [https://www.python.org/downloads/ Download Python 3.x]
 +
 
 +
Note that all Python 2 versions, including Python 2.7, are now end-of-life and unsupported. Despite that, some packages may still depend on Python 2.7, and will produce the following error:
 +
 
 +
    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.
 +
 
 +
You can try installing Python 2 and updating the CraftSettings.ini file, though it would be better to find out if the package has been updated or replaced with one that is compatible with Python 3.
  
 
=== Setting up a powershell ===
 
=== Setting up a powershell ===
Line 20: Line 30:
 
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 (only for MinGW setups) ===
+
''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:
 +
* Desktop Development with C++
 +
* C++ ATL
 +
* Windows SDK
 +
 
 +
=== (Optional) Direct X SDK (only for MinGW setups) ===
 +
(You can skip this step if you plan to use the binary cache which is enable by default, Direct X SDK is only needed during building)
 +
 
 
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 ===
+
=== (Optional, Recommended) Enable development mode ===
 
Windows 10 supports the creation of symbolic links, but only if the development mode is activated.
 
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.
 
Allowing symbolic links allows faster (much faster) extraction of archives.
Line 29: Line 48:
  
 
=== Installing Craft===
 
=== Installing Craft===
# [https://docs.microsoft.com/en-us/powershell/scripting/setup/starting-windows-powershell?view=powershell-6 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/setup/starting-windows-powershell?view=powershell-6#with-administrative-privileges-run-as-administrator as administrator].
+
# [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 by executing the following command:
 
# Allow execution of powershell scripts by executing the following command:
 
#:<pre>Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</pre>
 
#:<pre>Set-ExecutionPolicy -Scope CurrentUser RemoteSigned</pre>
 
# Install Craft and follow the instructions by executing the following command:
 
# Install Craft and follow the instructions by executing the following command:
 
#: <pre>iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))</pre>
 
#: <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>frameworks/tier2/kdoctools</code> when AVG is used).
+
# 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).
  
  
Line 40: Line 59:
 
"C:\Program Files (x86)\Microsoft Visual Studio\2017\Professional\VC\Redist\MSVC\xx.xx.xxxxx" for MSVS 2017 and  
 
"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.
 
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 ==
 
== Using Craft ==
Line 74: Line 74:
  
 
Then [https://community.kde.org/Craft start crafting]
 
Then [https://community.kde.org/Craft 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
 +
** 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
 +
 +
== Advanced ==
 +
=== Setup Visual Studio with Chocolatey ===
 +
* <pre>choco install -y visualstudio2019buildtools --package-parameters "--add  Microsoft.VisualStudio.Component.VC.ATL"</pre>
 +
* <pre>choco install -y visualstudio2019-workload-vctools visualstudio2019-workload-nativedesktop visualstudio2019-workload-manageddesktopbuildtools</pre>
 +
* <pre>choco install -y windows-sdk-10</pre>

Latest revision as of 12:26, 26 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. Python is currently releasing new versions in the Python 3 series. Download Python 3.x

Note that all Python 2 versions, including Python 2.7, are now end-of-life and unsupported. Despite that, some packages may still depend on Python 2.7, and will produce the following error:

   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.

You can try installing Python 2 and updating the CraftSettings.ini file, though it would be better to find out if the package has been updated or replaced with one that is compatible with Python 3.

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:

  • Desktop Development with C++
  • C++ ATL
  • Windows SDK

(Optional) Direct X SDK (only for MinGW setups)

(You can skip this step if you plan to use the binary cache which is enable by default, Direct X SDK is only needed during building)

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, Recommended) 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 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

Advanced

Setup Visual Studio with Chocolatey

  • choco install -y visualstudio2019buildtools --package-parameters "--add  Microsoft.VisualStudio.Component.VC.ATL"
  • choco install -y visualstudio2019-workload-vctools visualstudio2019-workload-nativedesktop visualstudio2019-workload-manageddesktopbuildtools
  • choco install -y windows-sdk-10

This page was last edited on 26 October 2020, at 12:26. Content is available under Creative Commons License SA 4.0 unless otherwise noted.