Craft: Difference between revisions

From KDE Community Wiki
No edit summary
m (fix typo)
(24 intermediate revisions by 5 users not shown)
Line 1: Line 1:
Craft the meta build system
Craft is an open source meta build system and package manager. It manages dependencies and builds libraries and applications from source, on ''Windows'', ''Mac'', ''Linux'' and ''FreeBSD''.


== Setting up Craft ==


== Start crafting ==
[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows Start crafting on Windows]


[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows Start crafting on Windows]
[https://community.kde.org/Craft/Linux Start crafting on Linux]
[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Mac Start crafting  on Mac]
 
[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Mac#Installation_using_stock_version_of_Qt_and_Craft Start crafting on Mac]
 
[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/FreeBSD Start crafting  on FreeBSD]
 
== Common Craft commands ==
 
Installing a package and its dependencies
craft packagename
Updating an installed package: Once you have ''packagename'' built, type:
craft -i packagename
Searching for a package
craft --search packagename
Switching to the source directory of a package:
cs packagename
Switching to the build directory of a package:
cb packagename
Just compiling the package (i.e. if you just modified the source code and want to test-compile):
craft --compile packagename
Create an installer (or .dmg bundle, ...) for a specific package. The option Packager/PackageType in CraftSettings.ini controls which type of package is created:
craft --package kdevelop
 
Updating Craft itself:
craft craft
Updating the blueprints:
craft -i craft-blueprints-kde
 
== Adding new blueprints ==
 
Blueprints are stored in separate repositories. At the moment there are these repositories:
* https://cgit.kde.org/craft-blueprints-kde.git/tree/ (enabled by default)
 
To navigate to this repository on your local file system, type in:
cs craft-blueprints-kde
 
Open a file browser in that folder and start adding new recipes by copying from existing ones. Note that the name of the package folder needs to match the blueprint name -- an example would be "kdegraphics-mobipocket\kdegraphics-mobipocket.py"
 
== Advanced tips ==
 
=== Hardcode versions of packages ===
 
To build a non default version,edit $craftRoot/etc/BlueprintSettings.ini and add:
 
[category/packagename]
version = branch
 
To find the category of the package you want to install, run this:
craft --search packagename
The second line of the output will be of form: <tt>category/packagename</tt>
 
For example, to install master branch of khtml, the line to be appended should look like:
 
[frameworks/khtml]
version = master
 
To change the version of a complete branch, like libs/qt5 add
 
  [libs/qt5]
  version = 5.9.3
 
=== Using the 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
 
== 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>$HOME/.craft</tt> (<tt>%USERPROFILE%\.craft</tt> on Windows) which will contain much more details.
 
Search for "error", or "error:" in the file.
 
== News ==
[https://the2ring.blogspot.de/search/label/Craft Blog]
 
== Getting in Touch ==
 
* IRC: [irc://irc.freenode.net/kde-windows #kde-windows] on freenode (join via web chat: http://webchat.freenode.net/?channels=kde-windows)
 
* [https://bugs.kde.org/enter_bug.cgi?product=Craft Report bugs]
 
* Mailing list:  [mailto:[email protected] [email protected]] ([https://mail.kde.org/mailman/listinfo/kde-windows  subscribe], [http://lists.kde.org/?l=kde-windows&r=1&w=2 archives])

Revision as of 15:25, 9 December 2017

Craft is an open source meta build system and package manager. It manages dependencies and builds libraries and applications from source, on Windows, Mac, Linux and FreeBSD.

Setting up Craft

Start crafting on Windows

Start crafting on Linux

Start crafting on Mac

Start crafting on FreeBSD

Common Craft commands

Installing a package and its dependencies

craft packagename

Updating an installed package: Once you have packagename built, type:

craft -i packagename

Searching for a package

craft --search packagename

Switching to the source directory of a package:

cs packagename

Switching to the build directory of a package:

cb packagename

Just compiling the package (i.e. if you just modified the source code and want to test-compile):

craft --compile packagename

Create an installer (or .dmg bundle, ...) for a specific package. The option Packager/PackageType in CraftSettings.ini controls which type of package is created:

craft --package kdevelop

Updating Craft itself:

craft craft

Updating the blueprints:

craft -i craft-blueprints-kde

Adding new blueprints

Blueprints are stored in separate repositories. At the moment there are these repositories:

To navigate to this repository on your local file system, type in:

cs craft-blueprints-kde

Open a file browser in that folder and start adding new recipes by copying from existing ones. Note that the name of the package folder needs to match the blueprint name -- an example would be "kdegraphics-mobipocket\kdegraphics-mobipocket.py"

Advanced tips

Hardcode versions of packages

To build a non default version,edit $craftRoot/etc/BlueprintSettings.ini and add:

[category/packagename]
version = branch

To find the category of the package you want to install, run this:

craft --search packagename

The second line of the output will be of form: category/packagename

For example, to install master branch of khtml, the line to be appended should look like:

[frameworks/khtml]
version = master

To change the version of a complete branch, like libs/qt5 add

 [libs/qt5]
 version = 5.9.3

Using the 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

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 $HOME/.craft (%USERPROFILE%\.craft on Windows) which will contain much more details.

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

News

Blog

Getting in Touch