Unterstützte Befehlszeilenparameter

Das Skript kennt die folgenden Befehlszeilenparameter:

--async

Aktualisiert den Quelltext und kompiliert gleichzeitig im asynchronen Modus. Dies ist die Voreinstellung, daher muss diese Option nur angegeben werden, wenn sie in der Einrichtungsdatei abgeschaltet wurde.

--help

Zeigt eine kurze Hilfe für dieses Skript an.

--version (oder -v)

Zeigt die Programmversion an.

--show-info

Zeigt Informationen über kdesrc-build und das Betriebssystem an, die in Fehlerberichten oder bei Hilfeanfragen in Foren oder Mailinglisten nützlich sein können.

Verfügbar seit Version 18.11.

--initial-setup

kdesrc-build führt die einmalige Ersteinrichtung durch, um das das System für den Betrieb von kdesrc-build und für die Ausführung der neu installierten KDE-Software vorzubereiten.

Dies schließt folgendes ein:

  • Installation bekannter Abhängigkeiten unter unterstützten Linux®-Distributionen

  • Hinzufügen erforderlicher Umgebungsvariablen zu ~/.bashrc

  • Erstellen einer Einrichtungsdatei

Verfügbar seit Version 18.11.

--author

Zeigt Kontaktinformationen zum Autor des Skripts an.

--color

Aktiviert die farbige Darstellung der Ausgabe. Dies ist die Voreinstellung für interaktive Terminals.

--nice=wert

Dieser Wert bestimmt die Priorität der CPU des Rechners, die von kdesrc-build angefordert wird und sollte einen Wert zwischen 0 und 20 haben. 0 entspricht der höchsten Priorität und am wenigsten nett, 20 entspricht der niedrigsten Priorität. Als Standard benutzt kdesrc-build den Wert 10.

--no-async

Deaktiviert den asynchronen Modus. So werden erst alle Module aktualisiert, ehe mit dem Erstellen begonnen wird. Insgesamt dauert damit die Ausführung länger, wenn aber IPC-Fehler bei der Ausführung von kdesrc-build auftreten, verwenden Sie diese Option und berichten den Fehler.

--no-color

Deaktiviert die farbige Darstellung der Ausgaben.

--pretend (oder -p)

kdesrc-build simuliert das Aktualisieren der Quelltexte und das Erstellen, aber ohne diese Aktionen tatsächlich auszuführen. Stattdessen werden alle simulierten Aktionen, d. h. die auszuführenden Befehle und Aktionen protokolliert.

Anmerkung

Einfache Befehle, die nur Informationen wie zum Beispiel Informationen über Dateien einlesen, können immer noch ausgeführt werden, damit das Protokoll auch zutreffend wird. Die Ausführung von Befehlen, die nur Daten lesen, ist zum Beispiel nötig, um zu prüfen, ob der Quelltext heruntergeladen oder aktualisiert werden muss.

Wichtig

Für diese Option müssen einige Metadaten vorhanden sein, die normalerweise automatisch heruntergeladen werden. Im Modus --pretend ist das Herunterladen jedoch abgeschaltet. Wenn Sie kdesrc-build noch nie ausgeführt haben und daher diese Metadaten noch nicht heruntergeladen wurden, sollten Sie kdesrc-build --metadata-only, damit diese Metadaten zuerst heruntergeladen werden.

--quiet (oder -q)

Reduziert die Ausgaben auf der Konsole auf grundlegende Informationen.

--really-quiet

Nur Warnungen und Fehler ausgeben.

--verbose

Es werden ausführliche Ausgaben erzeugt, Sie können den genauen Ablauf verfolgen.

--src-only (oder --svn-only)

Aktualisiert nur den Quelltext. Die Option --svn-only wird nur noch unterstützt, damit auch ältere Skripte noch funktionieren.

--build-only

Führt nur den Kompiliervorgang durch.

--install-only

Führt nur den Installationsvorgang durch.

--metadata-only

Lädt nur die Metadaten herunter. kdesrc-build führt dies normalerweise automatisch durch. Sie können dies manuell ausführen, damit die Befehlszeilenoption --pretend funktioniert.

--rebuild-failures

