(Installing Emerge)
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 emerge ==
+
== Setting up craft ==
 
=== 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 is can be installed by Craft, [https://www.visualstudio.com/ Visual Studio] must be installed independently by the user.
  
 
=== Direct X SDK ===
 
=== Direct X SDK ===
Line 15: Line 15:
 
* Exit the administrator powershell instance.
 
* Exit the administrator powershell instance.
 
* Start a powershell environment as a user.
 
* Start a powershell environment as a user.
* Install emerge 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'))
  
== Using emerge ==
+
== Using Craft ==
To use emerge you need to start a Powershell window, point that to <tt>KDEROOT\emerge</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\emerge\kdeenv.ps1
+
  C:\KDEROOT\craft\kdeenv.ps1
  
This tells emerge 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 emerge will not work as expected. The output should look similar to this one (of course with your paths):
+
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\emerge>.\kdeenv.ps1
+
  PS C:\kderoot\craft>.\kdeenv.ps1
  KDEROOT    : C:\kderoot\emerge
+
  KDEROOT    : C:\kderoot\
 
  KDECOMPILER : msvc2015
 
  KDECOMPILER : msvc2015
 
  KDESVNDIR  : C:\kderoot\download\svn
 
  KDESVNDIR  : C:\kderoot\download\svn
Line 33: Line 33:
 
  PYTHONPATH  : C:\kderoot\python
 
  PYTHONPATH  : C:\kderoot\python
 
   
 
   
  PS C:\kderoot\emerge>
+
  PS C:\kderoot\>
  
=== Common emerge commands ===
+
=== Common Craft commands ===
* '''Installing a package and its dependencies''': Simply run <syntaxhighlight lang="text">emerge packagename</syntaxhighlight>
+
* '''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">emerge -i packagename</syntaxhighlight> to update <tt>packagename</tt>.
+
* '''Updating an installed package''': Once you have ''packagename'' built, type <syntaxhighlight lang="text">craft -i packagename</syntaxhighlight> to update <tt>packagename</tt>.
  
 
== Troubleshooting ==
 
== Troubleshooting ==
Line 44: Line 44:
  
 
   ...
 
   ...
   emerge warning: while running make cmd: jom
+
   craft warning: while running make cmd: jom
   emerge warning: Action: compile for libs/qt5/qtbase FAILED
+
   craft warning: Action: compile for libs/qt5/qtbase FAILED
   *** Emerge all failed: all of libs/qtbase failed after 0:07:25 ***
+
   *** Craft all failed: all of libs/qtbase failed after 0:07:25 ***
   emerge error: fatal error: package libs/qtbase all failed
+
   craft error: fatal error: package libs/qtbase all failed
  
 
In order to figure out ''what'' failed, grep the command line output ''above'' for errors.
 
In order to figure out ''what'' failed, grep the command line output ''above'' for errors.
Line 53: Line 53:
 
If the log output is too long, you can also pipe the output to a file and then open the file inside an editor.
 
If the log output is too long, you can also pipe the output to a file and then open the file inside an editor.
  
   emerge qt > log 2>&1
+
   craft qt > log 2>&1
 
   notepad++ log
 
   notepad++ log
  
 
Grep for "error", or "error:" in the file.
 
Grep for "error", or "error:" in the file.

Revision as of 16:02, 20 November 2016

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

Setting up craft

Setting up a compiler

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

Direct X SDK

In order to compile the Qt5 qtbase package with MinGW you will also need to install the Microsoft DirectX SDK, make sure to open a new command line window after the installation.

Installing Craft

  • Start a powershell environment as administrator.
  • Allow execution of powershell scripts.
 Set-ExecutionPolicy RemoteSigned
  • Exit the administrator powershell instance.
  • Start a powershell environment as a user.
  • Install Craft and folow the instructions
iex ((new-object net.webclient).DownloadString('https://raw.githubusercontent.com/KDE/craft/master/setup/install_craft.ps1'))

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:\KDEROOT\craft\kdeenv.ps1

This tells Craft about your environment settings (e.g. paths). It will load your configuration from KDEROOT\etc\kdesettings.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:\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
    craft packagename
    
  • Updating an installed package: Once you have packagename built, type
    craft -i packagename
    
    to update packagename.

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.

If the log output is too long, you can also pipe the output to a file and then open the file inside an editor.

 craft qt > log 2>&1
 notepad++ log

Grep for "error", or "error:" in the file.


Content is available under Creative Commons License SA 4.0 unless otherwise noted.