Tabelle der verfügbaren Einstellungsoptionen

Es folgt eine Tabelle der verschiedenen Optionen mit folgenden Informationen:

  • Der Name der Option

  • Eine Beschreibung des Verhaltens von kdesrc-build beim Erstellen eines Moduls, wenn diese Option sowohl im globalen Abschnitt als auch im Abschnitt für das Modul in der Einrichtungsdatei gesetzt ist..

  • Zusätzliche Hinweise zum Zweck und zur Benutzung der Option.

Tabelle 4.1. Tabelle der Optionen

Name der OptionModul -> Globales VerhaltenBemerkungen
apidox 

Mit dieser Option wurde die API-Dokumentation der KDE-Module erstellt. Diese Option wurde in kdesrc-build 1.6.3 entfernt. Die API-Dokumentation finden Sie im Internet auf kde.org. Zusätzlich kann die API-Dokumentation für KDE mit dem Skript kdedoxygen.sh aus dem Modul kde-dev-scripts lokal erstellt werden. Weitere Informationen dazu finden Sie auf der KDE TechBase.

apply-qt-patches Diese Option wurde in kdesrc-build Version 1.10 entfernt. Um den gleichen Effekt zu erreichen, lesen Sie bitte die Informationen zu „Unterstützung für qt“ und der Option repository.
asyncKann nicht überschrieben werden

Diese Option aktiviert den asynchronen Arbeitsmodus, in dem Quelltexte gleichzeitig heruntergeladen und die Module kompiliert werden, anstatt erst nach dem Laden des Quelltextes mit dem Kompilieren zu beginnen. Diese Option ist als Voreinstellung eingeschaltet, um sie abzuschalten, wird diese Option auf den Wert false gesetzt.

Diese Option gibt es seit Version 1.6.

binpathModuleinstellung überschreibt die globale Einstellung

Mit dieser Option können Sie die Umgebungsvariable PATH für den Kompiliervorgang festlegen. Diese Option lässt sich nicht mit einer Modul-Option überschreiben. Die Voreinstellung ist die beim Start des Skripts gesetzte Umgebungsvariable $PATH. Diese Umgebungsvariable sollte die Pfade zu den notwendigen Entwicklungs-Werkzeugen beinhalten. Die Pfade $KDEDIR/bin und $QTDIR/bin werden automatisch hinzugefügt. Sie können auch die Tilde (~) für Pfadangaben verwenden.

branchModuleinstellung überschreibt die globale Einstellung

Mit dieser Option legen Sie fest, dass die Quellen aus einem bestimmten KDE-Zweig anstelle von master (bei Git-Modulen) oder trunk (bei Subversion), in denen die KDE-Entwicklung stattfindet, heruntergeladen werden sollen.

Um beispielsweise KDE 4.6 herunterzuladen, stellen Sie die Option auf 4.6 ein.

Wenn das Herunterladen eines Zweigs mit dieser Option fehlschlägt, müssen Sie möglicherweise die korrekte Adresse zum Herunterladen manuell eingeben. Verwenden Sie dazu die Optionen module-base-path oder override-url.

Anmerkung

Für die meisten KDE-Module sollten Sie vermutlich stattdessen die Option branch-group benutzen und diesen Option nur ausnahmsweise verwenden.

branch-groupModuleinstellung überschreibt die globale Einstellung

Stellen Sie diese Option auf eine allgemeine Gruppe ein, aus der Sie Module auswählen möchten.

Für unterstützte Git-Modularten bestimmt kdesrc-build automatisch den aktuell zu verwendenden Zweig auf der Grundlage der Regeln, die von den KDE-Entwicklern festgelegt wurden. Diese Regeln finden Sie im Quelltextarchiv kde-build-metadata in Ihrem Quelltextordner. Wenn der Zweig bestimmt ist, wird dieser benutzt, als wenn Sie ihn selbst mit der Option branch festgelegt hätten.

Dies ist besonders hilfreich, wenn Sie nur die Aktualisierungen an einigen normalen Entwicklungen verfolgen möchten, ohne sich dabei um alle Änderungen an Zweignamen kümmern zu müssen.

Zum 11.08.2013 gibt es folgende aktuelle Zweiggruppen:

  • stable-qt4, für die Verfolgung von Fehlerkorrekturen an den KDE-Bibliotheken und -Programmen auf der Basis von Qt™ 4.

  • latest-qt4, für die Verfolgung von Entwicklung und neuer Funktionen an den KDE-Bibliotheken und -Programmen auf der Basis von Qt™ 4.

  • kf5-qt5, für die Verfolgung der bleeding-edge Entwicklung des zukünftigen Qt™ 5-basierten KDE Frameworks 5, Plasma™ Workspace 2, usw.

Bedenken Sie, wenn Sie selbst einen branch auswählen, wird dadurch diese Einstellung überschrieben. Dasselbe trifft auf andere zweigspezifische Auswahloptionen wie zum Beispiel tag zu.

Diese Option wurde in kdesrc-build 1.16-pre2 hinzugefügt.

Anmerkung

Diese Option trifft nur auf die Git-Module kde-projects zu, der häufigste Fall. Siehe auch „Die offizielle KDE-Moduldatenbank“.

build-dirModuleinstellung überschreibt die globale EinstellungVerwenden Sie diese Option zum Ändern des Ordners, in dem die Quellen kompiliert werden sollen. Sie können diese Option auf drei Arten verwenden:
  1. Relativ zum KDE-Subversion-Quellordner (siehe die Option source-dir). Dies ist die Voreinstellung und dieser Modus wird automatisch verwendet, wenn Sie einen Ordner-Namen eingeben, der nicht mit einer Tilde (~) oder einem Schrägstrich (/) beginnt.

    Die Voreinstellung ist build.

  2. Absoluter Pfad. Wenn Sie einen Pfad eingeben, der mit einem Schrägstrich (/) beginnt, so wird dieser Pfad wie eingegeben verwendet. Beispiel: /tmp/kde-obj-dir/.

  3. Relativ zum persönlichen Ordner. Wenn Sie einen Pfad angeben, der mit einer Tilde (~) beginnt, so wird der Pfad als relativ zu Ihrem persönlichen Ordner angesehen. Dies funktioniert analog zu der Art und Weise, wie die Shell eine Tilde interpretiert. Beispiel: ~/builddir würde den Kompilier-Ordner auf /home/benutzer/builddir einstellen.

