Ondersteunde commandoregelparameters

Het script accepteert de volgende commandoregelopties:

--async

Schakelt de asynchronous modus in, zodat de update van de broncode en het bouwproces van modules tegelijk kan gebeuren. Dit is de standaardinstelling, u hoeft deze optie alleen op te geven als u het in het configuratiebestand heeft uitgeschakeld.

--help

Toont voor dit script alleen een eenvoudige hulp.

--version (of -v)

Toont de programma-versie.

--show-info

Toont informatie over kdesrc-build en het besturingssysteem wat nuttig kan zijn in bugrapporten of bij vragen om hulp in forums of op e-maillijsten.

Beschikbare sinds versie 18.11.

--initial-setup

Laat kdesrc-build de eenmalige initiële instelling doen nodig om het systeem voor te bereiden om kdesrc-build te laten werken en om de nieuw geïnstalleerde KDE software uit te voeren.

Dit omvat:

  • Bekende afhankelijkheden worden geïnstalleerd (op ondersteunde Linux® distributies)

  • Vereiste omgevingsvariabelen worden aan ~/.bashrc toegevoegd

  • Het configuratiebestand instellen.

Beschikbare sinds versie 18.11.

--author

Toont contactinformatie van de auteur.

--color

Kleurrijke uitvoer inschakelen (dit is de standaard voor interactieve terminals).

--nice=waarde

Deze waarde wijzigt de prioriteit voor de computer CPU zoals verlangt door kdesrc-build, en zou in de range van 0-20 moeten liggen. 0 is de hoogste prioriteit (omdat dat het minste nice is), 20 is de laagste prioriteit. De standaardinstelling van kdesrc-build is 10.

--no-async

Schakelt de asynchronous modus van de update uit. In plaats daarvan zal de update in zijn geheel worden uitgevoerd voordat de bouw start. Deze optie vertraagt het gehele proces, maar als u last heeft van IPC fouten tijdens het gebruik van kdesrc-build, probeer dan het gebruik van deze optie, en dien een bug rapport in.

--no-color

Schakelt "gekleurde uitvoer" uit.

--pretend (of -p)

