Compiler Kate
Compilation de Kate à partir de sources sous Linux
À l'heure actuelle, le code source de Kate est disponible sur l'instance de GitLab invent.kde.org. Ce tutoriel explique comment compiler Kate sans modifier votre installation globale.
Toutes les choses seront réalisées dans un dossier de développement supplémentaire. Cela évite le besoin de droits d'administrateur et permet toujours de revenir à l'utilisation de la version installée sur le système de Kate si la version actuellement compilée est défaillante.
Comme ce tutoriel introduira une configuration permettant de développer d'autres parties de l'ensemble des logiciels de KDE, les prochains sujets concerneront la configuration d'un environnement de développement KDE. Les environnements de développement de KDE nécessaires seront compilés en plus des parties de l'application Kate. Cela facilite les contributions à tous les niveaux de l'ensemble des logiciels KDE.
Sélectionnez votre dossier de développement pour Kate & KDE
Sélectionnez vous même un emplacement où tous les éléments de développement de Kate & KDE devraient se retrouver. En dehors des fichiers de configuration locale utilisateur, rien en dehors de ce dossier ne sera altéré. Vous pouvez réutiliser ceci pour le développement de n'importe quelle partie du catalogue de logiciels de KDE.
Pour les parties restantes de cette description, nous utilisons
~/projects/kde
N'hésitez pas à personnaliser ceci.
Installer le script « kdesrc-build »
L'installation consiste plus ou moins à simplement cloner la version actuelle
mkdir -p ~/projects/kde/src
cd ~/projects/kde/src
git clone https://invent.kde.org/sdk/kdesrc-build.git
Pour plus de facilité d'utilisation, il vaut mieux ajouter un lien symbolique pour le script « kdesrc-build » vers un dossier à l'intérieur de votre projet, par exemple, si vous avez un dossier utilisateur local :
ln -s ~/projects/kde/src/kdesrc-build/kdesrc-build ~/bin
Configuration du script « kdesrc-build »
Le script « kdesrc-build » intègre une phase de paramétrage, pouvant configurer des choses pour vous. Veuillez consulter cette introduction.
Nous affichons ici, tout simplement un fichier ** ~/.config/kdesrc-buildrc **, suffisamment complet pour les besoins de développement de Kate.
Vous pouvez simplement copier et coller la variante ci-dessous dans votre dossier personnel comme « ~/.config/kdesrc-buildrc » et adapter les emplacements selon vos besoins. Si vous vous en tenez à l'emplacement ~/projects/kde que nous avons choisi ci-dessus, cela devrait être utilisable 1: 1.
global
# Utiliser les versions les plus à jour des logiciels reposant sur KF6 et Qt6.
branch-group kf6-qt6
# Veuillez utiliser « ninja » pour des compilations incrémentales plus rapides et désactiver
# certains éléments de Qt5 pour avoir moins de dépendances.
cmake-options -G "Ninja" -DBUILD_WITH_QT6=ON -DQT_MAJOR_VERSION=6 -DPHONON_BUILD_QT5=OFF -DBUILD_QT5=OFF
# Outillage pour le processus « clangd »
compile-commands-export yes
compile-commands-linking yes
# Structure à plat
directory-layout flat
# Dossier d'installation des logiciels de KDE
install-dir ~/projects/kde/usr
# Dossier pour les codes source téléchargés
source-dir ~/projects/kde/src
# Dossier pour y enregistrer les compilations des logiciels de KDE avant d'en faire
# l'installation par défaut dans le dossier « source-dir »
build-dir ~/projects/kde/build
end global
include ${module-definitions-dir}/kf6-qt6.ksb
Les points importants pour avoir une bonne expérience de développement de Kate (Ou d'autres éléments de KDE) avec Kate sont décrits ci-dessous en détails.
Intégration « LSP »
# Outillage pour le processus « clangd »
compile-commands-export yes
compile-commands-linking yes
Ces lignes garantissent que la commande « CMake» générera les fichiers compile_commands.json, nécessaires à l'intégration « LSP ». En plus de leurs générations à l'intérieur du dossier de compilation, l'option de liaison créera des liens symboliques « symlink » vers vos dossiers de sources. Cela permet une utilisation dans aucune configuration du module externe « LSP » à l'intérieur de Kate (et d'autres éditeurs).
Installer les dépendances nécessaires (Facultatif)
Le script kdesrc-build fournit un certain mode initial de paramétrage pour l'installation des paquets nécessaires à plusieurs distributions courantes pour permettre de démarrer le développement. Ceci est utile si vous ne savez pas si tous les paquets nécessaires au développement sont installés sur votre système et que vous ne voulez pas vous en occuper vous-même manuellement. **Comme cela essaiera d'installer des paquets pour votre distribution, cette étape nécessitera des droits d'administrateur pour l'installation de paquets. **Pour ce faire, il suffit de déclencher :
kdesrc-build --initial-setup
Nous avons déjà créé un fichier .config/kdesrc-buildrc, qui restera intact. Pour une utilisation ultérieure, vous n'avez pas non plus besoin de modifier les paramètres de votre shell.
Compiler Kate & ses dépendances
Pour déclencher une compilation de Kate et toutes les dépendances de KDE nécessaires, veuillez saisir maintenant, tout simplement :
kdesrc-build --include-dependencies kate
Ceci prend quelques minutes sur une machine récente, juste le temps de prendre un café ou de réfléchir à ce que vous voulez réellement développer.
Tant que la version « KF 6 » de nos dépendances n'est pas fournie avec votre distribution, il peut être judicieux de compiler certaines parties pour avoir de meilleurs effets de style et une meilleure intégration de terminal :
kdesrc-build --include-dependencies breeze plasma-integration kwayland-integration konsole kate
Si vous voulez uniquement compiler Kate sans les dépendances parce que vous êtes sûr d'avoir suffisamment de choses sur votre système, vous pouvez essayer :
kdesrc-build --no-include-dependencies kate
Mais étant donné que sur les ordinateurs modernes, les temps de compilation sont faibles, il est plus confortable de simplement compiler toutes les modules, ce qui vous garantit d'avoir, par exemple, les derniers et les meilleurs environnements de développement pour KSyntaxHighlighting et KTextEditor !
Compte tenu de cette configuration, vous êtes libre de compiler tous les modules des logiciels de KDE avec un simple :
kdesrc-build
Gardez à l'esprit : cela prendra un peu de temps (Et de l'espace disque).
Si pendant la compilation, vous voyez des erreurs affichées avec une police rouge, veuillez suivre ce guide - Comment résoudre des problèmes de compilation.
Comment utiliser les trucs de compilation ?
Pour lancer votre version locale de Kate, vous devez d'abord configurer correctement l'environnement pour vous assurer que les bons modules externes et les bons éléments sont chargés. Heureusement, c'est très simple :
source ~/projects/kde/build/kate/prefix.sh
kate
Une façon ingénieuse d'envelopper ceci est par exemple de créer vous même, un petit script d'enveloppement pour lancer votre version de branche maître de Kate dans votre dossier de projet local :
#!/bin/bash
source ~/projects/kde/build/kate/prefix.sh
exec kate "$@"
Conservez vos affaires à jour
Pour maintenir votre version locale à jour, vous pouvez simplement utiliser de nouveau les commandes ci-dessus Elles s'occuperont de rapatrier les dernières modifications à partir des dépôts de KDE et de les compiler / de les installer dans votre environnement local.
Développer !
Maintenant, la question restante est : comment faire du développement de la meilleure façon ?
Naturellement, si vous voulez modifier Kate, il pourrait être logique d'utiliser Kate pour cela.
Compte tenu des préparations ci-dessus, c'est facile à faire. Commencez simplement votre nouvelle version maître de Kate et placez-la dans le dossier de compilation :
kate ~/projects/kde/build/kate
De façon alternative, vous pouvez y naviguer dans votre terminal et lancer Kate à partir de lui, qui saura l'ouvrir automatiquement :
cd ~/projects/kde/build/kate
kate
Pour obtenir la meilleure expérience avec cela, veuillez vous assurer que vous avez au moins activé le module externe « Projets & LSP ». Si vous aimez avoir une intégration de la compilation avec une interface graphique, veuillez activer également le module externe de compilation.
Vous vous retrouverez avec une nouvelle fenêtre de Kate comme indiqué ci-dessous.
Dans la partie basse de la vue de l'outil « Projet actuel », deux terminaux sont affichés par défaut. Le premier terminal se trouve à l'intérieur de votre dossier de compilation. Ici, vous pouvez, par exemple, lancer vos commandes ninja et ninja install et autres. Le deuxième terminal se trouve à l'intérieur de votre dossier de sources, ce qui est parfait pour, par exemple, lancer des commandes « Git »en ligne.
Compte tenu de la configuration ci-dessus, le module externe « LSP » (Si vous avez ** clangd ** installé) devrait fonctionner nativement.
D'autres trucs ingénieux comme l'ouverture rapide de la totalité du projet, la recherche et le remplacement et les cibles de construction correctes doivent également être configurées.
Contribuer avec votre retour d'expérience !
N'hésitez pas à créer une demande de fusion sur invent.kde.org. Pour plus d'informations, veuillez consulter la page Rejoignez-nous.
Obtenir de l'aide ?
Si vous avez des questions, vous pouvez leur poser sur notre liste de diffusion kwrite-devel@kde.org et / ou rejoignez le canal « #kate » sur les forums de « irc.libera.chat ».
Pour plus d'informations, veuillez consulter la page [Obtenir de l'aide(/support/).
Compilation de Kate à partir de sources sous Windows
Pour compiler les applications Kate et KWrite reposant sur l'environnement « KF5 », vous pouvez suivre le guide de KDE sous Windows.
Compilation de Kate à partir de sources sous macOS
Pour compiler les applications Kate et KWrite reposant sur l'environnement « KF5 », vous pouvez suivre le guide de KDE on macOS.