Diese Option kann für jedes Modul separat eingestellt werden.
build-when-unchangedModuleinstellung überschreibt die globale Einstellung

Mit dieser Option stellen Sie ein, ob kdesrc-build ein immer Modul erstellt, auch wenn der Quelltext nicht geändert wurde.

Mit der Option build-when-unchanged gleich true erstellt kdesrc-build ein Modul immer neu, auch wenn der Quelltext dieses Moduls nicht geändert wurde. Dies ist die Voreinstellung, damit lassen sich Module meistens erfolgreich erstellen.

Mit der Option build-when-unchanged gleich false wird ein Modul nur dann neu erstellt, wenn entweder der Quelltext geändert wurde oder das erneute Erstellen wahrscheinlich erforderlich ist. Mit dieser Einstellung sparen Sie Zeit, besonders wenn Sie kdesrc-build täglich oder noch häufiger ausführen.

Wichtig

Diese Funktion dient nur zur Optimierung. Wie viele Optimierungen kann es Probleme mit einer korrekten Installation geben. Änderungen in qt oder kdelibs erfordern zum Beispiel das erneute Erstellen anderer Module, auch wenn deren Quelltext unverändert ist.

checkout-onlyModuleinstellung überschreibt die globale Einstellung

Mit Hilfe dieser Option können Sie Subversion-Quelltexte nacheinander herunterladen. Die Einstellung für diese Option sollte eine durch Leerzeichen getrennte Liste der herunterzuladenden Ordner sein. Zwar überschreibt diese Option die globale Version, es ist jedoch dennoch nicht sinnvoll, die Option global einzustellen.

Beachten Sie, dass diese Einstellung bei Modulen aus Git-Archiven wirkungslos ist. Der Grund dafür liegt in der Arbeitsweise des Git-Quelltext- Verwaltungssystems.

Ein Beispiel finden Sie unter „Teile eines Moduls herunterladen“.

cmake-generatorModuleinstellung überschreibt die globale Einstellung

Verwenden Sie diese Option, um anzugeben, welches Generierungs-Programm mit CMake verwendet werden soll. Derzeit werden sowohl Ninja und Unix Makefiles als auch darauf basierende Generierungs-Programme wie Eclipse CDT4 - Ninja unterstützt. Ungültige nicht unterstützte Werte werden ignoriert und nicht beachtet. Ist diese Option nicht gesetzt, wird Unix Makefiles standardmäßig verwendet.

Wenn ein gültiges Generierungs-Programm auch über cmake-options angegeben wird, überschreibt das den Wert für cmake-generator.

cmake-toolchainModuleinstellung überschreibt die globale Einstellung

Mit dieser Option wird eine Datei mit Entwicklungs-Werkzeugen für CMake angegeben.

Wenn gültige Entwicklungs-Werkzeuge eingerichtet sind, wird kdesrc-build Umgebungsvariablen nicht mehr automatisch setzen. Sie können mit set-env, binpath und libpath die Umgebung manuell einrichten, wenn Ihre Entwicklungs-Werkzeuge nicht sofort mit kdesrc-build funktionieren. Weitere Informationen finden Sie im Abschnitt Übersicht der Standard-Parameter von kdesrc-build.

Wenn ein gültiges Entwicklungs-Werkzeug auch über cmake-options angegeben wird, überschreibt das den Wert für cmake-toolchain.

cmake-optionsWird den globalen Optionen für das Standard-Erstellungssystem angefügt, überschreibt die globale Einstellung für andere Erstellungssysteme.

Mit Hilfe dieser Option können Sie die Parameter festlegen, die CMake für das jeweilige Modul übergeben werden. Wenn Sie diese Option global einstellen, wird sie für alle Module angewandt. Wenn Optionen für einzelne Module angegeben sind, werden sie nach den globalen Optionen eingefügt. Dadurch können CMake-Optionen für alle Module im globalen Abschnitt eingegeben werden.

Diese Option wird nicht für qt angewendet, da CMake dafür nicht benutzt wird. Verwenden Sie stattdessen die Option configure-flags.

Wenn ein gültiges Generierungs-Programm unter den aufgelisteten Optionen angegeben ist, überschreibt das den Wert von cmake-generator. Ungültige, nicht unterstützte Generierungs-Programme werden ignoriert und nicht an CMake übergeben.

Wenn ein gültiges Entwicklungs-Werkzeuge unter den aufgelisteten Optionen angegeben ist, überschreibt das den Wert von cmake-toolchain. Ungültige Entwicklungs-Werkzeuge werden ignoriert und nicht an CMake übergeben.

Da diese Optionen direkt ohne weitere Bearbeitung an CMake übergeben werden, müssen Sie in der gleichen Form wie für CMake eingetragen werden. Zum Beispiel:

cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo

Solange alle anderen Optionen richtig gesetzt sind, wird diese Option nicht benötigt und kann leer bleiben. kdesrc-build setzt alle erforderlichen Parameter für CMake automatisch auf den richtigen Wert.

colorful-outputKann nicht überschrieben werdenWenn Sie diese Option auf false setzen, wird die farbige Ausgabe von kdesrc-build unterbunden. Die Voreinstellung ist true. Beachten Sie, dass kdesrc-build die Farbcodes nur auf ein Terminal ausgibt (wie beispielsweise xterm, Konsole oder die normale Linux®-Konsole).
compile-commands-exportModuleinstellung überschreibt die globale Einstellung

Ermöglicht die Erzeugung einer Datei compile_commands.json über CMake im Erstellungsordner. Diese Option ist standardmäßig auf true, setzen Sie sie auf false, um dieses Verhalten zu deaktivieren.

compile-commands-linkingModuleinstellung überschreibt die globale Einstellung

