Zostavenie Kate zo zdrojových kódov v Linuxe

V súčasnosti sa zdrojový kód Kate nachádza na inštancii GitLab invent.kde.org. Tento návod vysvetľuje, ako zostaviť Kate bez zásahu do vašej globálnej inštalácie.

Všetko sa bude odohrávať v zvláštnom vývojovom adresári. Tým sa vyhnete potrebe administrátorských práv a budete môcť vždy použiť globálne nainštalovanú Kate, ak je aktuálne zostavená verzia poškodená.

Keďže tento návod predstaví nastavenie, ktoré umožňuje vyvíjať aj iné časti softvérového zásobníka KDE, budeme v nasledujúcom texte hovoriť o nastavení vývojového prostredia KDE. Okrem aplikačných častí Kate sa zostavia aj potrebné KDE Frameworks. To uľahčí prispievanie na všetkých úrovniach softvérového zásobníka KDE.

Vyberte si adresár pre vývoj Kate a KDE

Vyberte si cestu, kde majú skončiť všetky veci súvisiace s vývojom Kate a KDE. Okrem lokálnych konfiguračných súborov používateľa nebude nič mimo tohto adresára ovplyvnené. Môžete to znova použiť na vývoj akejkoľvek časti softvérového zásobníka KDE.

Pre zvyšné časti tohto popisu používame

~/projects/kde

Neváhajte si to prispôsobiť.

Inštalácia kdesrc-build

Inštalácia je viac-menej len klonovanie aktuálnej verzie

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

Pre neskoršie jednoduché použitie je najlepšie vytvoriť symbolický odkaz na skript kdesrc-build do nejakého priečinka vo vašej ceste, napr. ak máte lokálny bin adresár:

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

Konfigurácia kdesrc-build

kdesrc-build má priechod nastavenia, ktorý môže nakonfigurovať veci za vás, pozrite si tento úvod.

Tu len ukážeme ~/.config/kdesrc-buildrc, ktorý je dostatočný pre potreby vývoja Kate.

Môžete jednoducho skopírovať a vložiť nižšie uvedený variant do vášho domovského adresára ako ~/.config/kdesrc-buildrc a prispôsobiť cesty vašim potrebám. Ak zostanete pri ceste ~/projects/kde, ktorú sme si vybrali vyššie, malo by to byť použiteľné 1:1.

global
    # použite najnovší softvér založený na KF6 a Qt6.
    branch-group kf6-qt6

    # použite ninja pre rýchlejšie inkrementálne zostavovanie, vypnite niektoré veci Qt 5 pre menej
    # závislostí
    cmake-options -G "Ninja" -DBUILD_WITH_QT6=ON -DQT_MAJOR_VERSION=6 -DPHONON_BUILD_QT5=OFF -DBUILD_QT5=OFF

    # nástroje clangd
    compile-commands-export yes
    compile-commands-linking yes

    # plochá štruktúra
    directory-layout flat

    # Inštalačný adresár pre softvér KDE
    install-dir ~/projects/kde/usr

    # Adresár pre stiahnutý zdrojový kód
    source-dir ~/projects/kde/src

    # Adresár na zostavenie KDE pred inštaláciou, predvolene relatívny k source-dir
    build-dir ~/projects/kde/build
end global

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

Dôležité riadky pre dobrý zážitok z vývoja Kate (alebo iných vecí KDE) s Kate sú podrobne popísané nižšie.

Integrácia LSP

# nástroje clangd
compile-commands-export yes
compile-commands-linking yes

Tieto riadky zabezpečia, že CMake vygeneruje súbory compile_commands.json, ktoré sú potrebné pre integráciu LSP založenú na clangd. Okrem ich generovania v adresári zostavenia, voľba prepojovania ich symbolicky prepojí späť do vašich zdrojových adresárov. To umožňuje použitie doplnku LSP v Kate (a iných editoroch) bez konfigurácie.

Inštalácia potrebných závislostí (voliteľné)

kdesrc-build poskytuje úvodný režim nastavenia na inštaláciu potrebných balíkov pre niekoľko bežných distribúcií na začatie vývoja. To je užitočné, ak si nie ste istí, či sú vo vašom systéme nainštalované všetky potrebné vývojové balíky a nechcete sa o to starať manuálne. Keďže sa pokúsi nainštalovať balíky pre vašu distribúciu, tento krok bude vyžadovať administrátorské práva na inštaláciu balíkov. Na to stačí spustiť:

kdesrc-build --initial-setup