Verwenden Sie diese Option, um nur die Module zu erstellen, die bei der letzten Ausführung von kdesrc-build wegen Fehlern nicht erstellt wurden. Dies ist nützlich, wenn eine erhebliche Anzahl von Fehlern zusammen mit fehlerfreier Erstellung von Modulen aufgetreten ist. Nachdem Sie alle Ursachen für die Fehler bei der Erstellung beseitigt haben, können Sie mit dieser Option nur die Module neu erstellen, bei denen vorher Fehler aufgetreten sind,

Anmerkung

Beachten Sie, dass die Liste der vorherigen Fehler bei der Erstellung von Modulen jedes mal zurückgesetzt wird, wenn die Ausführung von kdesrc-build mit Fehlern für einige Module beendet wird. Durch eine vollständig erfolgreiche Erstellung wird diese Liste nicht zurückgesetzt, daher können Sie ein oder zwei Module neu erstellen und diese Option funktioniert auch dann noch.

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

--include-dependencies, --no-include-dependencies

Mit dieser Option veranlasst werden automatisch andere KDE- und Qt™-Module einbezogen, falls dies für die Module erforderlich ist, die Sie auf der Befehlszeile oder in Ihrer Einrichtungsdatei zum Erstellen angegeben haben.

Die Module werden wie im KDE-Quellcode-Verwaltungssystem hinzugefügt. Siehe „Die offizielle KDE-Moduldatenbank“.

Die entsprechende Option der Einrichtungsdatei include-dependencies.

Sie können auch --no-include-dependencies verwenden, das schaltet die automatische Einbeziehung zusätzlicher Abhängigkeitsmodule aus.

--ignore-modules

Alle auf diese Option folgenden Module auf der Befehlszeile werden nicht aktualisiert oder erstellt. Diese Option ist dann sinnvoll, wenn fast alle Module in Ihrer Einrichtungsdatei erstellt werden sollen und nur einige wenige ausgelassen werden.

--no-src (oder --no-svn)

Überspringt das Aktualisieren der Quelltexte vom Subversion-Server. Der Parameter --no-svn wird nur noch zur Kompatibilität mit älteren Versionen des Skripts unterstützt.

--no-build

Den Kompiliervorgang überspringen.

--no-metadata

Lädt die zusätzlichen Metadaten für die KDE-Git-Module nicht automatisch. Die Quelltexte der Module werden immer noch aktualisiert, wenn Sie nicht zusätzlich noch die Option --no-src verwenden.

Die ist nützlich, wenn Sie häufiger kdesrc-build neu ausführen, da die Metadaten sich nicht sehr häufig ändern. Beachten Sie jedoch, dass die Metadaten für viele andere Funktionen erforderlich sind. Sie sollten jedoch in Betracht ziehen, kdesrc-build einmal mit der Option --metadata-only auszuführen und dann diese Option für darauf folgende Ausführungen von kdesrc-build zu benutzen.

--no-install

Pakete nicht automatisch installieren, nachdem sie kompiliert wurden.

--no-build-when-unchanged, --force-build

Mit dieser Option wird das Überspringen von Modulen, eine Optimierung, die mit build-when-unchanged festgelegt wird, ausdrücklich verhindert. Diese Option ist dann sinnvoll, wenn das kdesrc-build Module erstellen soll, weil Sie Änderungen vorgenommen haben, die kdesrc-build nicht erkennt.

--force-build hat genau die gleiche Funktion, diese Option lässt sich vielleicht leichter merken.

--debug

Aktiviert den Modus zur Fehlersuche. Dies bedeutet, dass alle Ausgaben auf der Standardausgabe ausgegeben und zusätzlich im Protokoll abgelegt werden. Des weiteren sind die meisten Funktionen wesentlich gesprächiger.

--query=mode

Mit diesem Befehl fragt kdesrc-build einen Parameter der Module in der Erstellungs-Liste ab, der entweder auf der Befehlszeile angegeben oder aus der Einrichtungsdatei eingelesen wurde, und gibt das Ergebnis mit einem Modul je Zeile auf dem Bildschirm aus.