Ermöglicht das Erstellen von symbolischen Verknüpfungen von compile_commands.json, die über CMake innerhalb des Erstellungsordners erzeugt werden, auf den passende Quellcodeordner. Diese Option ist standardmäßig auf false gesetzt, setzen Sie sie auf true, um die automatische Erstellung von symbolischen Verknüpfungen zu aktivieren.

configure-flagsWird den globalen Optionen für das Standard-Erstellungssystem angefügt, überschreibt die globale Einstellung für andere Erstellungssysteme.

Mit Hilfe dieser Option können Sie die Parameter festlegen, die dem Skript ./configure für das jeweilige Modul übergeben werden. Wenn Sie diese Option global einstellen, wird sie für alle Module angewandt. Diese Option funktioniert nur für qt.

Die Einstellungen für KDE-Module werden mit cmake-options vorgenommen.

custom-build-commandModuleinstellung überschreibt die globale Einstellung (Option für das Erstellen)

Diese Option kann verwendet werden, um zum Beispiel einen anderen Befehl als make für die Ausführung des Erstellungsprozesses zu verwenden. Normalerweise funktioniert kdesrc-build auch ohne die Option korrekt, aber es kann für alternative Erstellungssysteme nützlich sein.

Der Wert dieser Option wird üblich in der Befehlszeile ausgeführt und durch die Option make-options wie sonst auch verändert.

cxxflagsWird den globalen Optionen für das Standard-Erstellungssystem angefügt, überschreibt die globale Einstellung für andere Erstellungssysteme.

Mit dieser Option können Sie die Parameter für das Erstellen der Module festlegen.Diese Option wird hier angegeben und nicht einfach an configure-flags oder an cmake-options mit angehängt, weil sie auch die Umgebungsvariable CXXFLAGS während des Kompilierens setzt.

Beachten Sie, dass in KDE 4 für jedes Modul, das CMake verwendet, die Option CMAKE_BUILD_TYPE auf den Wert none eingestellt werden muss. Dazu dient die Option cmake-options.

dest-dirModuleinstellung überschreibt die globale EinstellungMit dieser Option wird der Ordnername eines Moduls auf der Festplatte eingestellt. Das Modul extragear/network zum Beispiel kann mit dieser Option in extragear-network umbenannt werden. Das Trennzeichen für Ordner sollte nicht im Namen benutzt werden, dadurch gibt es Probleme mit den Optionen build-dir und source-dir.
disable-agent-checkKann nicht überschrieben werdenWenn Sie SSH zum Herunterladen der Subversion-Quelltexte verwenden (zum Beispiel mit dem Protokoll svn+ssh), wird kdesrc-build überprüfen, dass Ihr SSH-Agent auch einige SSH-Identitäten verwalten kann. Auf diese Weise soll SSH daran gehindert werden, Sie andauernd zur Passworteingabe aufzufordern. Sie können diese Prüfung unterbinden, indem Sie die Option disable-agent-check auf true einstellen.
do-not-compileModuleinstellung überschreibt die globale Einstellung

Verwenden Sie diese Option, um bestimmte Ordner aus einem Modul nicht zu erstellen. Die Namen dieser Ordner werden durch Leerzeichen getrennt.

Beachten Sie, dass die Quellen zu den übersprungenen Programmen dennoch heruntergeladen werden. Um auch dies zu unterbinden, können Sie die Option checkout-only verwenden. Geben Sie mit dieser Option nur die Ordner an, die Sie herunterladen möchten.

Um zum Beispiel JuK und KsCD aus dem Modul kdemultimedia nicht zu erstellen, fügen Sie do-not-compile juk kscd zu den Einstellungen für kdemultimedia hinzu.

Ein Beispiel finden Sie unter „Ordner beim Erstellen auslassen“.

email-addressKann nicht überschrieben werden

Diese Option wurde in kdesrc-build 1.14 entfernt.

email-on-compile-errorKann nicht überschrieben werden

Diese Option wurde in kdesrc-build 1.14 entfernt.

inst-apps Diese Option wurde in Version 1.10 entfernt.
git-desired-protocolKann nicht überschrieben werden

Diese Option betrifft nur Module aus einem KDE-Projektarchiv.

Mit dieser Option wird eingestellt, welches Netzwerkprotokoll bevorzugt zum Einspielen von Quelltext für diese Module verwendet werden soll. Normalerweise wird das sehr effiziente git-Protokoll benutzt, aber dies kann in manchen Netzwerken wie zum Beispiel Firmen-Intranets oder öffentliche Wi-Fi-Netze gesperrt sein. Als Alternative steht das viel besser unterstützte https-Protokoll für Internet-Webseiten zur Verfügung.

Wenn sie eines dieser eingeschränkten Netzwerke benutzen, können Sie diese Option auf http setzen, damit das https-Protokoll bevorzugt wird.

Tipp

Sie müssen möglicherweise auch die Option http-proxy setzen, wenn ein HTTP-Proxy für den Netzwerkverkehr erforderlich ist.

In allen anderen Fällen sollten Sie diese Option nicht benutzen, da das Standardprotokoll effektiver ist.

Diese Option wurde in kdesrc-build 1.16 hinzugefügt. Vor 20.06 wurde diese Option verwendet, um die Fetch-URL anstelle der Push-URL zu einzustellen. Ab 20.06 wird https immer beim Aktualisieren von KDE-Projekten verwendet.

git-repository-baseKann nicht überschrieben werden

Diese seit Version 1.12.1 vorhandene Option kann dazu verwendet werden, um eine Abkürzung für eine bestimmte Basis-URL eines Git-Archivs zu definieren, die dann in der Deklaration von Modulgruppen benutzt werden kann. Damit lassen sich dann schnell viele Git-Module zum Erstellen deklarieren.

Sie müssen zwei durch Leerzeichen getrennte Werte angeben: Der Name der der Basis-URL zugewiesen wird und die tatsächliche Basis-URL selbst, wie zum Beispiel:

