Toggle the table of contents

Craft: Difference between revisions

From KDE Community Wiki

Latest revision as of 19:12, 8 March 2024

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, FreeBSD and Android.

Setting up Craft

Start crafting on Windows

Start crafting on Linux

Start crafting on macOS

Start crafting on FreeBSD

Start crafting on Android

Common Craft commands

Searching for a package

craft --search packagename

Installing a package and its dependencies

craft packagename

Note that installing prebuilt packages (libraries and some apps which are common dependencies of others) won't immediately generate their source directories. If you need them, see Installing a prebuilt package.

Uninstalling a package

craft --unmerge packagename

Updating a package

craft -i packagename

Updating Craft itself

craft -i craft

Updating Craft's KDE blueprints

craft -i craft-blueprints-kde

Updating all installed packages

craft --upgrade

Changing to the source directory of a package

cs packagename

Changing to the build directory of a package

cb packagename

Compiling a package

To compile and install a package for testing after modifying its source code, run

craft --compile --install --qmerge packagename

Creating an installer

To create a MacOS .dmg bundle, Windows .exe installer or Linux .AppImage for a package, run

craft --package packagename

When packaging for Windows, the PackageType option in CraftSettings.ini controls the type of installer created. Read the comments above it for more information.

If the package's source code has been modified, don't forget to compile and install it before creating a new installer.

Installing a prebuilt package

Libraries and certain apps which are common dependencies of other packages (such as Kate) will be pulled as prebuilt binaries from the "cache" stored on and built by KDE's servers, instead of their sources being cloned and built on your system. This is done to shorten compile times. The --no-cache option overrides this behavior, in case modifying the sources of prebuilt packages is necessary:

craft -i --no-cache packagename

Adding new blueprints

If you want to build a new application using Craft, you'll need a blueprint for it and all its dependencies first. Learn more about writing blueprints at Craft/Blueprints.

Advanced tips

Hard-code versions of packages

For non-prebuilt packages, the last release compatible with your environment is built by default. To build a non-default version, run

craft --set version=versionname packagename

Replace versionname with the desired branch name (like master) or a specific version number (like 0.57.0).

The version can also be set for an entire category, for example, for the KDE Frameworks, run

craft --set version=versionname kde/frameworks

Alternatively, you may also edit BlueprintSettings.ini:

[category/packagename]
version = versionname

Using Craft with an IDE

Using Craft with Qt Creator

To compile packages from within Qt Creator, we'll need to start it from a shell with the Craft environment set up:

$ source CraftRoot/craft/craftenv.sh
$ qtcreator

Now fire up another shell with the Craft environment set up as well. If you haven't already, install the package you want to work on. Now change to its source directory and take note of the path you've been switched to.

Back in Qt Creator, press Ctrl+O to open a project, and navigate to the aforementioned source directory. Inside of it, select the CMakeLists.txt file. Ensure you're looking at the Projects tab by pressing Ctrl+5 and make sure only the kit ending in in PATH (CraftRoot) is selected, then press the Configure Project button and let Qt Creator finish importing everything.

You can now try to start a build to see if everything went well!

Using Craft with VS Code

Note that this example demonstrates working on KDEConnect, but the same instructions should apply to other packages as well.

To use the debugging capabilities of VS Code, we will create a .code-workspace file and update it according to our use case. Create kde.code-workspace and paste one of the following example workspace configurations into it:

Windows development

Linux development

Now edit it according to your setup. Additional information can be found at https://code.visualstudio.com/docs/editor/workspaces.

Debugging a standalone app with symbols

Craft uses the RelWithDebInfo build type by default. As such, every library and executable is compiled with the release symbols stripped from its main file and saved separately in a corresponding .pdb file on Windows or .dSYM package on MacOS.

These symbols will not be included in the final redistributable package generated by Craft using the --package option, however, if PackageDebugSymbols is enabled in CraftSettings.ini, a separate archive will be created containing all the debug symbols.

If an issue you're trying to debug is specific to the packaged app only, you can use Qt Creator's Start and Debug External Application option to run the packaged app and automatically attach to it.

Example for packaged MacOS apps:

In Local Executable, provide a path to the executable file inside the .app container, such as /Volumes/External/CraftRoot/build/extragear/kmymoney/archive/Applications/KDE/kmymoney.app/Contents/MacOS/kmymoney
In Debug information provide a path to the folder containing the debug symbols package (kmymoney.app.dSYM) generated by Craft, such as /Volumes/External/CraftRoot/build/extragear/kmymoney/image-RelWithDebInfo-master/Applications/KDE
Check Break at main if this is your initial setup to make sure everything works as expected
Optionally add the Source Paths Mapping under Preferences -> Debugger if your local source code location doesn't match the one used to generate the package being debugged, resulting in the main() break showing disassembled code.

Troubleshooting

