Construcció del Kate a partir del codi font al Linux

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

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

Com que aquesta 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. Això facilita les col·laboracions a tots els nivells de la pila de programari del KDE.

Trieu el directori de desenvolupament del Kate i de KDE

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

Per a les parts restants d'aquesta descripció utilitzem

~/projects/kde

No dubteu a personalitzar-ho.

Instal·leu el «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 el «kdesrc-build»

El «kdesrc-build» té algun pas de parametrització que pot configurar coses per a vós, vegeu aquesta introducció.

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

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

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

    # fa servir el «ninja» per a unes reconstruccions incrementals més ràpides, desactiva algunes
    # coses de les Qt 5 per a tenir menys dependències
    cmake-options -G "Ninja" -DBUILD_WITH_QT6=ON -DQT_MAJOR_VERSION=6 -DPHONON_BUILD_QT5=OFF -DBUILD_QT5=OFF

    # eines del «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 el KDE abans d'instal·lar de manera relativa 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 tenir una bona experiència en el desenvolupament del Kate (o altres coses del KDE) amb el Kate.

Integració LSP

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

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

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

El 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. Això és útil si no esteu segur de si tots els paquets de desenvolupament necessaris estan instal·lats al vostre sistema i no voleu tenir-ne cura manualment. Com que això intentarà instal·lar paquets per a la vostra distribució, aquest 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ó del Kate i les dependències

Per a activar una compilació del 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 realment voleu implementar.

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

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

Si només voleu construir el Kate sense les dependències perquè esteu segur que teniu coses prou recents al 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 simplement construir totes les coses, això assegura que també teniu, per exemple, els últims i millors frameworks KSyntaxHighlighting i KTextEditor!

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

kdesrc-build

Tingueu en compte: això trigarà una mica (i ocuparà espai al disc).

Si durant la construcció veureu qualsevol error mostrat amb una lletra vermella, seguiu aquesta guia: Com resoldre els problemes de construcció

Com utilitzar els objectes de la construcció?

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

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

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

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

Mantingueu els objectes actualitzats

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

Desenvolupeu!

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

Naturalment, si voleu furonejar el Kate, podria tenir sentit utilitzar-lo per a això.

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

kate ~/projects/kde/build/kate

Alternativament, podeu navegar allà al terminal i iniciar el Kate des d'allà, l'obrirà automàticament:

cd ~/projects/kde/build/kate
kate

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

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

A la vista d'eina «Projecte actual» inferior, teniu per defecte dos terminals. El primer terminal es troba dins del directori de construcció, aquí podeu, p. ex., executar les ordres ninja i ninja install i similars. El segon terminal està dins del vostre directori d'origen, perfecte per crides de la línia d'ordres git, 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 cerca i substitució i els objectius de construcció correctes.

Col·laboreu-hi!

No dubteu a crear una petició de fusió a 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 a irc.libera.chat.

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

Construcció del Kate a partir del codi font al Windows

Per a construir el Kate/KWrite basat en els KF5 podeu seguir la guia de KDE al Windows.

Construcció del Kate a partir del codi font al macOS

Per a construir el Kate/KWrite basat en els KF5 podeu seguir la guia de KDE al macOS.