Guidelines and HOWTOs/Build from source/Mac: Difference between revisions

From KDE Community Wiki
(remove some dupes)
(Add macOS filesystem case-sensitivity information)
(22 intermediate revisions by 5 users not shown)
Line 1: Line 1:
== Overview ==


* Install Qt (use the official Qt installer, recommended version Qt >= 5.6)
Several methods of building KDE / KF5 on Mac are available, and it is not firmly established, yet, which one is "best". The two main approaches are using either a "stock" version of Qt, or a "patched" Qt. The latter has several patches meant to make KF5-applications work better on Mac. It also follows the file system layout of KDE on Linux, which should mean that KDE applications will be more likely to work correctly, without adjustments.


* Install homebrew and get some basic dependencies (http://brew.sh/)
There is some hope that the required patches will eventually become available in official Qt packages, but this is not the case as of this writing. The main drawback with this is that Qt has to be compiled on your computer, adding hours to your setup time. The main advantage is that most things can be expected to work out of the box.
/usr/bin/ruby -e "$(curl -fsSL https://raw.githubusercontent.com/Homebrew/install/master/install)"
brew install cmake wget coreutils p7zip gettext ninja python3 bison boost shared-mime-info


* Prepare some build directory in your home directory, here we assume:
== Installation using patched version of Qt and MacPorts ==
mkdir ~/kf


* Switch to this build dir
* [https://guide.macports.org/#installing.macports Install Macports]
  cd ~/kf
** Note: If you have an existing installation of MacPorts ''and'' installed ports that depend on Qt, see [https://mail.kde.org/pipermail/kde-mac/2017-June/005280.html this mail].
* Install git, if you don't have it yet:
sudo port install git
* Get the ports tree for patched qt and frameworks:
# We assume you're doing this in your home directory
  cd ~
git clone https://github.com/mkae/macstrop.git
# create index
cd macstrop
portindex
* [https://guide.macports.org/chunked/development.local-repositories.html Register the new ports with Macports]. To do so, edit ${prefix}/etc/macports/sources.conf, where prefix is the root path of your MacPorts installation (/opt/local by default). Add the following line ''above'' any other path specifications (thus making sure it will take precedence):
file:///Users/YourUserName/macstrop


* Get Craft
It is recommended that you build the patched Qt before any frameworks, in order to make extra sure all dependencies are resolved, correctly:
  git clone git://anongit.kde.org/craft.git
  sudo port install qt5-kde


* Copy Mac OS X config template to right location, should be OK to use out of the box
You can now start building frameworks or applications (if already packaged), using e.g.
  mkdir etc
sudo port install kf5-parts
  cp craft/kdesettings.mac etc/kdesettings.ini
  sudo port install kf5-kate
  sudo port install kf5-frameworkintegration    # will get the most common frameworks in one go


* Optional: You might need some extra environment variables
Many ports have additional variants, such as "+docs" for handbooks / API documentation:
sudo port install kf5-kate +docs
port variants kf5-kate      # list available variants
port notes kf5-kate            # show any notes


  export CMAKE_LIBRARY_PATH=/usr/local/Cellar/gettext/0.19.8.1/lib
== Installation using Craft ==
  export CMAKE_INCLUDE_PATH=/usr/local/Cellar/gettext/0.19.8.1/include
 
  export PATH=/usr/local/Cellar/bison/3.0.4/bin:$PATH


* Setup environment (path must contain your Qt install, here 5.7 default location and brew's gettext)
* Install [https://www.python.org/downloads/ Python 3]
  export PATH=/Users/cullmann/Qt5.7.0/5.7/clang_64/bin:/usr/local/Cellar/gettext/0.19.7/bin:$PATH
* Install [https://developer.apple.com/xcode/ XCode] (at least developper command-line tools suffice):
  . craft/kdeenv.sh
  xcode-select --install
 
=== Install Craft ===
  curl https://raw.githubusercontent.com/KDE/craft/master/setup/CraftBootstrap.py -o setup.py && python3 setup.py --prefix ~/CraftRoot
 
'''Note''': At the time of this writing, with a fresh installation of Python 3.7 or 3.8, this command will fail with "certificate verify failed: unable to get local issuer certificate". To fix this, run the following, ''once'':
  /Applications/Python[Version]/Install/Certificates.command
 
=== Using craft ===
* Every time you want to use craft in a new shell, you need to set up the craft environment, first:
  source ~/CraftRoot/craft/craftenv.sh


* In this shell, now craft is usable, e.g. to build Kate with all dependencies:
* In this shell, now craft is usable, e.g. to build Kate with all dependencies:
  craft kate
  craft kate


* To create a app bundle (+ dmg file), you need to have the breeze-icons around:
=== Case sensitive filesystem considerations ===
craft breeze-icons
 
When building craft packages on case-sensitive filesystem, you will see errors in packages referencing some of the KF5 libraries:
    fatal error: 'sonnet/highlighter.h' file not found
 
This is a known upstream issue: https://bugs.kde.org/show_bug.cgi?id=419167


* To do deploy all things, unfortunately at the moment you need a patched macdeployqt. Example scripty for kate can be found on [https://quickgit.kde.org/?p=kate.git&a=blob&f=mac%2Femerge-deploy.sh kate.git/mac/emerge-deploy.sh]
The workaround for now is either to create and mount a case-insensitive disk image for craft usage or to manually create symlinks as needed.

Revision as of 20:27, 26 March 2020

Overview

Several methods of building KDE / KF5 on Mac are available, and it is not firmly established, yet, which one is "best". The two main approaches are using either a "stock" version of Qt, or a "patched" Qt. The latter has several patches meant to make KF5-applications work better on Mac. It also follows the file system layout of KDE on Linux, which should mean that KDE applications will be more likely to work correctly, without adjustments.

There is some hope that the required patches will eventually become available in official Qt packages, but this is not the case as of this writing. The main drawback with this is that Qt has to be compiled on your computer, adding hours to your setup time. The main advantage is that most things can be expected to work out of the box.

Installation using patched version of Qt and MacPorts

  • Install Macports
    • Note: If you have an existing installation of MacPorts and installed ports that depend on Qt, see this mail.
  • Install git, if you don't have it yet:
sudo port install git 
  • Get the ports tree for patched qt and frameworks:
# We assume you're doing this in your home directory
cd ~
git clone https://github.com/mkae/macstrop.git
# create index
cd macstrop
portindex
  • Register the new ports with Macports. To do so, edit ${prefix}/etc/macports/sources.conf, where prefix is the root path of your MacPorts installation (/opt/local by default). Add the following line above any other path specifications (thus making sure it will take precedence):
file:///Users/YourUserName/macstrop

It is recommended that you build the patched Qt before any frameworks, in order to make extra sure all dependencies are resolved, correctly:

sudo port install qt5-kde

You can now start building frameworks or applications (if already packaged), using e.g.

sudo port install kf5-parts
sudo port install kf5-kate
sudo port install kf5-frameworkintegration     # will get the most common frameworks in one go

Many ports have additional variants, such as "+docs" for handbooks / API documentation:

sudo port install kf5-kate +docs
port variants kf5-kate       # list available variants
port notes kf5-kate            # show any notes

Installation using Craft

  • Install Python 3
  • Install XCode (at least developper command-line tools suffice):
xcode-select --install

Install Craft

 curl https://raw.githubusercontent.com/KDE/craft/master/setup/CraftBootstrap.py -o setup.py && python3 setup.py --prefix ~/CraftRoot

Note: At the time of this writing, with a fresh installation of Python 3.7 or 3.8, this command will fail with "certificate verify failed: unable to get local issuer certificate". To fix this, run the following, once:

 /Applications/Python[Version]/Install/Certificates.command

Using craft

  • Every time you want to use craft in a new shell, you need to set up the craft environment, first:
source ~/CraftRoot/craft/craftenv.sh
  • In this shell, now craft is usable, e.g. to build Kate with all dependencies:
craft kate

Case sensitive filesystem considerations

When building craft packages on case-sensitive filesystem, you will see errors in packages referencing some of the KF5 libraries:

   fatal error: 'sonnet/highlighter.h' file not found

This is a known upstream issue: https://bugs.kde.org/show_bug.cgi?id=419167

The workaround for now is either to create and mount a case-insensitive disk image for craft usage or to manually create symlinks as needed.