If a package fails to build, you'll probably be greeted with something similar to:

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 for errors, or have a look at the log file located in $HOME/.craft on MacOS/Linux and %USERPROFILE%\.craft on Windows, which should contain more details. You can additionally grep this file for the phrase error, narrowing down your search.

Getting in Touch

Matrix: #kde-craft:kde.org (bridged to IRC)

IRC: #kde-craft on Libera Chat (web chat)

Bugzilla

Mailing list: [email protected] (subscribe, archives)

Retrieved from "https://community.kde.org/index.php?title=Craft&oldid=100301"

@@ Line 1: / Line 1: @@
-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''.
+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, FreeBSD and Android.
 == Setting up Craft ==
-[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Windows Start crafting on Windows]
+[[Guidelines_and_HOWTOs/Build_from_source/Windows|Start crafting on Windows]]
-[https://community.kde.org/Craft/Linux Start crafting on Linux]
+[[/Linux|Start crafting on Linux]]
-[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Mac#Installation_using_Craft Start crafting on Mac]
+[[Guidelines and HOWTOs/Build from source/Mac|Start crafting on macOS]]
-[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/FreeBSD Start crafting  on FreeBSD]
+[[Guidelines_and_HOWTOs/Build_from_source/FreeBSD|Start crafting on FreeBSD]]
+[https://develop.kde.org/docs/packaging/android/building_applications/ Start crafting on Android]
 == Common Craft commands ==
-====== Searching for a package ======
+=== Searching for a package ===
-  craft --search packagename
+  craft --search ''packagename''
-====== Installing a package (and dependencies) ======
+=== Installing a package and its dependencies ===
-  craft packagename
+  craft ''packagename''
-====== Uninstalling a package ======
+Note that installing prebuilt packages (libraries and some apps which are common dependencies of others) won't immediately generate their [[Craft#Changing to the source directory of a package|source directories]]. If you need them, see [[Craft#Installing a prebuilt package|Installing a prebuilt package]].
- craft --unmerge packagename
-====== Updating a package ======
+=== Uninstalling a package ===
-  craft -i packagename
+  craft --unmerge ''packagename''
-====== Switching to the source directory of a package ======
+=== Updating a package ===
-  cs packagename
+  craft -i ''packagename''
-====== Switching to the build directory of a package ======
+==== Updating Craft itself ====
-  cb packagename
+  craft -i craft
-====== Compiling a package ======
+==== Updating Craft's KDE blueprints ====
-if you just modified the source code and want to test-compile:
+ craft -i craft-blueprints-kde
- craft --compile packagename
-====== Creating an installer ======
+==== Updating all installed packages ====
-<code>.dmg</code> bundle, <code>.exe</code> setup, ... for a specific package:
+  craft --upgrade
-  craft --package packagename
-The option <code>Packager/PackageType</code> in <tt>CraftSettings.ini</tt> controls which type of installer is created
-==== Developing with Craft ====
+=== Changing to the source directory of a package ===
+ cs ''packagename''
-====== Installing a library ======
+=== Changing to the build directory of a package ===
-When developing on a specific application, you may want to develop on its library as well.
+ cb ''packagename''
-  craft -i --no-cache <somelib>
-<code>--no-cache</code> also disables the cache for all missing/outdated dependencies.
-====== Testing new changes ======
-For the applications to run with changes to the source of the package:
-  craft --compile --install --qmerge <somelib>
-===== Examples =====
+=== Compiling a package ===
+To compile and install a package for testing after modifying its source code, run
+ craft --compile --install --qmerge ''packagename''
-====== Updating Craft itself ======
+=== Creating an installer ===
-  craft -i craft
+To create a MacOS <code>.dmg</code> bundle, Windows <code>.exe</code> installer or Linux <code>.AppImage</code> for a package, run
+  craft --package ''packagename''
-====== Updating the blueprints ======
+When packaging for Windows, the <code>PackageType</code> option in <code>CraftSettings.ini</code> controls the type of installer created. Read the comments above it for more information.
- craft -i craft-blueprints-kde
-== Adding new blueprints ==
+If the package's source code has been modified, don't forget to [[Craft#Compiling a package|compile and install]] it before creating a new installer.
-Blueprints are stored in separate repositories. At the moment there are these repositories:
+=== Installing a prebuilt package ===
-* https://cgit.kde.org/craft-blueprints-kde.git/tree/ (enabled by default)
+Libraries and certain apps which are common dependencies of other packages (such as [[Kate]]) will be pulled as prebuilt binaries from the "cache" [https://files.kde.org/craft/ stored on] and built by KDE's servers, instead of their sources being cloned and built on your system. This is done to shorten compile times. The <code>--no-cache</code> option overrides this behavior, in case modifying the sources of prebuilt packages is necessary:
-<br/>
+  craft -i --no-cache ''packagename''
-To navigate to this repository on your local file system:
-  cs craft-blueprints-kde
-Open a file browser in that folder and start adding new recipes by copying from existing ones.
+== Adding new blueprints ==
+If you want to build a new application using Craft, you'll need a blueprint for it and all its dependencies first. Learn more about writing blueprints at [[Craft/Blueprints]].
-Note that the name of the package folder needs to match the blueprint name. An example would be <code>kdegraphics-mobipocket\kdegraphics-mobipocket.py</code>
 == Advanced tips ==
-=== Hardcode versions of packages ===
+=== Hard-code versions of packages ===
-Packages are by-default installed from the cache. To build a non default version (or to build from master)
+For non-prebuilt packages, the last release compatible with your environment is built by default. To build a non-default version, run
-<pre> craft --set version=some_version packagename</pre>
+ craft --set version=''versionname'' ''packagename''
-Here, replace <code>some_version</code> with the branch name of the source git repository of the package (like <code>master</code>) or version number (for eg: 0.57.0, 0.58.0).
+Replace <code>''versionname''</code> with the desired branch name (like <code>master</code>) or a specific version number (like <code>0.57.0</code>).
-Alternatively ,edit <tt>$CraftRoot/etc/BlueprintSettings.ini</tt> and add:
-<pre> [category/packagename]
+The version can also be set for an entire category, for example, for the KDE Frameworks, run
-  version = branch
+  craft --set version=''versionname'' kde/frameworks
-</pre>
-====== Examples ======
+Alternatively, you may also edit <code>BlueprintSettings.ini</code>:
+<syntaxhighlight lang="ini">
+[category/packagename]
+version = versionname
+</syntaxhighlight>
-For example, to install master branch of khtml, the line to be appended should look like:
+== Using Craft with an IDE ==
-  [frameworks/khtml]
+=== Using Craft with Qt Creator ===
-  version = master
+To compile packages from within Qt Creator, we'll need to start it from a shell with the Craft environment set up:
+  $ source ''CraftRoot''/craft/craftenv.sh
+  $ qtcreator
-To change the version of all packages of a category, like <code>libs/qt5</code> add
+Now fire up another shell with the Craft environment set up as well. If you haven't already, [[Craft#Installing a package and its dependencies|install]] the package you want to work on. Now [[Craft#Changing to the source directory of a package|change to its source directory]] and take note of the path you've been switched to.
-  [libs/qt5]
+Back in Qt Creator, press <code>Ctrl+O</code> to open a project, and navigate to the aforementioned source directory. Inside of it, select the <code>CMakeLists.txt</code> file. Ensure you're looking at the ''Projects'' tab by pressing <code>Ctrl+5</code> and make sure only the kit ending in <code>in PATH (CraftRoot)</code> is selected, then press the ''Configure Project'' button and let Qt Creator finish importing everything.
-  version = 5.9.3
-==Using Craft with Qt Creator==
+You can now try to start a build to see if everything went well!
-===Windows===
+=== Using Craft with VS Code ===
-To compile from within Qt Creator, I need to set up a kit.
+Note that this example demonstrates working on [[KDEConnect]], but the same instructions should apply to other packages as well.
-This is an example for mingw64.
-* Add a cmake if none is set: C:\CraftRoot\dev-utils\cmake\bin\cmake.exe
-* Add a debugger: C:\CraftRoot\mingw64\bin\gdb.exe
-* Add a C++ compiler and a C compiler. Both: C:\CraftRoot\mingw64\bin\gcc.exe
-** Ensure that the ABI is correctly set
-* Add a Qt: C:\CraftRoot\bin\qmake.exe
-* Add a kit with all of the above
-* Edit the Environment:
-** '''PATH=$(PATH);C:\CraftRoot\bin;C:\CraftRoot\dev-utils\bin\; C:\CraftRoot\mingw64\bin'''
-* Use the kit on a project
-* Setup cmake configuration (all case):
+To use the debugging capabilities of VS Code, we will create a <code>.code-workspace</code> file and update it according to our use case. Create <code>kde.code-workspace</code> and paste one of the following example workspace configurations into it:
-** Extend CMAKE_PREFIX_PATH, add the Craft prefix path (ie: CMAKE_PREFIX_PATH:STRING=%{Qt:QT_INSTALL_PREFIX};C:\CraftRoot)
+:[https://gist.github.com/tm9k1/2312937dbdda73b366d02829078540af Windows development]
+:[https://gist.github.com/tm9k1/6267b5013e4415a3bd02a026bb0c6393 Linux development]
-===MacOS===
+Now [https://gist.github.com/tm9k1/2312937dbdda73b366d02829078540af?permalink_comment_id=3762477#gistcomment-3762477 edit] it according to your setup. Additional information can be found at https://code.visualstudio.com/docs/editor/workspaces.
-To be able to use Craft libs in your cmake project from QtCreator follow these steps:
-* If the QtVersion used by Craft is not already registered in QtC, then create a new QtVersion by pointing it to the qmake used by Craft
-* Create a new kit by duplicating an existing one or creating a new one from scratch
-* Setup properties of the kit (for from scratch kit):
-** Set cmake binary to the one used by Craft
-** Set debugger binary to the one used by Craft
-** Set C++ and C compiler to the one used by Craft
-** Select the correct QtVersion
-** Ensure abi is correct
-* Setup cmake configuration (all case):
-** Extend CMAKE_PREFIX_PATH, add the Craft prefix path (ie: CMAKE_PREFIX_PATH:STRING=%{Qt:QT_INSTALL_PREFIX};/Volumes/Projects/Developers/Craft)
-* Edit the Environment:
-** '''PATH=$(PATH):~/CraftRoot/bin:~/CraftRoot/dev-utils/bin/'''
-** '''QT_PLUGIN_PATH=~/CraftRoot/bin/plugins'''
-* Apply, and now use this Kit for your cmake project
-== Debugging standalone app with symbols ==
+== Debugging a standalone app with symbols ==
-Craft by default uses RelWithDebInfo build type. As such, each library and executable is compiled with the release symbols stripped from the main file and saved separately in a corresponding .pdb file on Windows and .dSYM package on Mac.
+Craft uses the <code>RelWithDebInfo</code> build type by default. As such, every library and executable is compiled with the release symbols stripped from its main file and saved separately in a corresponding <code>.pdb</code> file on Windows or <code>.dSYM</code> package on MacOS.
-Those symbols will not be included in a final redistributable package generated by craft (--package option). However, if PackageDebugSymbols is enabled in CraftSettings.ini, a separate archive will be created will all the debug symbols combined.
+These symbols will not be included in the final redistributable package generated by Craft using the <code>--package</code> option, however, if <code>PackageDebugSymbols</code> is enabled in <code>CraftSettings.ini</code>, a separate archive will be created containing all the debug symbols.
-If an issue you're trying to debug is specific to a packaged app only, you can use Qt Creator's Debug -> Start and Debug External Application option to run the external app (the packaged one) and attach to it:
+If an issue you're trying to debug is specific to the packaged app only, you can use Qt Creator's ''Start and Debug External Application'' option to run the packaged app and automatically attach to it.
-* In "Local Executable" provide a path to executable file inside the .app container, e.g. /Volumes/External/CraftRoot/build/extragear/kmymoney/archive/Applications/KDE/kmymoney.app/Contents/MacOS/kmymoney
+Example for packaged MacOS apps:
-* In "Debug information" provide a path to debug symbols package generate by craft, e.g.  /Volumes/External/CraftRoot/build/extragear/kmymoney/image-RelWithDebInfo-master/Applications/KDE
+* In ''Local Executable'', provide a path to the executable file inside the <code>.app</code> container, such as <code>/Volumes/External/CraftRoot/build/extragear/kmymoney/archive/Applications/KDE/kmymoney.app/Contents/MacOS/kmymoney</code>
+* In ''Debug information'' provide a path to the folder containing the debug symbols package (<code>kmymoney.app.dSYM</code>) generated by Craft, such as <code>/Volumes/External/CraftRoot/build/extragear/kmymoney/image-RelWithDebInfo-master/Applications/KDE</code>
+* Check ''Break at main'' if this is your initial setup to make sure everything works as expected
+* Optionally add the ''Source Paths Mapping'' under ''Preferences -> Debugger'' if your local source code location doesn't match the one used to generate the package being debugged, resulting in the <code>main()</code> break showing disassembled code.
 == Troubleshooting ==
+If a package fails to build, you'll probably be greeted with something similar to:
+ 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
-If a package fails to build, you'll be greeted with something like:
+In order to figure out what failed, grep the command line output for errors, or have a look at the log file located in <code>$HOME/.craft</code> on MacOS/Linux and <code>%USERPROFILE%\.craft</code> on Windows, which should contain more details. You can additionally grep this file for the phrase <code>error</code>, narrowing down your search.
-  ...
-  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 ==
+* Matrix: [https://matrix.to/#/#kde-craft:kde.org #kde-craft:kde.org] (bridged to IRC)
-* IRC: [irc://irc.freenode.net/kde-windows #kde-craft] on freenode (join via web chat: http://webchat.freenode.net/?channels=kde-craft)
+* IRC: [irc://irc.libera.chat/kde-craft #kde-craft] on Libera Chat ([http://web.libera.chat/#kde-craft web chat])
-* [https://bugs.kde.org/enter_bug.cgi?product=Craft Report bugs]
+* [https://bugs.kde.org/enter_bug.cgi?product=Craft Bugzilla]
 * 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])