kdesrc-build zal door het update en bouwproces gaan, maar in plaats van enige actie voor het updaten en bouwen daadwerkelijk uit te voeren, zal het de uitvoer tonen van wat het script zou hebben gedaan (b.v. welke commando's uit te voeren, welke algemene stappen zijn genomen, enz.).

Opmerking

Eenvoudige alleen-lezen commando's (zoals het lezen van bestandsinformatie) worden nog steeds uitgevoerd om de uitvoer meer relevant te maken (zoals het correct simuleren of broncode uitgecheckt of upgedate kan worden).

Belangrijk

Voor deze optie is het nodig dat sommige benodigde metadata beschikbaar is, wat normaal gesproken automatisch gedownload is,maar downloads zijn in de pretend modus uitgeschakeld. Als u nog nooit kdesrc-build eerder heeft gebruikt (en daarom deze metadata niet heeft), dan moet u eerst kdesrc-build --metadata-only opstarten om eerst de benodigde metadata te downloaden.

--quiet (of -q)

Wees niet zo luidruchtig met de uitvoer. Met dit ingeschakeld zal alleen het minimum in de uitvoer te zien zijn.

--really-quiet

Alleen waarschuwingen/fouten worden getoond.

--verbose

Beschrijft uitgebreid wat er gebeurt, en wat kdesrc-build aan het doen is.

--src-only (of --svn-only)

Voert alleen de update van de broncode uit. (De --svn-only parameter is alleen ondersteund vanwege compatibiliteit met oudere versies van het script).

--build-only

Voert alleen het bouwproces uit.

--install-only

Voert alleen het installatieproces uit.

--metadata-only

Voert alleen het metadata downloadproces uit. kdesrc-build doet dit normaal automatisch, maar u wilt dit wellicht handmatig doen zodat de commandoregelparameter --pretend kan werken.

--rebuild-failures

Gebruik deze optie om alleen die modules te bouwen die eerder mislukt zijn bij uitvoeren van kdesrc-build. Dit is handig als een belangrijk aantal mislukkingen optraden gemend met succesvol bouwen. Na het repareren van de oorzaken van de mislukkingen kunt u dan gemakkelijk alleen de modulen bouwen die eerder mislukten.

Opmerking

Merk op dat de lijst met eerder mislukte modules wordt gereset elke keer dat het uitvoeren van kdesrc-build eindigt met enige mislukkingen. Het wordt niet gereset door een volledig succesvol bouwen, u kunt dus met succes een paar modules bouwen en dan zal deze vlag nog steeds werken.

Deze optie is toegevoegd in kdesrc-build 15.09.

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

Deze optie veroorzaakt dat kdesrc-build automatisch andere KDE en Qt™ modulen invoegt in het bouwen, indien vereist voor de modulen die u hebt gevaagd om te bouwen op de opdrachtregel of in uw configuratiebestand.

De modulen die zijn toegevoegd zijn zoals opgenomen in de broncode van het KDE beheersysteem. Zie de paragraaf met de naam “De officiële database voor KDE-modulen”.

Het corresponderende configuratiebestandsoptie is include-dependencies.

U kunt ook --no-include-dependencies gebruiken, die automatisch invoegen van extra afhankelijkheidsmodulen uitsluitent.

--ignore-modules

Neem niet de modulen mee die in de rest van de commandoregel worden doorgegeven in het bijwerken/bouwprocess (dit is handig als u de meeste modulen in uw configuratiebestand wilt bouwen en alleen een paar overslaan).

--no-src (of --no-svn)

Slaat het contact maken met de Subversion server over. (De --no-svn parameter is alleen ondersteund vanwege compatibiliteit met oudere versies van het script).

--no-build

Het bouwproces overslaan.

--no-metadata

Download niet automatisch de voor KDE git modules benodigde extra metadata. De updates van de broncode voor de modules zelf zal nog gewoon gebeuren tenzij u ook --no-src opgeeft.

Dit kan handig zijn als u frequent kdesrc-build herhaalt omdat de metadata niet vaak wijzigt. Maar merk op dat het voor veel andere functionaliteiten nodig is dat de metadata beschikbaar is. U kunt overwegen om eenmalig kdesrc-build met de optie --metadata-only te gebruiken en daarna deze optie voor de daaropvolgende runs te gebruiken.

--no-install

Installeert niet automatisch pakketten nadat ze zijn gebouwd.

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

Deze optie schakelt expliciet het overslaan van het bouwproces uit (een optimalisatie gecontroleerd door de optie build-when-unchanged). Dit is handig om te zorgen dat kdesrc-build het bouwproces uitvoert als u iets heeft gewijzigd dat kdesrc-build niet kan controleren.

--force-build heeft dezelfde functie, en is misschien makkelijker te onthouden.

--debug

Schakelt de debug modus van het script in. Op dit moment houd dat in dat alle uitvoer naast dat het zoals normaal naar de log-map gaat ook naar de gewone uitvoer gaat. Daarnaast geven veel functies in de debug modus meer commentaar over wat ze aan het doen zijn.

--query=modus

Dit commando veroorzaakt dat kdesrc-build een parameter opvraagt van de modules in de bouwlijst (ofwel doorgegeven op de commandoregel of gelezen uit het configuratiebestand), waarna het resultaat op het scherm wordt getoond (één module per regel).

Deze optie moet geleverd worden met een query-modus, die één van de volgende zou moeten zijn:

  • source-dir, die zorgt dat kdesrc-build het volledige pad opgeeft waar de broncode van de module is opgeslagen.

  • build-dir, die zorgt dat kdesrc-build het volledige pad opgeeft waar het bouwproces van de broncode van de module gebeurt.

  • install-dir, die zorgt dat kdesrc-build het volledige pad opgeeft waar de module zal worden geïnstalleerd.

  • project-path, die zorgt dat kdesrc-build de locatie van de module in de hierarchy van KDE broncoderepositories opgeeft. Zie de paragraaf met de naam “De officiële database voor KDE-modulen” voor meer informatie over de hiërarchie.

  • branch, die zorgt dat kdesrc-build de opgeloste git-branch opgeeft die voor elke module zal worden gebruikt, gebaseerd op de effectieve instellingen van tag, branch en branch-group.

  • Anders kunnen optie-namen gebruikt worden die geldig zijn voor modulen in het configuratiebestand, de opgeloste waarde daarvan zal voor elke module worden getoond.

Als een enkele module wordt doorgegeven op de opdrachtregel, dan is de uitvoer gewoon de waarde van de parameter die wordt afgevraagd. Als meerdere (of geen) modulen worden doorgegeven op de opdrachtregel, dan wordt elke regel voorafgegaan door de naam van de module. In alle gevallen zal kdesrc-build stoppen met de uitvoering wanneer elke waarde is uitgevoerd.

Deze optie is toegevoegd in kdesrc-build 16.05.

Bijvoorbeeld, het commanddo kdesrc-build --query branch kactivities kdepim zou kunnen eindigen met meldingen zoals:

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

Probeert niet meer modules te herbouwen nadat het de eerste keer is mislukt om ze te bouwen. kdesrc-build zal dit nooit proberen bij een module waarbij het al de eerste keer is geprobeerd om te bouwen.

--refresh-build

Maakt het bouwsysteem en make opnieuw vanaf het begin aan.

--reconfigure

Start cmake (voor KDE modules) of configure (voor Qt™) opnieuw, zonder de bouwmap op te ruimen. U zou normaal gesproken dit niet hoeven te specificeren, omdat kdesrc-build het zal detecteren als u relevante optiewaarden heeft gewijzigd en automatisch de build setup opnieuw zal uitvoeren. Deze optie is wordt uitgevoerd als u --refresh-build gebruikt.

--resume-from

Deze optie gebruikt u om de bouw te hervatten vanaf de opgegeven module, wat de volgende optie op de commandoregel zou zijn. Specificeer geen andere modulenamen op de commandoregel.

Opmerking

Deze optie voegde vroeger --no-src toe, maar doet dit niet meer (vanaf kdesrc-build 1.13). Als u het updaten van broncode wilt vermijden bij het verdergaan, voeg dan naast de andere opties gewoon--no-src toe.

Zie ook: --resume-after en de paragraaf met de naam “Hervatten na een mislukte of afgebroken bouwproces”. U geeft waarschijnlijk de voorkeur aan deze commandoregelparameter als u het probleem met het bouwen heeft opgelost en wilt dat kdesrc-build verder gaat met het bouwen.

--resume-after

Deze optie gebruikt u om de bouw te hervatten na de opgegeven module, wat de volgende optie op de commandoregel zou zijn. Specificeer geen andere modulenamen op de commandoregel.

Opmerking

Deze optie voegde vroeger --no-src toe, maar doet dit niet meer (vanaf kdesrc-build 1.13). Als u het updaten van broncode wilt vermijden bij het verdergaan, voeg dan naast de andere opties gewoon--no-src toe.

Zie ook: --resume-after en de paragraaf met de naam “Hervatten na een mislukte of afgebroken bouwproces”. U geeft waarschijnlijk de voorkeur aan deze commandoregeloptie als u het probleem met het bouwen heeft opgelost en de module zelf heeft gebouwd en geïnstalleerd, en wilt dat kdesrc-build verder gaat met het bouwen van de volgende module.

--resume

Deze optie kan gebruikt worden om kdesrc-build uit te voeren nadat het bouwen is mislukt.

Het hervat het bouwen vanaf de module die is mislukt, met gebruik van de lijst van modules die eerder wachten om te worden gebouwd en schakelt eveneens het bijwerken van broncode en metagegevens uit. Dit is te gebruiken wanneer een eenvoudige vergissing of ontbrekende afhankelijkheid het bouwen laat mislukken. Nadat u de fout hebt gerepareerd kunt u snel terug gaan naar het bouwen van de modules die u eerder aan het bouwen was, zonder te rommelen met --resume-from en --stop-before.

Dit is zelfs nog handiger als u het combineert met commandoregelparameter --stop-on-failure, met name als u initieel uw ontwikkelomgeving opzet.

Deze optie is toegevoegd in kdesrc-build 1.16.

--stop-before

Deze commandoregeloptie gebruikt u om het bouwproces te stoppen net voor een module normaal gesproken zou worden gebouwd.

Bijvoorbeeld, als het normale bouwproces is moduleA, moduleB, moduleC, dan zal --stop-before=moduleB veroorzaken dat kdesrc-build alleen moduleA zal bouwen.

Deze optie voor de opdrachtregel is toegevoegd in kdesrc-build 1.16.

--stop-after

Deze commandoregeloptie gebruikt u om het bouwproces te stoppen net na een module normaal gesproken zou worden gebouwd.

Bijvoorbeeld, als het normale bouwproces is moduleA, moduleB, moduleC, dan zal --stop-after=moduleB veroorzaken dat kdesrc-build zowel moduleA en moduleB zal bouwen.

Deze optie voor de opdrachtregel is toegevoegd in kdesrc-build 1.16.

--stop-on-failure

Deze optie zorgt er voor dat het bouwen wordt afgebroken zodra er iets mislukt. Nuttig wanneer u initieel uw ontwikkelomgeving aan het instellen bent. Zonder deze vlag zal kdesrc-build proberen door te gaan met de rest van de modules in het bouwen om tijdverspilling te voorkomen in het geval er een probleem is met een enkele module.

Deze optie is toegevoegd in kdesrc-build 1.16. Zie ook de optie stop-on-failure.

--rc-file

Dit interpreteert de volgende commandoregelparameter als het bestand waarvan de configuratiegegevens moeten worden ingelezen. De standaardwaarde voor deze parameter is kdesrc-buildrc (deze wordt in de huidige map gezocht) indien aanwezig, of anders ~/.kdesrc-buildrc. Zie ook Hoofdstuk 4, De kdesrc-build configureren.

--print-modules

Neemt alle acties tot en met opnieuw ordenen van moduleafhankelijkheid gespecificeerd op de opdrachtregel (of configuratiebestand), toont één per regel de modules die verwerkt zouden worden en eindigt dan zonder verdere actie.

De metagegevens van kde-project wordt eerst gedownload (maar, zie --pretend of --no-src).

De meldingen zijn niet volledig compatibel met gebruik door scripts omdat andere meldingen gegenereerd kunnen worden totdat de lijst met modules wordt getoond.

Dit is vooral handig om snel te bepalen wat kdesrc-build begrijpt wat de afhankelijkheden van een module zijn, wat inhoud dat het alleen bruikbaar is bij modules van kde-projects. Deze optie is ook te combineren met --resume-from, --resume-after, --stop-before, --stop-after.

--list-build

Maakt een lijsts met de modules die gebouwd zouden worden, in de volgorde waarin ze gebouwd worden. Indien van toepassing, bevat de uitvoerlijst ook welke commit/branch/tag geselecteerd zou worden voor checkout.

Deze optie is gelijk aan --print-modules. Voor meer gedetailleerde informatie over hoe modules in relatie staan tot elkaar, zie ook: --dependency-tree.

--dependency-tree

Drukt informatie over afhankelijkheden af over de modulen die gebouwd zouden worden in boomstructuurformaat (recursief). Getoonde informatie omvat ook waarvan specifieke commit/branch/tag afhankelijk is en of wel of niet de afhankelijkheid zou worden gebouwd. Let op: de gegenereerde uitvoer kan behoorlijk groot worden voor toepassingen met veel afhankelijkheden.

--run

Deze optie interpreteert het volgende item op de commandoregel als een uit te voeren programma, en kdesrc-build zal dan het inlezen van het configuratiebestand beëindigen, de omgevingsvariabelen zoals normaal bijwerken, en het opgegeven programma opstarten.

Dit zal in de meeste gevallen echter geen shell met de omgevingsvariabelen van kdesrc-build opstarten, omdat interactieve shells tijdens de start standaard tenminste een gedeelte van de omgevingsvariabelen (zoals PATH en KDEDIRS) resetten.

Tip

Als u de de omgevingsvariabelen wilt zien die door kdesrc-build wordt gebruikt, dan kunt het commando printenv gebruiken:

$ 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=</path/to/kde>

Hiermee kunt u de map wijzigen waar in KDE vanaf de commandoregel zal worden geïnstalleerd. Deze optie houd --reconfigure in, maar het gebruik van --refresh-build kan nodig zijn.

--revision

Deze optie zorgt ervoor dat kdesrc-build voor elke Subversion module een specifieke genummerde revisie uitcheckt, daarmee alle voor deze modules ingestelde branch, tag, of revision optie's overschrijvent.

Deze optie is waarschijnlijk geen good idee, en is alleen ondersteund vanwege compatibiliteit met oudere versies van het script.

--build-system-only

Deze optie zorgt er voor dat kdesrc-build het bouwen van een module afbreekt net voordat het commando make zou worden opgestart. Dit wordt alleen ondersteund vanwege de compatibiliteit met oudere versies, Deze functionaliteit is niet behulpzaam bij het huidige KDE build systeem.

--install

Als dit de enige commandoregelparameter is, dan probeert het alle modules te installeren die voorkomen in log/latest/build-status. Als u commandoregelparameters specificeert na --install, dan wordt aangenomen dat dit allemaal te installeren modules zijn (zelfs als ze bij de laatste run niet succesvol gebouwd zijn).

--no-snapshots

Deze optie zorgt er voor dat kdesrc-build altijd een normale initiële checkout van een module doet in plaats van een quick-start snapshot (alleen beschikbaar voor Git modules uit de kde-projects repository). Merk op dat u deze optie alleen moet gebruiken als het gebruiken van snapshots mislukt, omdat de quick-start snapshot minder belastend zijn voor de KDE broncoderepositories.

Opmerking

Module snapshots zijn echte checkouts. Normaal gesproken heeft u deze optie niet nodig, het is alleen een hulpmiddel voor troubleshooting.

--delete-my-patches

Deze optie zorgt er voor dat kdesrc-build de mappen met broncode verwijdert waarin gebruikersdata kan voorkomen, zodat de module opnieuw kan worden gedownload. Dit is normaal gesproken alleen zinnig voor KDE-ontwikkelaars (die wellicht lokaal wijzigingen hebben die verwijderd zouden kunnen worden).

Dit word op dit moment alleen gebruikt om modules uit te checken die zijn geconverteerd van Subversion naar Git. Normaal gesproken heeft u deze optie niet nodig, kdesrc-build zal vragen om opnieuw te worden gestart als dat nodig is.

--delete-my-settings

Deze optie gebruikt u om kdesrc-build bestaande bestanden waarin gebruikersdata kan voorkomen te laten overschrijven.

Dit wordt op dit moment alleen gebruikt voor de xsession setup van de login manager. Normaal gesproken heeft u deze optie niet nodig, kdesrc-build zal vragen om opnieuw te worden gestart als dat nodig is.

--<optie-naam>=

U kunt dit gebruiken om een optie in uw configuratiebestand voor elke module te overschrijven. Bijvoorbeeld, om de optie log-dir te overschrijven, zou u kunnen doen: --log-dir=/path/to/dir.

Opmerking

U kunt deze functionaliteit alleen gebruiken bij optie-namen die al bekend zijn in kdesrc-build, en dat ze niet al worden gebruikt bij relevante commandoregelopties. Bijvoorbeeld de optie async van het configuratiebestand heeft de specifieke commandoregelopties --async en --no-async geprefereerd door kdesrc-build.

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

U kunt dit gebruiken om een optie in uw configuratiebestand voor specifieke module te overschrijven.

Van alle andere commandoregelopties wordt aangenomen dat het bij te werken en te bouwen modules zijn. Haal het bouwen en het installeren niet door elkaar.