global
   # andere Optionen

   # Der übliche Pfad für den anonymen Zugriff auf alle Git-Module auf dem Server.
   git-repository-base kde-git kde:
end global

# Modul-Deklarationen

module-set
   # Nun können Sie den vorher definierten Alias benutzen, aber nur
   # in einer Modulgruppe.
   repository kde-git

   use-modules module1.git module2.git
end module-set

Mit der Option use-modules einer Modulgruppe verhält sich kdesrc-build intern so, als ob folgende Optionen angegeben wären:

module module1
    repository kde:module1.git
end module

module module2
    repository kde:module2.git
end module

Das oben benutzte Präfix kde: für Git-Archive ist eine Kurzform, die von kdesrc-build automatisch eingerichtet wird. Weiter Informationen dazu finden Sie auf der TechBase-Seite URL Renaming. Im Gegensatz zu allen anderen Einstellungen kann diese Option auch mehrfach verwendet werden, um alle erforderlichen Alias zu erstellen.

Tipp

Diese Option ist für Modulgruppen nicht erforderlich. Die Option ist nützlich, um das gleiche Quelltextarchiv für viele verschiedene Modulgruppen zu benutzen.

git-userModuleinstellung überschreibt die globale Einstellung

Diese Option ist für KDE-Entwickler vorgesehen. Ein hier eingetragener Wert wird automatisch für die Einstellung zur Identität für das Git-Softwaresystem für neu heruntergeladene Git-Module einschließlich der Mehrheit der KDE-Module.

Insbesondere für den Benutzernamen und die E-Mail-Adresse eines jeden neuen Git-Archiv werden die Werte dieser Option verwendet.

Der Wert muss im Format User Name <email@example.com> angeben werden.

Ein Entwickler mit dem Namen Foo Barbaz mit der E-Mail-Adresse foo@abc.xyz würde zum Beispiel folgendes verwenden:

git-user Foo Barbaz <foo@abc.xyz>

Diese Option wurde in kdesrc-build 15.09 hinzugefügt.

http-proxyModuleinstellung überschreibt die globale Einstellung

Mit dieser Option wird eine URL eines Proxy-Servers angegeben, die für alle HTTP.Netzwerkverbindungen verwendet werden soll, um zum Beispiel Archive für eine neues Modul oder die KDE-Projektdatenbank herunterzuladen.

Zusätzlich versucht kdesrc-build sicherzustellen, dass alle verwendeten Hilfsprogramme auch diesen Proxy-Server benutzen. Dazu wird die Umgebungsvariable http_proxy auf den vorgegebenen Server eingestellt, wenn die Variable bisher noch keinen Wert hatte.

Diese Option wurde in kdesrc-build 1.16 hinzugefügt.

ignore-kde-structureModuleinstellung überschreibt die globale Einstellung

Diese Option ist veraltet und wird in einer der nächsten Versionen wieder entfernt.

Bitte benutzen Sie stattdessen die Option directory-layout, die mehr Auswahl ermöglicht.

directory-layoutModuleinstellung überschreibt die globale Einstellung

Diese Option wird verwendet, um die Ordnerstruktur für kdesrc-build zum Erstellen von Quell- und Build-Ordnern anzugeben.

Aktuell gibt es drei mögliche Werte: metadata, invent und flat

Das Layout flat gruppiert alle Module direkt unter den Quell- und Build-Ordnern der obersten Ebene. Statt zum Beispiel source/extragear/network/telepathy/ktp-text-ui im Layout metadata wird dieses Modul im Layout flat unter source/ktp-text-ui angelegt.

Mit dem Layout invent wird eine Ordnerhierarchie die die relativen Pfade der Repositories auf invent.kde.org angelegt. Zum Beispiel statt source/kde/applications/kate im Layout metadata wird dieses Modul im Layout invent unter source/utilities/kate angelegt. Dieses Layout wirkt sich nur auf KDE-Projekte aus. Es ist eine gute Wahl für den Anfang mit kdesrc-build.

Schließlich entspricht das Layout metadatadem früheren Standardverhalten. Dieses Layout organisiert die KDE-Projekte entsprechend den Projektpfaden, die in den Projekt-Metadaten für diese Module angegeben sind. Dies ist eine gute Wahl, wenn Sie ein Ordner-Layout wünschen, das mit bestimmten KDE-Prozessen zusammenarbeitet. Beachten Sie, dass dieser Pfad deshalb nicht immer stabil ist. Als Ergebnis kann es vorkommen, dass kdesrc-build eine alte Kopie des Repositorys verwirft und eine neue für ein Projekt aufgrund von Änderungen in den Projektmetadaten erstellt.

Als Voreinstellung wird das Layout metadata für dieAbwärtskompatibilität für bestehende Benutzer von kdesrc-build verwendet.

ignore-modulesKann nicht überschrieben werden

In dieser Option genannte Module, die von kdesrc-build wegen einer Option use-modules bearbeitet würden, werden statt dessen vollständig ausgelassen. Benutzen Sie diese Option, um das gesamte KDE-Projekt mit Ausnahme von bestimmten Modulen zu erstellen.

Als Wert der Option muss nicht zwingend der Name des Moduls direkt eingegeben werden. Jedes Modul, dessen vollständige fortlaufend Teile des KDE-Projektmodulpfads auf eine dieser Optionswerte zutrifft, wird ignoriert. Daher können Sie mit dieser Methode mehrere Module ignorieren.

Mit einer Option libs werden zum Beispiel sowohl kde/kdegraphics/libs als auch playground/libs ausgeschlossen, aber nicht kde/kdelibs, da mit dem vollständige Teil kdelibs verglichen wird.

Diese Option wurde in kdesrc-build 1.16 hinzugefügt.

include-dependenciesModuleinstellung überschreibt die globale Einstellung

Ist diese Option auf true gesetzt, werden auch alle bekannten Abhängigkeiten dieses Moduls erstellt, ohne dass Sie diese Abhängigkeiten - nicht einmal indirekt - angeben müssen.

Anmerkung

