Construcció

Construcció de Kate a partir del codi font a Linux

Ara mateix, el codi font de Kate es troba en la instància de GitLab en invent.kde.org. Esta guia d'aprenentatge explica com construir Kate sense tocar la vostra instal·lació global.

Tot passarà dins d'un directori de desenvolupament addicional. Açò evita la necessitat de drets d'administrador i permet utilitzar sempre Kate instal·lat globalment si la versió de construcció actual està trencada.

Com que esta guia d'aprenentatge presentarà una configuració que també permet desenvolupar altres parts de la pila de programari KDE, parlarem a continuació sobre la configuració d'un entorn de desenvolupament de KDE. Els Frameworks de KDE necessaris es compilaran a més de les parts de l'aplicació Kate. Açò facilita les col·laboracions a tots els nivells de la pila de programari de KDE.

Seleccioneu el directori de desenvolupament de Kate i de KDE

Seleccioneu un camí on haurien d'acabar totes les coses de desenvolupament de Kate i KDE. A banda dels fitxers de configuració local d'usuari, no hi haurà res contaminat fora d'este directori. Podeu tornar a utilitzar-ho per al desenvolupament en qualsevol part de la pila de programari KDE.

Per a les parts restants d'esta descripció utilitzem

~/projects/kde

No dubteu a personalitzar-ho.

Instal·leu «kdesrc-build»

La instal·lació és més o menys clonar la versió actual

mkdir -p ~/projects/kde/src
cd ~/projects/kde/src
git clone https://invent.kde.org/sdk/kdesrc-build.git

Per a facilitar l'ús posterior, és millor fer un enllaç simbòlic de l'script «kdesrc-build» a alguna carpeta dins del camí, p. ex., si teniu un «bin» local d'usuari:

ln -s ~/projects/kde/src/kdesrc-build/kdesrc-build ~/bin

Configureu «kdesrc-build»

«kdesrc-build» té algun pas de parametrització que pot configurar coses per a tu, vegeu esta introducció.

Ací només es mostra un ~/.config/kdesrc-buildrc que és prou bo per a les necessitats de desenvolupament de Kate.

Senzillament podeu copiar i apegar la variant següent al vostre directori d'inici com a ~/.config/kdesrc-buildrc i adaptar els camins a les vostres necessitats. Si vos quedeu amb el camí ~/projectes/kde que hem triat més amunt, açò hauria de ser utilitzable 1:1.

global
    # utilitza l'últim programari basat en els KF6 i les Qt6.
    branch-group kf6-qt6

    # volem els fitxers «.kateproject» amb «ninja», desactiva algunes coses de les Qt 5 per a tindre
    # menys dependències
    cmake-options -G "Kate - Ninja" -DBUILD_WITH_QT6=ON -DQT_MAJOR_VERSION=6 -DPHONON_BUILD_QT5=OFF -DBUILD_QT5=OFF

    # eines de «clangd»
    compile-commands-export yes
    compile-commands-linking yes

    # estructura plana
    directory-layout flat

    # Directori d'instal·lació per al programari KDE
    install-dir ~/projects/kde/usr

    # Directori del codi font baixat
    source-dir ~/projects/kde/src

    # Directori on construir KDE abans d'instal·lar relatiu al «source-dir» predeterminat
    build-dir ~/projects/kde/build
end global

include ${module-definitions-dir}/kf6-qt6.ksb

A continuació es descriuen detalladament les línies importants per a tindre una bona experiència en el desenvolupament de Kate (o altres coses de KDE) amb Kate.

Creeu els fitxers «.kateproject»

# volem els fitxers «.kateproject» amb «ninja»
cmake-options -G "Kate - Ninja"

Açò assegura que no només s'obtenen els fitxers de construcció Ninja (enginyós ja que açò serà, p. ex., per a utilitzar automàticament múltiples nuclis en les compilacions), sinó que a més a més els fitxers «.kateproject» dins dels directoris de construcció també s'utilitzaran més tard. Amb estos fitxers, el connector del projecte de Kate sabrà què fer, p. ex., on es troba el directori de codi font per a la compilació i quines ordres de construcció hauria d'utilitzar per al connector de construcció.

Assegureu que funciona la integració LSP

# eines de «clangd»
compile-commands-export yes
compile-commands-linking yes

Açò assegura que CMake generarà els fitxers compile_commands.json necessaris per a la integració LSP basada en «clangd». A més de generar-los dins del directori de construcció, l'opció d'enllaços els enllaçarà simbòlicament de nou amb els vostres directoris de codi font. Açò permet l'ús de configuració zero del connector LSP dins de Kate (i altres editors).

Instal·leu les dependències necessàries (opcional)