Diese Option muss mit einem der folgenden Abfragemodi benutzt werden:

  • source-dir, damit gibt kdesrc-build den vollständigen Pfad zum Ordner aus, in dem der Quellcode des Moduls gespeichert ist.

  • build-dir, damit gibt kdesrc-build den vollständigen Pfad zum Ordner aus, in dem der Erstellungsprozess des Moduls erfolgt.

  • install-dir, damit gibt kdesrc-build den vollständigen Pfad zum Ordner aus, in dem das Modul installiert wird.

  • project-path, damit gibt kdesrc-build den den Ort des Moduls innerhalb der Hierarchie der KDE-Quellcode-Repositories aus. Weitere Informationen über diese Hierarchie finden Sie unter „Die offizielle KDE-Moduldatenbank“.

  • Mit branch gibt kdesrc-build den aufgelösten Git-Branch aus, der für jedes Modul verwendet wird, basierend auf den Einstellungen tag-, branch- und branch-group.

  • Andernfalls können Namen von Optionen verwendet werden, die für Module in der Einrichtungsdatei gültig sind, deren aufgelöster Wert wird für jedes Modul aufgelistet.

Wenn ein einzelnes Modul auf der Befehlszeile übergeben wird, dann ist die Ausgabe einfach der Wert des abgefragten Parameters. Wenn mehrere (oder keine) Module in der Befehlszeile übergeben werden, wird jeder Zeile der Name des Moduls vorangestellt. In beiden Fällen wird kdesrc-build nicht mehr ausgeführt, sobald jeder Wert ausgegeben wurde.

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

Mit dem Befehl kdesrc-build --query branch kactivities kdepim wird zum Beispiel diese Ausgabe erzeugt:

kactivities: master
kdepim: master
--no-rebuild-on-fail

Es wird nicht versucht, ein Modul nach einem Fehler erneut zu kompilieren. Es werden grundsätzlich keine Module neu kompiliert, bei denen es bereits einen Fehler beim Kompilieren gegeben hat.

--refresh-build

Aktualisiert das Erstellungssystem und beginnt den Kompiliervorgang von vorne.

--reconfigure

Führt die Befehle cmake (für KDE-Module) oder configure (für Qt™) nochmal aus, ohne den Erstellungsordner zu löschen. Diese Option ist normalerweise nicht erforderlich, da kdesrc-build erkennt, wenn wichtige Optionen geändert wurden, und dann das Erstellen erneut startet. Diese Option ist in --refresh-build automatisch enthalten.

--resume-from

Mit dieser Option wird das Erstellen mit dem angegebenen Modul fortgesetzt, das als nächste Option auf der Befehlszeile angegebenen ist. Sie sollten keine weiteren Modul-Namen auf der Befehlszeile übergeben.

Anmerkung

Mit dieser Option wurde früher auch die Option --no-src angewendet, dies ist aber seit kdesrc-build Version 1.13 geändert. Wenn Sie bei der Wiederaufnahme die Aktualisierung des Quelltextes vermeiden möchten, müssen Sie zusätzlich --no-src zu den anderen Optionen angeben.

Siehe auch --resume-after und „Ein abgebrochenes oder fehlgeschlagenes Erstellen fortsetzen“. Diese Befehlszeilenoption sollten Sie benutzen, wenn Sie den Fehler beim Erstellen beseitigt haben und mit kdesrc-build das Erstellen fortsetzen möchten.

--resume-after

Mit dieser Option wird das Erstellen mit dem als nächste Option auf der Befehlszeile angegebenen Modul fortgesetzt. Sie sollten keine weiteren Modul-Namen auf der Befehlszeile übergeben.

Anmerkung

Mit dieser Option wurde früher auch die Option --no-src angewendet, dies ist aber seit kdesrc-build Version 1.13 geändert. Wenn Sie bei der Wiederaufnahme die Aktualisierung des Quelltextes vermeiden möchten, müssen Sie zusätzlich --no-src zu den anderen Optionen angeben.

Siehe auch --resume-after und „Ein abgebrochenes oder fehlgeschlagenes Erstellen fortsetzen“. Diese Befehlszeilenoption sollten Sie benutzen, wenn Sie den Fehler beim Erstellen beseitigt und auch das betreffende Modul manuell erstellt und installiert haben und mit kdesrc-build das Erstellen mit dem nächsten Modul fortsetzen möchten.

--resume

Diese Option kann zur Ausführung von kdesrc-build nach einem Erstellungsfehler verwendet werden.

Mit dieser Option wird das Erstellen mit dem fehlerhaften Modul fortgesetzt und dabei die Liste mit den noch zu verarbeitenden Module vom letzten Erstellen verwendet. Die Aktualisierung der Quelltexte und Metadaten ist abgeschaltet. Diese Option kann benutzt werden, wenn ein einfacher Fehler oder eine fehlende Abhängigkeit zum Erstellungsfehler führte. Nach der Korrektur des Fehlers können Sie einfach mit der Erstellen weitermachen, ohne die Optionen --resume-from und --stop-before anwenden zu müssen.