Diese Option funktioniert nur mit kde-project-basierten Modulen. Dazu müssen die von den KDE-Entwicklern betreuten Metadaten für die ausgewählte branch-group richtig eingestellt sein.

Diese Option ist standardmäßig aktiviert, um die Erstellung von Anwendungen zu unterstützen, die die neuere Versionen von Qt™ oder Plasma™ als auf den normalen Betriebssystemen benötigen,

install-after-buildModuleinstellung überschreibt die globale EinstellungDiese Option legt fest, dass ein Paket nach erfolgreichem Kompilieren installiert werden soll. Dies ist in der Voreinstellung eingeschaltet. Wenn Sie dieses Verhalten nicht wünschen, stellen Sie die Option in der Einrichtungsdatei auf false. Sie können analog auch den Befehlszeilen-Parameter --no-install verwenden.
install-environment-driverKann nicht überschrieben werden

Standardmäßig wird mit kdesrc-build ein Shell-Skript installiert, das in den Profil-Einstellungs-Skripten eines Benutzers geladen werden kann, um die benötigten Umgebungsvariablen für die Ausführung der von kdesrc-build erstellten Plasma-Arbeitsfläche zu setzen.

Dieser Treiber verändert die folgenden Dateien:

  • $XDG_CONFIG_HOME/kde-env-master.sh (normalerweise unter ~/.config/kde-env-master.sh).

  • $XDG_CONFIG_HOME/kde-env-user.sh (normalerweise unter ~/.config/kde-env-user.sh).

Die Datei kde-env-user.sh ist optional. Sie ist für Benutzeranpassungen vorgesehen. siehe den Abschnitt Problembehebung und Fehlersuche der KDE UserBase mit Beispielen für benutzerdefinierte Einstellungen. Diese Einstellungen können vom Benutzer auch an anderer Stelle in den vorhandenen Skripten zur Einrichtung des Profils festgelegt werden.

Sie können diese Funktion deaktivieren, indem Sie diese Option auf false setzen und die Option install-session-driver ebenfalls deaktivieren.

Diese Option wurde in kdesrc-build 17.08 hinzugefügt.

Tipp

kdesrc-build überschreibt Ihre eigenen vorhandenen Dateien nicht, es sei denn, Sie geben die Befehlszeilenoption --delete-my-settings an.

install-session-driverKann nicht überschrieben werden

Ist diese Einstellung aktiviert, installiert kdesrc-build einen Treiber für die grafische Anmeldung, mit dem Sie sich für die durch kdesrc-build erstellte KDE-Arbeitsumgebung anmelden können.

Dieser Treiber verändert die folgenden Dateien:

  • ~/.xsession

  • $XDG_CONFIG_HOME/kde-env-master.sh (normalerweise unter ~/.config/kde-env-master.sh).

  • $XDG_CONFIG_HOME/kde-env-user.sh (normalerweise unter ~/.config/kde-env-user.sh).

Wenn Sie eine eigenen Anmeldungsprozedur benutzen, können Sie diese Funktion abschalten, indem Sie die Option auf den Wert false setzen. Ist diese Option aktiviert, dann wird auch die Funktion install-environment-driver verwendet.

Diese Option wurde in kdesrc-build 1.16 hinzugefügt.

Tipp

kdesrc-build überschreibt Ihre eigenen vorhandenen Dateien nicht, es sei denn, Sie geben die Befehlszeilenoption --delete-my-settings an.

kdedirModuleinstellung überschreibt die globale EinstellungMit dieser Option wird der Zielordner festgelegt, in den KDE nach dem Kompilieren installiert wird. Die Voreinstellung ist ~/kde. Wenn Sie hier einen Ordner einstellen, für den Systemverwalter-Rechte benötigt werden, sollten Sie auch die Anmerkungen zur Option make-install-prefix lesen.
kde-languagesKann nicht überschrieben werden

Mit dieser Option kann ausgewählt werden, welche Sprachpakete heruntergeladen und kompiliert werden. So kann KDE mit Übersetzungen in Ihrer Sprache ausgeführt werden.

Geben Sie alle Sprachen, die installiert werden sollen, in einer durch Leerzeichen getrennten Liste an. Für jede gewünschte Sprache ist der Sprachencode dafür einzutragen, den Sie auf der Seite http://l10n.kde.org/teams-list.php.

Es muss nur eine Sprache ausgewählt werden. Als Voreinstellung wird kein Sprachenpaket heruntergeladen. KDE wird in amerikanischem Englisch angezeigt.

Um zum Beispiel die französische Sprache zu installieren, wird für diese Option kde-languages fr eingetragen. Nach der Installation muss diese Sprache dann in den Systemeinstellungen als erste Sprache ausgewählt werden.

libpathModuleinstellung überschreibt die globale EinstellungMit dieser Option wird die Umgebungsvariable LD_LIBRARY_PATH für den Kompiliervorgang gesetzt. Sie können die Option für jedes Modul separat einstellen. In der Voreinstellung ist sie nicht gesetzt, aber die Pfade $KDEDIR/lib und $QTDIR/lib werden automatisch hinzugefügt. Sie können für Pfadangaben auch die Tilde (~) benutzen.
log-dirModuleinstellung überschreibt die globale EinstellungDiese Option wird zum Ändern des Ordners für Protokoll-Dateien des Skripts verwendet.
make-install-prefixModuleinstellung überschreibt die globale EinstellungGeben Sie für diese Variable eine Liste mit Befehlen ein. Mehrere Befehle werden durch Leerzeichen getrennt. Die hier eingegebenen Befehle werden vor jedem Aufruf von make install ausgeführt. Dies ist hilfreich, wenn Sie für die Installation einiger Pakete Systemverwalter-Rechte benötigen und daher zum Beispiel Sudo aufrufen müssen. Bitte seien Sie umsichtig im Umgang mit Systemverwalter-Rechten.
make-optionsModuleinstellung überschreibt die globale Einstellung (Option für das Erstellen)

Mit Hilfe dieser Variablen können Sie Befehlszeilen-Parameter an make übergeben. Das kann beispielsweise bei Verwendung von distcc oder auf Systemen mit mehr als einem Prozessor nützlich sein.