kdesrc-build proporciona un mode inicial de configuració per a instal·lar els paquets necessaris per a diverses distribucions habituals per a començar a desenvolupar. Açò és útil si no esteu segur de si tots els paquets de desenvolupament necessaris estan instal·lats en el vostre sistema i no voleu tindre'n cura manualment. Com que açò intentarà instal·lar paquets per a la vostra distribució, este pas requerirà drets d'administrador per a la instal·lació del paquet. Per a fer-ho, només cal activar:

kdesrc-build --initial-setup

Ja hem creat un .config/kdesrc-buildrc, que es deixarà intacte. Per a un ús addicional, tampoc cal modificar la configuració de l'intèrpret d'ordres.

Construcció de Kate i les dependències

Per a activar una compilació de Kate i totes les dependències necessàries de KDE, ara només cal escriure:

kdesrc-build --include-dependencies kate

Triga uns minuts en una màquina recent. És hora de prendre un cafè o pensar en el que segur que voleu implementar.

Sempre que la versió KF 6 de les nostres dependències no estiga empaquetada en la vostra distribució, podria tindre sentit construir algunes parts més per a tindre un estil millor i una integració del terminal:

kdesrc-build --include-dependencies breeze plasma-integration kwayland-integration konsole kate

Si només voleu construir Kate sense les dependències perquè segur que teniu coses prou recents en el sistema, podeu intentar:

kdesrc-build --no-include-dependencies kate

Però atés que en les màquines modernes els temps de compilació són baixos, és més còmode senzillament construir totes les coses, açò assegura que també teniu, per exemple, els últims i millors marcs de treball KSyntaxHighlighting i KTextEditor!

Donada esta configuració, sou lliure de construir totes les parts del programari KDE amb un senzill:

kdesrc-build

Cal tindre en compte: açò tardarà una mica (i ocuparà espai en el disc).

Si durant la construcció veeu qualsevol error mostrat amb una lletra roja, seguiu esta guia: Com resoldre els problemes de construcció

Com utilitzar els objectes de la construcció?

Per a iniciar la versió local de Kate, primer heu de configurar adequadament l'entorn per a assegurar-vos que es carreguen els connectors i els objectes correctes. Afortunadament, açò és molt senzill:

source ~/projects/kde/build/kate/prefix.sh
kate

Una manera enginyosa d'ajustar açò és, p. ex., crear un script xicotet d'embolcall per a iniciar la versió de la branca mestra de Kate dins del directori local «bin»:

#!/bin/bash
source ~/projects/kde/build/kate/prefix.sh
exec kate "$@"

Manteniu els objectes actualitzats

Per a mantindre actualitzada la vostra versió local, podeu utilitzar les ordres anteriors de nou. S'encarregaran d'extraure els canvis nous des dels repositoris de KDE, construir-los i instal·lar-los en el vostre prefix local.

Desenvolupeu!

Ara, la pregunta que queda és: com desenvolupar millor?

Naturalment, si voleu furonejar Kate, podria tindre sentit utilitzar-lo per a açò.

Donades les preparacions anteriors, açò és fàcil de fer, senzillament inicieu la versió mestra nova de Kate i passeu-la al directori de construcció:

kate ~/projects/kde/build/kate

De manera alternativa, podeu navegar fins allà en el terminal i iniciar Kate des d'allà, l'obrirà automàticament:

cd ~/projects/kde/build/kate
kate

Per a tindre la millor experiència amb açò, assegureu-vos que almenys teniu habilitat el connector LSP del projecte. Si vos agrada tindre una integració de construcció de la IGU, activeu també el connector de construcció.

Acabareu amb una finestra nova de Kate com es mostra a continuació.

En la vista inferior de l'eina «Projecte actual», de manera predeterminada teniu dos terminals. El primer terminal es troba dins del directori de construcció, ací podeu, p. ex., executar les ordres ninja i ninja install i similars. El segon terminal està dins del vostre directori d'origen, perfecte per a crides de «git» des de la línia d'ordres, p. ex.

Donada la configuració anterior, el connector LSP (si teniu clangd instal·lat) hauria de funcionar d'entrada.

També s'han de configurar altres coses enginyoses com ara l'obertura ràpida del projecte, la busca i substitució i els objectius de construcció correctes.

Col·laboreu-hi!

No dubteu a crear una petició de fusió en invent.kde.org. Per a més informació, vegeu Uniu-vos.

Com aconseguiu suport?

Si teniu preguntes, podeu fer-les a la nostra llista de correu kwrite-devel@kde.org o unir-vos a #kate en irc.libera.chat.

Per a més informació, vegeu Obtín ajuda.

Construcció de Kate a partir del codi font a Windows

Per a construir Kate i KWrite basats en els KF5 podeu seguir la guia de KDE a Windows.

Construcció de Kate a partir del codi font a macOS

Per a construir Kate i KWrite basats en els KF5 podeu seguir la guia de KDE a macOS.