Die ist sogar noch praktischer als mit der Option --stop-on-failure, besonders wenn Sie zum ersten Mal Ihre Entwicklungsumgebung einrichten.

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

--stop-before

Diese Befehlszeilenoption wird benutzt, um den normalen Erstellungsprozess genau vor einem Modul anzuhalten.

Wenn zum Beispiel die normale Erstellungsliste die Einträge ModulA, ModulB, ModulC enthält, erstellt kdesrc-build mit der Option --stop-before=ModulB nur das ModulA.

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

--stop-after

Diese Befehlszeilenoption wird benutzt, um den normalen Erstellungsprozess genau nach einem Modul anzuhalten.

Wenn zum Beispiel die normale Erstellungsliste die Einträge ModulA, ModulB, ModulC enthält, erstellt kdesrc-build mit der Option --stop-after=ModulB die Module ModulA und ModulB.

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

--stop-on-failure

Mit dieser Option wird das Erstellen abgebrochen, sobald ein Fehler auftritt. Dies ist nützlich, wenn Sie zum ersten Mal eine Entwicklungsumgebung einrichten, Ohne diese Option werden die restlichen Module durch kdesrc-build weiter erstellt, damit keine Zeit verschwendet wird, wenn es nur einen Fehler bei einem Modul gibt.

Diese Option wurde in kdesrc-build Version 1.16 hinzugefügt, lesen Sie bitte auch die Informationen zur Option stop-on-failure.

--rc-file

Der auf diese Option folgende Parameter ist die Einrichtungsdatei, aus der die Optionen eingelesen werden sollen. Die Voreinstellung für diesen Parameter ist kdesrc-buildrc. Diese Datei wird im aktuellen Ordner gesucht. Ist diese Datei nicht vorhanden wird die Datei ~/.kdesrc-buildrc gelesen. Siehe auch Kapitel 4, kdesrc-build einrichten.

--print-modules

Führt alle Aktionen einschließlich Neuordnung der Abhängigkeiten der auf der Befehlszeile oder in der Einrichtungsdatei angegebenen Module und gibt die Module, die verarbeitet würden, einzeln je Zeile aus. Dann wird das Skript ohne weitere Aktionen beendet.

Die Metadaten kde-project werden zuerst heruntergeladen, siehe allerdings auch --pretend oder --no-src.

Die Ausgabe ist nicht vollständig kompatibel mit der Verwendung des Skript, da andere Ausgabenachrichten generiert werden können, bis die Modulliste angezeigt wird.

Dies ist hauptsächlich sinnvoll, um schnell festzustellen, wie kdesrc-build die Abhängigkeiten eines Moduls versteht, das heißt die Option ist nur für Module in kde-projects zu verwenden. Diese Option ist kompatibel mit --resume-from, --resume-after, --stop-before, --stop-after.

--list-build

Listet die Module auf, die gebaut und in welcher Reihenfolge sie gebaut werden würden. Falls zutreffend, wird in der Ausgabeliste auch erwähnt, welcher Commit/Branch/Tag gewählt würde.

Diese Option ist ähnlich wie --print-modules. Genauere Informationen darüber, wie Module miteinander in Beziehung stehen, finden Sie unter --dependency-tree.

--dependency-tree

Gibt Abhängigkeitsinformationen zu den Modulen in einem Baumformat (rekursiv) aus. Die aufgelisteten Informationen enthalten auch die Abhängigkeitvon einem bestimmte Commit/Branch/Tag und ob die Abhängigkeit gebaut wird oder nicht. gebaut wird. Hinweis: Die generierte Ausgabe kann für Anwendungen mit vielen Abhängigkeiten ziemlich groß werden.

--run

Diese Option interpretiert den nächsten Parameter auf der Befehlszeile als Programm, das auszuführen ist. kdesrc-build beendet erst das Einlesen der Einrichtungsdatei, aktualisiert die Umgebungsvariablen und führt dann das Programm aus.

Damit lässt sich keine neue Shell mit den Umgebungsvariablen von kdesrc-build starten, da interaktive Shells normalerweise mindestens einen Teil der Umgebungsvariablen wie PATH und KDEDIRS beim Startvorgang zurücksetzen.

Tipp