Nicht alle unterstützten Erstellungs-Systeme verwenden make. Für Systeme, die ninja für die Erstellung wie z.B. Meson verwenden, finden Sie im Abschnitt ninja-Optionen Informationen zur Einstellung.

manual-buildModuleinstellung überschreibt die globale EinstellungStellen Sie diese Option auf true, um zu verhindern, dass ein Modul kompiliert wird. Es wird dennoch weiterhin aktualisiert, wenn Quellen aus dem Subversion-Archiv heruntergeladen werden. Diese Option entspricht dem Befehlszeilen-Parameter --no-build.
manual-updateModuleinstellung überschreibt die globale EinstellungStellen Sie diese Option auf true, um zu verhindern, dass kdesrc-build ein Modul aktualisiert (und auch nicht kompiliert und installiert). Wenn Sie diese Option so verwenden, entspricht das im Grunde dem Auskommentieren - es wird völlig übergangen.
module-base-pathModuleinstellung überschreibt die globale Einstellung

Mit dieser Option können Sie den in kdesrc-build voreingestellten Pfad zu einem Modul übergehen. Das kann zum Beispiel verwendet werden, um für ein Modul einen besonderen Zweig oder eine als Tag vorhandene Version herunterzuladen. Bei der Suche nach dem richtigen Pfad kann Ihnen das KDE-WebSVN behilflich sein.

Beachten Sie: kdesrc-build setzt den Pfad nach dem folgenden Schema zusammen: $svn-server/home/kde/$module-base-path.

Die Voreinstellung ist entweder trunk/$module oder trunk/KDE/$module, abhängig vom Namen des Moduls.

Tipp

Verwenden Sie stattdessen die Optionen branch oder tag, sofern möglich.

nicenessKann nicht überschrieben werdenDiese Option können Sie auf einen Wert zwischen 20 und 0 einstellen. Je höher die Zahl, desto niedriger ist die Laufzeit-Priorität für kdesrc-build, d. h. bei einer höheren Zahl ist das Programm „netter“. Die Voreinstellung ist 10.
ninja-optionsModuleinstellung überschreibt die globale Einstellung (Option für das Erstellen)

Setzen Sie diese Variable, um Befehlszeilenoptionen an den Erstellungsbefehl ninja zu übergeben. Dies kann nützlich sein, um die Ausgabeverbose zu aktivieren oder manuell die Anzahl der parallelen Erstellungsvorgänge zu reduzieren, die ninja verwendet.

Anmerkung

Diese Einstellung steuert nur ninja, wenn sie von kdesrc-build verwendet wird. Das Qt™Modul webengine verwendet ninja indirekt, unterstützt dies aber offiziell nur, wenn es von make gebaut wird.In dieser Situation können Sie NINJAFLAGS angeben, um make die entsprechenden Parameter zu übergeben, wenn es später ninja mit make-options aufruft.

options qtwebengine
    # Beschränkt make und ninja auf maximal 6 getrennte Kompiliervorgänge auch
    # wenn mehr CPU-Leistung verfügbar ist, um die Auslastung des Speichers zu verringern
    make-options -j6 NINJAFLAGS=-j6
end options
no-svnModuleinstellung überschreibt die globale EinstellungSteht diese Option auf true, aktualisiert kdesrc-build nicht automatisch den Quelltext für dieses Modul, erstellt aber trotzdem das Modul, sofern dies nicht durch eine andere Option verhindert wird.
no-rebuild-on-fail Diese Option wurde in Version 1.10 entfernt, da dieses Verhalten wegen Fehlerbehebungen im zugrunde liegenden Erstellungssystem nicht mehr erforderlich ist.
num-coresKann nicht überschrieben werden

Diese Option wird durch kdesrc-build mit kdesrc-build-setup oder kdesrc-build --initial-setup auf die Anzahl der CPUs eingestellt, die mit dem externen Programm nproc) ermittelt wird. Kann kdesrc-build die Anzahl der CPUs nicht erkennen, wird ein Wert von 4 verwendet.

Unter Beispiel 2.1, „Einrichtung von Make, um alle verfügbaren CPUs mit Ausnahmen zu benutzen“ finden Sie ein Beispiel für die Verwendung dieser Option. Diese Option wurde in Version 20.07 hinzugefügt.

num-cores-low-memKann nicht überschrieben werden

Diese Option wird durch kdesrc-build mit kdesrc-build-setup oder kdesrc-build --initial-setup definiert, um die Anzahl der CPUs für Module wie qtwebengine mit hohem Speicherbedarf zu begrenzen, damit beim Erstellen der vorhandene Speicher nicht vollständig benutzt wird.

Als typische Berechnung wird ein CPU-Kern für jeweils 2 Gigabyte (GiB) des gesamten Speichers benutzt. Es wird mindestens 1 Kern und nicht mehr als die mit der Optionnum-cores angegebenen Kerne verwendet.

Obwohl diese Option für Qt™-Modulen gedacht ist, können Sie sie für beliebige Module auf dieselbe Weise wie num-cores verwenden.

Wenn kdesrc-build den verfügbaren Arbeitsspeicher nicht erkennen kann, wird dieser Wert auf 2 gesetzt.

Diese Option wurde in Version 20.07 hinzugefügt.

override-build-systemModuleinstellung überschreibt die globale Einstellung

Dies ist eine fortgeschrittene Option, sie wurde in kdesrc-build 1.16 hinzugefügt.

Normalerweise erkennt kdesrc-build das für ein heruntergeladenes Modul zu verwendende Erstellungssystem. Dies wird durch Suche nach besonderen Dateien im Quelltextordner des Moduls erreicht.

Einige Module können mehr als eine Datei enthalten, die Erstellungssysteme definieren. Dann funktioniert die automatische Erkennung nicht mehr korrekt. In diesem Fall kann das zu verwendende Erstellungssystem manuell vorgegeben werden.

Folgende Typen von Erstellungssystemen können zurzeit eingestellt werden:

KDE