Už sme vytvorili .config/kdesrc-buildrc, ktorý zostane nedotknutý. Pre ďalšie použitie nemusíte upravovať ani nastavenia vášho shellu.

Zostavenie Kate a závislostí

Na spustenie kompilácie Kate a všetkých potrebných závislostí KDE teraz stačí napísať:

kdesrc-build --include-dependencies kate

Na modernom stroji to trvá niekoľko minút. Čas na kávu alebo premýšľanie o tom, čo vlastne chcete implementovať.

Pokiaľ verzia KF 6 našich závislostí nie je súčasťou vašej distribúcie, môže mať zmysel zostaviť ďalšie časti pre lepšie štýlovanie a integráciu terminálu:

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

Ak chcete zostaviť iba Kate bez závislostí, pretože ste si istí, že máte vo svojom systéme dostatočne nové veci, môžete skúsiť:

kdesrc-build --no-include-dependencies kate

Avšak vzhľadom na to, že na moderných strojoch sú časy kompilácie nízke, je pohodlnejšie jednoducho zostaviť všetko, čo zabezpečí, že budete mať napr. aj najnovšie a najlepšie frameworky KSyntaxHighlighting a KTextEditor!

S týmto nastavením môžete zostaviť všetky časti softvéru KDE jednoduchým:

kdesrc-build

Majte na pamäti: bude to trvať nejaký čas (a zaberá miesto na disku).

Ak počas zostavovania uvidíte akékoľvek zlyhania zobrazené červeným písmom, postupujte podľa tohto návodu - Ako riešiť problémy so zostavovaním

Ako používať zostavené veci?

Na spustenie vašej lokálnej verzie Kate musíte najprv správne nastaviť prostredie, aby sa načítali správne doplnky a ďalšie veci. Našťastie je to veľmi jednoduché:

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

Šikovný spôsob, ako to zabaliť, je napr. vytvoriť si malý obaľovací skript na spustenie vašej verzie Kate z vetvy master vo vašom lokálnom adresári bin:

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

Udržujte vaše veci aktuálne

Na udržiavanie vašej lokálnej verzie aktuálnej stačí znova použiť vyššie uvedené príkazy. Postarajú sa o stiahnutie nových zmien z repozitárov KDE a ich zostavenie/inštaláciu do vášho lokálneho prefixu.

Vývoj

Teraz zostáva otázka: Ako najlepšie vyvíjať?

Prirodzene, ak chcete pracovať na Kate, môže mať zmysel na to použiť Kate.

S vyššie uvedenými prípravami je to jednoduché, stačí spustiť vašu novú verziu Kate z vetvy master a odovzdať jej adresár zostavenia:

kate ~/projects/kde/build/kate

Prípadne môžete v termináli prejsť do daného adresára a spustiť Kate odtiaľ, automaticky ho otvorí:

cd ~/projects/kde/build/kate
kate

Pre najlepší zážitok sa uistite, že máte povolený aspoň doplnok projektu a LSP. Ak chcete mať aj integráciu zostavovania s GUI, aktivujte aj doplnok zostavovania.

Skončíte s novým oknom Kate, ako je zobrazené nižšie.

V dolnom pohľade nástroja "Aktuálny projekt" máte predvolene dva terminály. Prvý terminál je vo vašom adresári zostavenia, kde môžete napr. spúšťať príkazy ninja a ninja install a podobne. Druhý terminál je vo vašom zdrojovom adresári, ideálny napr. na príkazy git z príkazového riadku.

S vyššie uvedeným nastavením by mal doplnok LSP (ak máte nainštalovaný clangd) fungovať priamo po inštalácii.

Ďalšie šikovné veci ako rýchle otváranie v rámci projektu, hľadanie a nahradenie a správne ciele zostavovania by mali byť tiež nastavené.

Prispejte späť!

Neváhajte vytvoriť žiadosť o zlúčenie na invent.kde.org. Viac informácií nájdete v časti Pripojte sa k nám.

Potrebujete podporu?

Ak máte otázky, môžete ich položiť v našej sekcii Kate na diskusnom serveri KDE a/alebo sa pripojiť na náš Kate Matrix kanál (všeobecnejšie informácie o Matrix a KDE tu).

Viac informácií nájdete v časti Získať pomoc.

Zostavenie Kate zo zdrojových kódov vo Windows

Na zostavenie Kate/KWrite založeného na KF5 môžete postupovať podľa návodu KDE vo Windows.

Zostavenie Kate zo zdrojových kódov v macOS

Na zostavenie Kate/KWrite založeného na KF5 môžete postupovať podľa návodu KDE v macOS.