Möchten Sie die von kdesrc-build benutzten Umgebungsvariablen sehen, geben Sie den Befehl printenv ein.

$ kdesrc-build --run printenv
KDE_SESSION_VERSION=4
SDL_AUDIODRIVER=alsa
LANGUAGE=
XCURSOR_THEME=Oxygen_Blue
LESS=-R -M --shift 5
QMAIL_CONTROLDIR=/var/qmail/control
... etc.
--prefix=</pfad/zu/kde>

Ermöglicht Ihnen, den Ordner zu wählen, in den KDE installiert wird. Diese Option schließt automatisch --reconfigure ein, aber die Option --refresh-build kann immer noch erforderlich sein.

--revision

Mit dieser Option wird kdesrc-build eine vorgegebene Revisionsnummer für jedes Modul herunterladen. Damit werden alle Einstellungen der Optionen branch, tag oder revision für diese Module überschrieben.

Diese Option sollten Sie nicht mehr verwenden, Sie wird nur noch unterstützt, damit ältere Skripte noch funktionieren

--build-system-only

Mit dieser Option bricht kdesrc-build das Erstellen eines Moduls direkt vor der Ausführung des Befehls make ab. Diese option wird nur zur Kompatibilität mit älteren Versionen des Skripts unterstützt. Beim aktuellen Erstellungssystem für KDE ist diese Option nicht mehr nötig.

--install

Wenn dies der einzige Befehlszeilen-Parameter ist, wird versucht, alle Module zu installieren, die in der Datei log/latest/build-status aufgelistet sind. Wenn Sie nach --install weitere Parameter angeben, werden diese als Module interpretiert, die installiert werden sollen, auch wenn diese Module beim letzten Mal nicht erstellt werden konnten.

--no-snapshots

Mit dieser Option wird beim ersten Mal der Quelltext immer normal heruntergeladen anstatt ein komprimiertes Archiv zu benutzen, das nur für Git-Module aus dem kde-projects-Archiv zur Verfügung gestellt wird. Diese Option sollte nur verwendet werden, falls Fehler bei komprimierten Archiven auftreten, um die KDE-Quelltextarchive nicht zu überlasten.

Anmerkung

Komprimierte Archive sind tatsächlich Subversion-Archive. Diese Option ist normalerweise nicht erforderlich, sie sollte nur bei Problemen mit dem Herunterladen benutzt werden.

--delete-my-patches

Diese Option wird von kdesrc-build dazu verwendet, Quelltextordner mit Benutzerdaten zu löschen, damit ein Modul wieder heruntergeladen werden kann. Dies ist normalerweise nur für KDE-Entwickler sinnvoll, die möglicherweise lokale Änderungen haben, die beim Herunterladen gelöscht würden.

Diese Option wird zurzeit nur für das Herunterladen von Modulen benutzt, die von Subversion nach Git konvertiert wurden. Normalerweise sollten Sie diese Option nicht verwenden, da kdesrc-build nachfragt, ob dieser Vorgang wiederholt werden soll, falls nötig.

--delete-my-settings

Mit dieser Option überschreibt kdesrc-build vorhandene Dateien, die Daten von Benutzern enthalten können.

Diese Option wird zurzeit nur für die Einrichtung von „xsession“ für die Anmeldung benutzt. Normalerweise sollten Sie diese Option nicht verwenden, da kdesrc-build nachfragt, ob dieser Vorgang wiederholt werden soll, falls nötig.

--<option-name>=

Dies können Sie verwenden, um eine Option in Ihrer Einrichtungsdatei für einzelne Module zu überschreiben. Beispiel: --log-dir=/pfad/zu/ordner würde die Option log-dir überschreiben.

Anmerkung

Diese Funktion kann nur für Namen von Optionen benutzt werden, die bereits vorher durch kdesrc-build erkannt wurden und die noch nicht auf der Befehlszeile unterstützt werden. Die Option async in der Einrichtungsdatei zum Beispiel hat spezifische Befehlszeilenoption --async und --no-async, die von kdesrc-build bevorzugt verwendet werden.

--set-module-option-value=<module-name>,<option-name>,<option-value>

Mit dieser Option können Einstellungen aus der Einrichtungsdatei für ein einzelnes Module überschrieben werden.

Alle weiteren Parameter werden als Modul-Namen interpretiert, die aktualisiert oder kompiliert werden sollen. Verwechseln Sie Kompilieren nicht mit Installieren.