Wird für die Erstellung von KDE-Modulen verwendet. Tatsächlich kann damit jedes Modul erstellt werden, das CMake benutzt. Aber darauf kann man sich nicht verlassen.

Qt

Wird für die Qt™-Bibliothek selbst verwendet.

qmake

Wird zur Erstellung von Qt™-Modulen verwendet, die .pro-Dateien im Stil von qmake enthalten.

generic

Für die Erstellung von Modulen, die einfache Make-Dateien verwenden und keine spezielle Konfiguration benötigen.

autotools

Dies ist das Standard-Konfigurationssystem für viele frei und quelloffene Software, die nicht in eine der anderen Kategorien sind.

meson

Dies ist ein relativ neues Werkzeug das als Ersatz für die Autotools an Popularität gewinnt und möglicherweise für einige nicht-KDE Module nötig ist.

override-urlModuleinstellung überschreibt die globale EinstellungWenn Sie diese Option einstellen, wird kdesrc-build den eingestellten Wert unverändert als Adresse an Subversion übergeben. Sie können diese Option grundsätzlich verwenden, um eine bestimmte Programmversion herunterzuladen. Dann kann kdesrc-build allerdings nichts mit der Option branch anfangen.
persistent-data-fileKann nicht überschrieben werden

Benutzen Sie diese Option, um den Speicherort der ständigen Daten von kdesrc-build zu ändern. In der Voreinstellung werden diese Datei in der Datei .kdesrc-build-data im gleichen Ordner wie die verwendete Einrichtungsdatei gespeichert. Benutzen Sie mehrere unterschiedliche Konfigurationen im selben Ordner, dann können Sie mit dieser Option verhindern, dass die verschiedenen Konfigurationen zu Konflikten bei den ständigen Daten führen.

Diese Option wurde in kdesrc-build 1.15 hinzugefügt.

prefixModuleinstellung überschreibt die globale Einstellung

Mit dieser Option wird festgelegt, in welchen Ordner die erstellten Module installiert werden. Als Voreinstellung wird kdedir verwendet. Mit dieser Option können Sie Module in einen anderen Ordner als die Bibliotheken der KDE-Plattform installieren. Damit benutzen Sie kdesrc-build nur zum Erstellen einzelner Programme,

Sie können ${MODULE} or $MODULE im Pfad verwenden, um sie zum Namen des Moduls zu erweitern.

--purge-old-logsModuleinstellung überschreibt die globale Einstellung

Diese Einstellung bestimmt, ob alte Protokollordner automatisch gelöscht werden. Der Standardwert ist true.

qmake-optionsModuleinstellung überschreibt die globale Einstellung

Alle hier angegebenen Optionen werden bei Modulen, die das Erstellungssystem qmake verwenden, an den Befehl qmake weitergegeben, Sie können zum Beispiel die Option PREFIX=/pfad/zu/qt für qmake benutzen, um den Installationsordner zu überschreiben.

Diese Option wurde in kdesrc-build 1.16 hinzugefügt.

qtdirModuleinstellung überschreibt die globale EinstellungMit dieser Option geben Sie einen Wert für die Umgebungsvariable QTDIR an. Wenn Sie diese Option nicht angeben, nimmt kdesrc-build an, dass Qt™ vom Betriebssystem bereitgestellt wird.
remove-after-installModuleinstellung überschreibt die globale Einstellung

Wenn Sie wenig Festplattenspeicher zur Verfügung haben, können Sie mit Hilfe dieser Option alle Kompilier-Ordner oder zusätzlich auch den Quelltext-Ordner nach der erfolgreichen Installation löschen lassen.

Die möglichen Einstellungen für diese Option sind:

  • none - Nichts wird gelöscht (dies ist die Voreinstellung).

  • builddir - Kompilier-Ordner werden gelöscht, aber keine Quelltext-Ordner.

  • all - Sowohl Kompilier- als auch Quelltext-Ordner werden gelöscht.

Beachten Sie: Die Verwendung dieser Option kann negative Auswirkungen auf Ihre Internet-Bandbreite und die Gesamtdauer einer KDE-Installation haben, weil kdesrc-build nicht mehr inkrementell kompilieren kann und die Pakete unter Umständen immer wieder neu herunterladen muss. Dies ist insbesondere der Fall, wenn Sie die Option auf all einstellen.

repositoryModuleinstellung überschreibt die globale Einstellung

Diese Option wurde mit der Version 1.10 eingeführt. Damit wird das Git-Archiv angegeben, aus dem der Quelltext heruntergeladen wird. Für Qt™ und qt ist diese Option nötig, ebenso die verschiedenen KDE-Module, deren Quelltext sich mittlerweile in Git-Archiven befindet.

revisionModuleinstellung überschreibt die globale Einstellung

Wird diese Option auf einen Wert größer 0 gesetzt, aktualisiert kdesrc-build den Quelltext des Moduls auf genau diese Revision, auch wenn zusätzlich Optionen wie branch verwendet werden. Hat das Modul bereits diese Revision, wird es nicht weiter aktualisiert, bis diese Option geändert oder aus der Einrichtungsdatei entfernt worden ist.

Anmerkung

Diese Option funktionierte nicht für Git-basierte Module einschließlich der Module aus dem KDE-Projektarchiv bis kdesrc-build-Version 1.16.

run-testsModuleinstellung überschreibt die globale Einstellung (Option für das Erstellen)Ist diese Option auf true gesetzt, dann werden für das Modul auch die Tests erstellt und beim Erstellen mit ausgeführt. kdesrc-build zeigt dann einen einfachen Bericht über das Testergebnis an. Die hilft Entwicklern und anderen zu überprüfen, ob das System richtig eingerichtet ist.
set-envModuleinstellung überschreibt die globale Einstellung

Diese Option erwartet eine Liste mit durch Leerzeichen getrennten Werten. Der erste Wert ist die zu setzende Umgebungsvariable, die restlichen Werte sind der Inhalt der Variable. Wenn Sie beispielsweise die Umgebungsvariable RONALD auf McDonald setzen möchten, würden Sie diese Einstellung verwenden:

