Craft: Difference between revisions

From KDE Community Wiki
(Add notes about packaging)
(13 intermediate revisions by 3 users not shown)
Line 5: Line 5:
[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/Guidelines_and_HOWTOs/Build_from_source/Mac Start crafting on Mac]
[https://community.kde.org/Craft/Linux Start crafting on Linux]
 
[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/Mac#Installation_using_Craft Start crafting on Mac]


[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/FreeBSD Start crafting  on FreeBSD]
[https://community.kde.org/Guidelines_and_HOWTOs/Build_from_source/FreeBSD Start crafting  on FreeBSD]
Line 15: Line 17:
Updating an installed package: Once you have ''packagename'' built, type:  
Updating an installed package: Once you have ''packagename'' built, type:  
  craft -i packagename
  craft -i packagename
Searching for a package
craft --search packagename
Switching to the source directory of a package:
Switching to the source directory of a package:
  cs packagename
  cs packagename
Line 27: Line 31:
  craft craft
  craft craft
Updating the blueprints:
Updating the blueprints:
  craft --fetch craft-blueprints-kde
  craft -i craft-blueprints-kde


== Adding new blueprints ==
== Adding new blueprints ==
Line 43: Line 47:
=== Hardcode versions of packages ===
=== Hardcode versions of packages ===


To build a non default version, append a line to $craftRoot/etc/CraftSettings.ini of form:
To build a non default version,edit $craftRoot/etc/BlueprintSettings.ini and add:


  [BlueprintVersions]
  [category/packagename]
  category/packagename = branch
  version = branch


For example, to install master branch of kdevelop, the line to be appended should look like:
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>


[BlueprintVersions]
For example, to install master branch of khtml, the line to be appended should look like:
frameworks/khtml = master


Or if you want to hardcode the version of a "meta" group containing a ''version.ini'':
  [frameworks/khtml]
  version = master
  [BlueprintVersions]
  Qt5 = 5.9


=== Finding packages ===
To change the version of a complete branch, like libs/qt5 add
To find the package you want to install, run this:
 
craft --search packagename
  [libs/qt5]
  version = 5.9.3
 
 
==Using Craft with Qt Creator==


The second line of the output will be of form: <tt>category/packagename</tt>
===Windows===
To compile from within Qt Creator, I need to set up a kit.
This is an example for mingw64.
* Add a cmake if none is set: R:\dev-utils\cmake\bin\cmake.exe
* Add a debugger: R:\mingw64\bin\gdb.exe
* Add a C++ compiler and a C compiler. Both: R:\mingw64\bin\gcc.exe
** Ensure that the ABI is correctly set
* Add a Qt: R:\bin\qmake.exe
* Add a kit with all of the above
* Use the kit on a project


=== Using the Qt SDK===
* Setup cmake configuration (all case):
This will skip all Qt packages and use the official Qt builds instead.
** Extend CMAKE_PREFIX_PATH, add the Craft prefix path (ie: CMAKE_PREFIX_PATH:STRING=%{Qt:QT_INSTALL_PREFIX};C:/CraftRoot/)
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:
===MacOS===
    [QtSDK]
To be able to use Craft libs in you cmake project from QtCreator follow those steps:
    ## Whether to use prebuild Qt binaries.
* 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
    Enabled = True
* Create a new kit by duplicating an existing one or creating a new one from scratch
    ## The path to the Qt sdk.
* Setup properties of the kit (for from scratch kit):
    Path = C:\Qt
** Set cmake binary to the one used by Craft
    ## The version of Qt.
** Set debugger binary to the one used by Craft
    Version = 5.9
** Set C++ and C compiler to the one used by Craft
    ## The compiler version, if you are not sure what to use, have a look into the derectory set in QtSDK/Path.
** Select the correct QtVersion
    ## The compiler must be of the same type as General/KDECOMPILER.
** Ensure abi is correct
    ## If you are using mingw please make sure you have installed the mingw using the Qt installer.
* Setup cmake configuration (all case):
    Compiler = msvc2017_64
** Extend CMAKE_PREFIX_PATH, add the Craft prefix path (ie: CMAKE_PREFIX_PATH:STRING=%{Qt:QT_INSTALL_PREFIX};/Volumes/Projects/Developers/Craft)
* Apply, and now use this Kit for your cmake project


== Troubleshooting ==
== Troubleshooting ==

Revision as of 12:14, 26 April 2018

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 Craft with Qt Creator

Windows

To compile from within Qt Creator, I need to set up a kit. This is an example for mingw64.

  • Add a cmake if none is set: R:\dev-utils\cmake\bin\cmake.exe
  • Add a debugger: R:\mingw64\bin\gdb.exe
  • Add a C++ compiler and a C compiler. Both: R:\mingw64\bin\gcc.exe
    • Ensure that the ABI is correctly set
  • Add a Qt: R:\bin\qmake.exe
  • Add a kit with all of the above
  • Use the kit on a project
  • Setup cmake configuration (all case):
    • Extend CMAKE_PREFIX_PATH, add the Craft prefix path (ie: CMAKE_PREFIX_PATH:STRING=%{Qt:QT_INSTALL_PREFIX};C:/CraftRoot/)

MacOS

To be able to use Craft libs in you cmake project from QtCreator follow those 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)
  • Apply, and now use this Kit for your cmake project

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