Skriptet accepterar följande kommandoradsväljare:
--async
Aktiverar asynkront användningssätt som kan utföra uppdateringar av källkoden och bygga moduler samtidigt. Det är förvalt värde, och väljaren behöver bara anges om du har inaktiverat det i inställningarna.
--help
(eller-h
)Visa bara enkel hjälp om skriptet.
--version
(eller-v
)Visa programmets version.
--show-info
Visar information om kdesrc-build och operativsystemet, vilket kan vara användbart i felrapporter eller när hjälp efterfrågas på forum eller e-postlistor.
Tillgängligt sedan version 18.11.
--initial-setup
Låter kdesrc-build utföra en initial engångsinställning nödvändig för att förbereda systemet så att kdesrc-build kan fungera, och så att den nyinstallerade KDE-programvaran kan köra.
Det omfattar:
Installera kända beroenden (på Linux®-distributioner som stöds)
Lägga till nödvändiga miljövariabler i
~/.bashrc
Ställa in en inställningsfil
Tillgängligt sedan version 18.11.
--author
Visa upphovsmannens kontaktinformation.
--color
Aktivera färglagd utmatning. (Det är förval för interaktiva terminaler.)
--nice=
värde
Värdet justerar datorns processorprioritet som begärs av kdesrc-build, och ska vara i intervallet 0-20. 0 är högst prioritet (eftersom det är minst ”snällt”), 20 är lägst prioritet. kdesrc-build har förvalt värde 10.
--no-async
Inaktiverar asynkront användningssätt för uppdateringar. Istället utförs hela uppdateringen innan byggningen startas. Väljaren slöar ner totalprocessen, men om du råkar ut för IPC-fel medan du kör kdesrc-build, prova den här väljaren, och skicka in en felrapport.
--no-color
Inaktivera färglagd utmatning.
--pretend
(eller-p
)kdesrc-build kör igenom uppdaterings- och byggprocessen, men istället för att utföra några åtgärder för att uppdatera eller bygga, skriver ut vad skriptet skulle ha gjort (t.ex. vilka kommandon att köra, steg att utföra, etc.).
Notera
Enkla läskommandon (som att läsa information) kan fortfarande utföras, för att göra utmatningen mer relevant (som att simulera om källkod skulle checkas ut eller uppdateras på ett riktigt sätt).
Viktigt
Alternativet kräver att viss nödvändig metadata är tillgänglig, vilken normalt laddas ner automatiskt, men nerladdningar är inaktiverade i låtsasläge. Om du aldrig har kört kdesrc-build (och därför inte har denna metadata), måste du först köra kommandot kdesrc-build
--metadata-only
för att ladda ner nödvändig metadata.--quiet
(eller-q
)Var inte så högljudd med utmatningen. Med den här väljaren matas bara det viktigaste ut.
--really-quiet
Mata bara ut varningar och fel.
--verbose
Beskriv i detalj vad som händer, och vad kdesrc-build gör.
--src-only
(eller-s
)Utför bara uppdatering av källkoden.
--build-only
Utför bara byggprocessen.
--install-only
Utför bara installationsprocessen.
--metadata-only
Utför bara processen för nerladdning av metadata. kdesrc-build hanterar det normalt automatiskt, men det går att använda detta för att få kommandoradsväljaren
--pretend
att fungera.--rebuild-failures
Använd väljaren för att bara bygga moduler som misslyckades byggas vid en tidigare körning av kdesrc-build. Det är användbart om ett väsentligt antal misslyckanden inträffade, blandat med lyckade byggen. Efter att ha rättat problemet som orsakade misslyckade byggen är det enkelt att bara bygga modulerna som tidigare misslyckades.
Notera
Observera att listan med ”tidigare misslyckade moduler” nollställs varje gång en körning av kdesrc-build blir klar med några misslyckade moduler. Den nollställs dock inte av ett fullständigt lyckat bygge, så det är möjligt att bygga om några moduler med lyckat resultat och ändå använda väljaren.
Väljaren lades till i kdesrc-build 15.09.
--include-dependencies
(eller-d
),--no-include-dependencies
(eller-D
)Väljaren gör att kdesrc-build automatiskt inkluderar andra KDE- och Qt™-moduler i byggprocessen, om det krävs för modulerna som du har krävt ska byggas på kommandoraden eller i inställningsfilen.
Modulerna som läggs till lagras i KDE:s källkodshanteringssystem. Se ”KDE:s officiella moduldatabas”.
Motsvarande alternativ i inställningsfilen är include-dependencies.
Du kan också använda
--no-include-dependencies
, som stänger av att automatiskt inkludera ytterligare beroendemoduler.--ignore-modules
(eller-!
)Inkludera inte moduler som skickas på resten av kommandoraden i uppdaterings- och byggprocessen (det är användbart om du vill bygga de flesta modulerna i inställningsfilen och bara hoppa över några få).
--no-src
(eller-S
)Hoppa över att kontakta Git-servern.
--no-build
Hoppa över byggprocessen.
--no-metadata
Ladda inte automatiskt ner den extra metadata som behövs för KDE:s git-moduler. Uppdateringen av själva modulernas källkod sker ändå om du inte också använder --no-src.
Detta kan vara användbart om du ofta kör om kdesrc-build, eftersom metadata inte ändras särskilt ofta. Observera dock att många andra funktioner kräver att metadata är tillgänglig. Du bör fundera på att köra kdesrc-build med väljaren --metadata-only en gång och därefter använda den här väljaren för efterföljande körningar.
--no-install
Installera inte automatiskt paket efter de har byggts.
--no-build-when-unchanged
,--force-build
Det här alternativet inaktiverar explicit att hoppa över byggprocessen (en optimering styrd av alternativet build-when-unchanged). Det är användbart för att få kdesrc-build att utföra byggprocessen när någonting har ändrats som kdesrc-build inte kan kontrollera.
--force-build
utför exakt samma funktion, och är kanske enklare att komma ihåg.--debug
Aktiverar felsökningsläge för skriptet. För närvarande betyder det att all utmatning skickas till standardutmatningen förutom att loggas i loggkatalogen som vanligt. Dessutom är många funktioner mycket utförligare om vad de gör i felsökningsläge.
--query
=typ
Det här kommandot gör att kdesrc-build frågar efter en parameter i modulerna i bygglistan (antingen angivna på kommandoraden eller inlästa från inställningsfilen), och skriver ut resultatet på skärmen (en modul per rad).
Väljaren måste anges med en ”frågetyp”, som ska vara en av följande:
source-dir
, vilket gör att kdesrc-build skriver ut den fullständiga sökvägen där modulens källkod är lagrad.build-dir
, vilket gör att kdesrc-build skriver ut den fullständiga sökvägen där modulens byggprocess sker.install-dir
, vilket gör att kdesrc-build skriver ut den fullständiga sökvägen där modulen installeras.project-path
, vilket gör att kdesrc-build skriver ut modulens plats i hierarkin av KDE:s källkodsarkiv. Se ”KDE:s officiella moduldatabas” för mer information om denna hierarki.branch
, vilket gör att kdesrc-build skriver ut den upplösta grenen i git som används för varje modul, baserat på gällande inställningar för tag, branch och branch-group.Annars kan namn som är giltiga för moduler i inställningsfilen användas som väljare, så listas det upplösta värdet för varje modul.
Om en enda modul anges på kommandoraden är utdata helt enkelt värdet på parametern som efterfrågas. Om flera (eller inga) moduler anges på kommandoraden, inleds varje rad med modulens namn. I båda fall slutar kdesrc-build att köra när värdena är utskrivna.
Väljaren lades till i kdesrc-build 16.05.
Exempelvis kommandot ”kdesrc-build
--query
branch
kactivities
” kan sluta med följande utdata:kdepim
kactivities: master kdepim: master
--refresh-build
(eller-r
)Skapa om byggsystemet och bygg från grunden.
--reconfigure
Kör cmake (för KDE-moduler) eller configure (för Qt™) igen, utan att rensa byggkatalogen. Du ska normalt inte behöva ange detta, eftersom kdesrc-build detekterar när relevanta alternativ ändras och automatiskt kör om bygginställningen. Väljaren är implicit om
--refresh-build
används.--resume-from
(eller--from
eller-f
)Alternativet är användbart för att återuppta byggprocessen från den angivna modulen, som ska vara nästa alternativ på kommandoraden. Man ska inte ange andra modulnamn på kommandoraden.
Notera
Alternativet lade tidigare till
--no-src
, men gör inte det längre (sedan kdesrc-build 1.13). Om du vill undvika uppdateringar av källkod vid återupptagande, skicka helt enkelt också med
förutom övriga alternativ.--no-src
Se också:
--resume-after
(eller--after
eller-a
) och ”Återuppta en misslyckad eller avbruten byggprocess”. Du bör föredra att använda den här kommandoradsväljaren om du har rättat byggfelet och vill att kdesrc-build ska göra färdigt byggprocessen.--resume-after
(eller--after
eller-a
)Alternativet används för att återuppta byggprocessen efter den angivna modulen, som ska vara nästa alternativ på kommandoraden. Man ska inte ange andra modulnamn på kommandoraden.
Notera
Alternativet lade tidigare till
--no-src
, men gör inte det längre (sedan kdesrc-build 1.13). Om du vill undvika uppdateringar av källkod vid återupptagande, skicka helt enkelt också med
förutom övriga alternativ.--no-src
Se också:
--resume-from
(eller--from
eller-f
) och ”Återuppta en misslyckad eller avbruten byggprocess”. Du bör föredra att använda den här kommandoradsväljaren om du har rättat byggfelet och har också byggt och installerat modulen själv, och vill att kdesrc-build ska starta igen med nästa modul.--resume
Väljaren används för att köra kdesrc-build efter ett byggfel har uppstått.
Den återupptar bygget från modulen som misslyckades, med användning av listan över moduler som tidigare väntade på att byggas, och inaktiverar dessutom källkods- och metadatauppdateringar. När felet väl har rättats kan du snabbt komma tillbaka till att bygga modulerna som du tidigare byggde utan att mixtra med
--resume-from
och--stop-before
.Väljaren lades till i kdesrc-build 1.16.
--stop-before
(eller--until
)Kommandoradsväljaren används för att stoppa den normala byggprocessen precis innan en modul normalt skulle ha byggts.
Om den normala bygglistan exempelvis var modul-A, modul-B, modul-C, skulle
--stop-before=
göra att kdesrc-build bara byggermodul-B
modul-A
.Kommandoradsväljaren lades till i kdesrc-build 1.16.
--stop-after
(eller--to
)Kommandoradsväljaren används för att stoppa den normala byggprocessen precis efter en modul normalt skulle ha byggts.
Om den normala bygglistan exempelvis var modul-A, modul-B, modul-C, skulle
--stop-after=
göra att kdesrc-build byggermodul-B
modul-A
ochmodul-B
.Kommandoradsväljaren lades till i kdesrc-build 1.16.
--stop-on-failure
,--no-stop-on-failure
Väljaren gör att bygget avbryts så fort ett fel uppstår. Det normala beteendet är --stop-on-failure. Det går att överskrida om du vill fortsätta med återstående moduler i bygget, för att undvika att slösa tid ifall problemet gäller en enskild modul.
Alternativet lades till i kdesrc-build 1.16. Se också inställningsfilens alternativ stop-on-failure.
--rc-file
Det tolkar nästa kommandoradsväljare som filen att läsa konfigurationsinställningarna från. Förvalt värde för väljaren är
kdesrc-buildrc
(kontrolleras i arbetskatalogen). Om filen inte finns, används~/.config/kdesrc-buildrc
($XDG_CONFIG_HOME/kdesrc-buildrc
, om$XDG_CONFIG_HOME
är angivet) istället. Se också Kapitel 4, Anpassa kdesrc-build.--print-modules
Utför alla åtgärder till och med beroendeomordning av modulerna angivna på kommandoraden (eller i inställningsfilen), skriver ut modulerna som skulle behandlats en per rad, och avslutar därefter utan ytterligare åtgärder.
Metadata för
kde-project
laddas först ner (se dock--pretend
eller--no-src
).Utmatningen är inte fullständigt kompatibel med skriptanvändning, eftersom andra utmatningsmeddelanden kan genereras innan listan över moduler visas.
Detta är i huvudsak användbart för att snabbt avgöra vad kdesrc-build anser vara beroenden för en modul, vilket betyder att det bara är användbart för moduler i
kde-projects
. Väljaren är också kompatibel med--resume-from
,--resume-after
,--stop-before
och--stop-after
.--list-build
Listar modulerna som skulle byggas, i den ordning de skulle byggas. Om tillämpligt, nämner listan också vilken incheckning, gren eller etikett som skulle väljas för utcheckning.
Väljaren liknar
--print-modules
. För mer information om hur moduler är relaterade till varandra, se också:--dependency-tree
.--dependency-tree
Skriver ut beroendeinformation för modulerna som skulle byggas genom att använda ett (rekursivt) trädformat. Den listade informationen omfattar också vilken specifik incheckning, gren eller etikett som de beror på, och om de beroende modulerna skulle byggas eller inte. Observera: Genererad utdata kan bli ganska omfattande för program med många beroenden.
--run
Alternativet tolkar nästa parameter på kommandoraden som ett program att köra, och kdesrc-build slutar då att läsa inställningsfilen, uppdaterar miljön som vanligt, och kör därefter angivet program.
Det fungerar dock inte för att starta ett skal med miljön från kdesrc-build i de flesta fall, eftersom interaktiva skal typiskt återställer åtminstone vissa av miljövariablerna (som
PATH
ochKDEDIRS
) under startsekvensen.Tips
Om du vill se miljön som används av kdesrc-build kan du köra kommandot printenv:
$ 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=</sökväg/till/kde>
Det här låter dig ändra katalogen som KDE installeras i från kommandoraden. Alternativet inbegriper
--reconfigure
, men det kan ändå krävas att--refresh-build
används.--revision
Väljaren gör att kdesrc-build checkar ut en särskilt numrerad version av varje Git-modul, och överskrider eventuella alternativ som branch, tag eller revision redan är angivna för modulerna.
Väljaren är troligen inte en god idé, och stöds bara för kompatibilitet med äldre skript.
--build-system-only
Väljaren gör att kdesrc-build avbryter bygga en modul precis innan kommandot make skulle ha körts. Det stöds bara för kompatibilitet med äldre versioner, effekten är inte till hjälp för det nuvarande byggsystemet för KDE.
--install
Om detta är den enda kommandoradsväljaren, försöker det installera alla moduler som finns i
log/latest/build-status
. Om kommandoradsväljare anges efter--install
, antas de alla vara moduler att installera (även om de inte byggdes med lyckat resultat vid den senaste körningen).--no-snapshots
Att ange den här väljaren gör att kdesrc-build alltid utför en normal ursprunglig utcheckning av en modul istället för att använda en sparad version för snabbstart (bara tillgängligt för Git-moduler från arkivet
kde-projects
). Observera att alternativet bör bara användas om ett fel uppstår vid användning av en sparad version, eftersom sparade versioner för snabbstart reducerar belastningen på KDE:s källkodsarkiv.Notera
Sparade versioner av modulen är riktiga utcheckningar. Du ska inte behöva ange den här väljaren, den är bara till hjälp vid felsökning.
--delete-my-patches
Väljaren används för att låta kdesrc-build ta bort källkataloger som kan innehålla användardata, så att modulerna kan laddas ner igen. Den är normalt bara användbar för KDE-utvecklare (som kan ha lokala ändringar som skulle tas bort).
Normalt ska inte väljaren användas, utan kdesrc-build ber att få köras om med den vid behov.
--delete-my-settings
Väljaren används för att låta kdesrc-build skriva över befintliga filer som kan innehålla användardata.
För närvarande används den bara för inställning av en xsession för inloggningshanteraren. Normalt ska inte väljaren användas, utan kdesrc-build ber att få köras om med den vid behov.
--
<alternativnamn>
=Du kan använda alternativet för att överskrida ett alternativ i inställningsfilen för alla moduler. För att till exempel överskrida alternativet log-dir, skulle du skriva
.--log-dir=
/sökväg/till/katalog
Notera
Funktionen kan bara användas för alternativnamn som redan känns igen av kdesrc-build som ännu inte stöds av relevanta kommandoradsväljare. Exempelvis har inställningsfilens alternativ async de specifika kommandoradsväljarna --async och --no-async som föredras av kdesrc-build.
--set-module-option-value=
<modulnamn>
,<alternativnamn>
,<alternativvärde>
Du kan använda alternativet för att överskrida ett alternativ i inställningsfilen för en specifik modul.
Alla övriga kommandoradsväljare antas vara moduler att uppdatera och bygga. Blanda helst inte ihop bygga och installera.