set-env RONALD McDonald

Das besondere an dieser Option ist, dass Sie sie mehrfach verwenden können, ohne dass die jeweils vorige set-env-Option im gleichen Abschnitt der Einrichtungsdatei überschrieben wird. Auf diese Weise können Sie pro Modul und auch global mehrere Umgebungsvariablen setzen.

source-dirModuleinstellung überschreibt die globale EinstellungDiese Option legt den Ordner auf Ihrer Festplatte fest, in dem die KDE-Subversion-Quellen gespeichert werden sollen. Wenn Sie die Option nicht setzen, lautet die Voreinstellung ~/kdesrc. Sie können für diese Option die Tilde (~) als Abkürzung für Ihren persönlichen Ordner benutzen.
ssh-identity-fileKann nicht überschrieben werden

Mit dieser Option wird festgelegt, welche private SSH-Schlüsseldatei beim Befehl ssh-add verwendet wird, wenn kdesrc-build Quelltext aus einem Archiv herunterlädt, für das eine Authentifizierung erforderlich ist. Siehe auch „Überprüfung des SSH-Agenten“.

Diese Option wurde in Version 1.14.2 hinzugefügt.

stop-on-failureModuleinstellung überschreibt die globale EinstellungSetzen Sie diese Option auf true, wenn kdesrc-build beendet werden soll, sobald beim Kompilieren oder Installieren ein Fehler auftritt. Diese Einstellung ist in der Voreinstellung ausgeschaltet.
svn-serverModuleinstellung überschreibt die globale Einstellung

Mit dieser Option können Sie den zu verwendenden Subversion-Server festlegen. Die Voreinstellung ist der Server für anonymes Subversion svn://anonsvn.kde.org/.

Anmerkung

KDE-Entwickler sollten hier das Subversion-Archiv benutzen, das Ihnen mit dem Entwickler-Zugang mitgeteilt wurde, nicht das anonyme Archiv.

tagModuleinstellung überschreibt die globale Einstellung

Benutzen Sie diese Option, um eine bestimmte Version eines Moduls herunterzuladen.

Hinweis: Im Regelfall ist es sinnvoller, diese Option nicht zu benutzen. Fertige KDE-Versionen können üblicherweise als Tar-Archiv von einem der Softwarespiegelserver heruntergeladen werden.

Anmerkung

Diese Option wird für Git-basierte Module seit kdesrc-build 1.16 unterstützt..

use-clean-installModuleinstellung überschreibt die globale Einstellung (Option für das Erstellen)

Setzen Sie diese Option auf true, damit kdesrc-build make uninstall direkt vor dem Befehl make install ausführt.

Mit dieser Option wird sichergestellt, dass es keine alten Bibliotheksdateien, CMake-Metadaten usw. mehr gibt, die in über längere Zeit aktualisierten KDE-Installationen manchmal zu Problemen führen. Dies funktioniert jedoch nur für Erstellungssysteme, die den Befehl make uninstall unterstützen.

Diese Option wurde in kdesrc-build 1.12 hinzugefügt, war aber bis Version 1.16 nicht dokumentiert.

use-cmake Diese Option wurde in kdesrc-build Version 1.4 entfernt, da alle KDE 4 Module CMake erfordern. Die Verwendung von CMake für andere Module ist nicht möglich.
use-idle-io-priorityKann nicht überschrieben werdenMit dieser Option, die es in kdesrc-build seit der Version 1.12 gibt, wird die Auslastung der Ein-Ausgabe zum Beispiel zur Festplatte verringert. Damit kann das Verhalten des Systems auf Benutzeraktionen spürbar verbessert werden, die Laufzeit von kdesrc-build wird nur unwesentlich verlängert. In der Standardeinstellung ist diese Option deaktiviert. Setzen Sie diese Option auf true, um die Ein-/Ausgabe zur Festplatte weniger auszunutzen.
use-modulesKann nur in Modulgruppen verwendet werden

Mit dieser Option, die in kdesrc-build-Version 1.12.1 eingeführt wurde, können mehrere verschiedenen Module mit einem Eintrag in der Einrichtungsdatei angegeben werden.

Diese Option muss innerhalb einer Option module-set verwendet werden. Jeder an diese Option übergebene Name wird intern in ein Modul umgewandelt. Dabei wird als Option repository das Archiv der Modulgruppe in Kombination mit dem Namen benutzt, um das tatsächliche Archiv festzulegen, von dem die Quelltexte heruntergeladen werden. Alle weiteren Optionen für eine Modulgruppe werden unverändert auch für die generierten Module benutzt.

Die Reihenfolge der Module in dieser Option ist wichtig, da kdesrc-build die Module auch in dieser Reihenfolge aktualisiert, erstellt und installiert. Alle in einer Modulgruppe definierten Module werden von kdesrc-build verarbeitet, ehe das nächste Modul in der Modulgruppe bearbeitet wird.

Wenn Sie die Einstellungen für ein generiertes Modul ändern möchten, deklarieren Sie das Modul nochmal nach der Definition über die Modulgruppe. Auch wenn Sie auf diese Weise die Optionen für ein Modul verändern, wird das Modul trotzdem aktualisiert und in der Reihenfolgen erstellt, die durch die Modulgruppe vorgegeben wird. Die Reihenfolge der Erstellung kann durch diese Option also nicht geändert werden.

Wichtig

Als Name des Moduls wird der an use-modules übergebene Name nur ohne die Erweiterung .git verwendet.

Siehe „Modulgruppen“ und git-repository-base mit einer Beschreibung der Anwendung und einem Beispiel.

use-qt-builddir-hackModuleinstellung überschreibt die globale EinstellungDiese Option wurde entfernt, sie ist wegen des verbesserten Erstellungssystem für Qt™ nicht mehr erforderlich.
use-stable-kdeKann nicht überschrieben werden

Diese Option ist veraltet und wird in einer der nächsten Versionen wieder entfernt.

Bitte benutzen Sie stattdessen die Option branch-group, die mehr Auswahl ermöglicht.