Paràmetres admesos de la línia d'ordres

Genèric

--pretend (or --dry-run o -p)

El kdesrc-build s'executarà a través del procés d'actualització i construcció, però en lloc de realitzar cap acció per a actualitzar o compilar, generarà el que l'script hauria fet (p. ex., quines ordres executar, passos generals que s'estan prenent, etc.).

Nota

Les ordres senzilles de només lectura (com llegir la informació del fitxer) encara poden executar-se per a fer que la sortida sigui més rellevant (com simular correctament si el codi font s'extraurà o actualitzarà).

Important

Aquesta opció requereix que estiguin disponibles algunes metadades necessàries, que normalment es descarreguen automàticament, però les descàrregues estan inhabilitades en el mode simulat. Si mai heu executat el kdesrc-build (i per tant, no teniu aquestes metadades), haureu d'executar kdesrc-build --metadata-only per a descarregar primer les metadades necessàries.

--include-dependencies (o -d), --no-include-dependencies (o -D)

Aquesta opció fa que el kdesrc-build inclogui automàticament altres mòduls del KDE i les Qt™ a la construcció, si és necessari per als mòduls que heu sol·licitat construir a la línia d'ordres o al fitxer de configuració.

Els mòduls que s'afegeixen són registrats dins del sistema de gestió del codi font del KDE. Vegeu la «La base de dades oficial de mòduls del KDE».

L'opció del fitxer de configuració corresponent és include-dependencies.

Aquesta opció està activa de manera predeterminada.

--ignore-modules (o -!) module [mòdul ...]

No inclourà els mòduls passats a la resta de la línia d'ordres en el procés d'actualització/construcció (això és útil si voleu construir la majoria dels mòduls en el fitxer de configuració i ometre'n alguns).

Tingueu en compte que aquesta opció no substitueix l'opció ignore-modules de l'opció «config» a la secció global. En lloc d'això, l'afegeix.

--run (o --start-program) [-e|--exec name] [-f|--fork] program [paràmetres ...]

Aquesta opció interpreta l'element següent a la línia d'ordres com un programa per a executar, i el kdesrc-build acabarà de llegir el fitxer de configuració, inclourà el «prefix.sh» per a aplicar les variables d'entorn, i després executarà el programa indicat.

--revision id

Aquesta opció farà que el kdesrc-build extregui una revisió numerada específica per a cada mòdul de Git, superposant qualsevol opció branch, tag o revision ja establertes per a aquests mòduls.

És probable que aquesta opció no sigui una bona idea, i només està admesa per compatibilitat amb scripts antics.

--delete-my-patches, --no-delete-my-patches

Aquesta opció s'utilitza per a permetre que el kdesrc-build suprimeixi els directoris de codi font que poden contenir dades de l'usuari, de manera que el mòdul es pugui tornar a descarregar. Això normalment només seria útil per als desenvolupadors del KDE (podrien tenir canvis locals que seran suprimits).

No heu d'utilitzar aquesta opció normalment, si cal, el kdesrc-build sol·licitarà que es torni a executar amb ella.

--delete-my-settings, --no-delete-my-settings

Aquesta opció s'utilitza per a permetre que el kdesrc-build sobreescrigui els fitxers existents que poden contenir dades de l'usuari.

Actualment, això només s'utilitza per a la configuració d'xsession per al gestor d'inici de la sessió. No heu d'utilitzar aquesta opció normalment, si cal, el kdesrc-build sol·licitarà que es torni a executar amb ella.

--<option-name> valor

Podeu utilitzar aquesta opció per a superposar una opció en el fitxer de configuració per a cada mòdul. Per exemple, per a superposar l'opció log-dir, faríeu el següent: --log-dir /camí/al/dir.

Nota

Aquesta característica només es pot utilitzar per als noms d'opció ja reconeguts pel kdesrc-build, que no són admesos per les opcions rellevants de la línia d'ordres. Per exemple, l'opció async del fitxer de configuració té les opcions específiques --async i --no-async de la línia d'ordres que són preferides pel kdesrc-build.

--set-module-option-value <nom_mòdul>,<nom_opció>,<valor_opció>

Podeu utilitzar aquesta opció per a superposar una opció en el fitxer de configuració per a un mòdul específic.

Reprendre i aturar

--resume-from (o --from o -f) mòdul

Aquesta opció s'utilitza per a reprendre la construcció a partir del mòdul indicat. No haureu d'especificar altres noms de mòduls a la línia d'ordres.

Nota

Si voleu evitar les actualitzacions del codi font en reprendre, simplement passeu --no-src a més de les altres opcions.

Vegeu també: --resume-after i «Reprendre una construcció fallida o interrompuda». Preferiríeu utilitzar aquesta opció de la línia d'ordres si heu solucionat l'error de construcció i voleu que el kdesrc-build completi la construcció.

--resume-after (o --after o -a) mòdul

Aquesta opció s'utilitza per a reprendre la construcció després del mòdul indicat. No haureu d'especificar altres noms de mòduls a la línia d'ordres.

Nota

Si voleu evitar les actualitzacions del codi font en reprendre, simplement passeu --no-src a més de les altres opcions.

Vegeu també: --resume-from i «Reprendre una construcció fallida o interrompuda». Preferiríeu utilitzar aquesta opció de la línia d'ordres si heu solucionat l'error de construcció, i també heu construït i instal·lat el mòdul, i voleu que el kdesrc-build comenci de nou amb el següent mòdul.

--resume

Aquesta opció es pot utilitzar per a executar kdesrc-build després que s'hagi produït un error de construcció.

Reprèn la construcció des del mòdul que va fallar, utilitzant la llista de mòduls que esperen a ser compilats, i també inhabilita les actualitzacions del codi font i les metadades. El cas d'ús és quan un error senzill o manca d'una dependència causa la falla de la construcció. Una vegada corregiu l'error, podreu tornar ràpidament a construir els mòduls que es construïen abans, sense tocar --resume-from i --stop-before.

--stop-before (o --until) mòdul

Aquesta opció s'utilitza per a aturar el procés de construcció normal just abans que es construeixi normalment un mòdul.

Per exemple, si la llista de construcció normal era mòdul_A, mòdul_B, mòdul_C, llavors --stop-before mòdul_B farà que el kdesrc-build només construeixi el mòdul_A.

--stop-after (o --to) mòdul

Aquesta opció s'utilitza per a aturar el procés de construcció normal just després que es construeixi normalment un mòdul.

Per exemple, si la llista de construcció normal era mòdul_A, mòdul_B, mòdul_C, llavors --stop-after mòdul_B farà que el kdesrc-build construeixi el mòdul_A i el mòdul_B.

--stop-on-failure, --no-stop-on-failure

Aquesta opció controla si la construcció s'interromprà tan aviat com passi una fallada. El comportament predeterminat és --stop-on-failure. Si voleu, podeu substituir per a continuar amb la resta dels mòduls en la construcció, per a evitar perdre temps en cas que el problema sigui amb un sol mòdul.

Vegeu també l'opció del fitxer de configuració stop-on-failure.

--rebuild-failures

Aquesta opció permet construir només aquells mòduls que no s'han pogut construir en una execució anterior de kdesrc-build. Això és útil si s'ha produït un nombre significatiu de fallades mesclades amb construccions amb èxit. Després de solucionar el problema que causa les fallades de construcció, podreu construir amb facilitat només els mòduls que van fallar anteriorment.

Nota

Tingueu en compte que la llista dels «mòduls amb fallades anteriors» es restableix cada vegada que finalitza una execució de kdesrc-build amb algunes fallades de mòduls. No obstant això, no es restableix amb una construcció completa amb èxit, així que podreu reconstruir amb èxit un o dos mòduls i aquest indicador seguirà funcionant.

Informació dels mòduls

--query mode

Aquesta ordre fa que el kdesrc-build consulti un paràmetre dels mòduls a la llista de construcció (ja sigui passat sobre la línia d'ordres o llegit des del fitxer de configuració), enviant el resultat a la pantalla (un mòdul per línia).

Aquesta opció s'haurà de proporcionar amb un «mode», el qual haurà de ser un dels següents:

  • source-dir, el qual fa que el kdesrc-build generi el camí sencer a on s'emmagatzema el codi font del mòdul.

  • build-dir, el qual fa que el kdesrc-build generi el camí sencer a on ocorre el procés de construcció del mòdul.

  • install-dir, el qual fa que el kdesrc-build generi el camí sencer a on s'instal·larà el mòdul.

  • project-path, el qual fa que el kdesrc-build doni com a sortida la ubicació del mòdul dins de la jerarquia de repositoris de codi font del KDE. Vegeu la «La base de dades oficial de mòduls del KDE» per a més informació sobre aquesta jerarquia.

  • branch, el qual fa que el kdesrc-build doni com a sortida la branca de git que s'utilitzarà per a cada mòdul, en funció de les opcions vigents tag, branch i branch-group.

  • module-set, el qual fa que el kdesrc-build doni com a sortida el «module-set» que conté el mòdul. Això es pot utilitzar per a generar la memòria cau d'autocompleció del «zsh».

  • build-system, el qual fa que el kdesrc-build doni com a sortida el nom del sistema de construcció del mòdul. Això es pot utilitzar per a depurar els problemes de detecció automàtica del sistema de construcció, o per a desenvolupar proves per a sistemes de construcció específics.

  • Qualsevol nom d'opció que sigui vàlida per a mòduls al fitxer de configuració.

Per exemple, l'ordre kdesrc-build --query branch kactivities kdepim podria acabar amb una sortida com:

kactivities: master
kdepim: master
--dependency-tree

Imprimeix informació sobre les dependències en els mòduls que es construiran utilitzant un format en arbre (recursiu). La informació llistada també inclou de quin commit/branch/tag específic es depèn i si es construirà la dependència. Nota: la sortida generada pot ser molt gran per a aplicacions amb moltes dependències.

--dependency-tree-fullpath

Imprimeix informació sobre les dependències en els mòduls que es construiran utilitzant un format en arbre (recursiu). En format de camí complet. Nota: la sortida generada pot ser molt gran per a aplicacions amb moltes dependències.

--list-installed

Imprimeix els mòduls instal·lats i surt. Això es pot utilitzar per a generar la compleció automàtica per a l'opció --run.

Exclusió d'acció específica

--no-metadata (o -M)

No descarrega automàticament les metadades addicionals necessàries per als mòduls git del KDE. Les actualitzacions del codi font per als mòduls en si seguiran succeint a menys que també passeu l'opció --no-src.

Això pot ser útil si esteu tornant a executar sovint el kdesrc-build, ja que les metadades no canvien amb molta freqüència. Fixeu-vos, que moltes altres característiques requereixen que les metadades estiguin disponibles. És possible que vulgueu considerar executar el kdesrc-build una vegada amb l'opció --metadata-only i aleshores utilitzar aquesta opció per a les execucions posteriors.

--no-src (o -S)

Omet contactar amb el servidor Git.

--no-build

Omet el procés de construcció.

--no-install

No instal·la automàticament els paquets després de construir-los.

Només una acció específica

--metadata-only

Només realitza el procés de descàrrega de les metadades. El kdesrc-build normalment gestiona això automàticament, però pot fer-ho manualment per a permetre que funcioni l'opció --pretend de la línia d'ordres.

--src-only (o -s)

Només realitza l'actualització del codi font.

--build-only

Només realitza el procés de construcció.

--install-only

Si aquesta és l'única opció de la línia d'ordres, intentarà instal·lar tots els mòduls continguts a log/latest/build-status. Si les opcions de la línia d'ordres s'especifiquen després d'aquesta opció, s'assumirà que són mòduls per a instal·lar (encara que no s'hagin construït correctament en la darrera execució).

--build-system-only

Aquesta opció fa que el kdesrc-build interrompi la construcció d'un mòdul just abans que s'hagi executat l'ordre make. Això només està admès per a la compatibilitat amb versions antigues, aquest efecte no és útil per al sistema de compilació actual del KDE.

Comportament de la construcció

--build-when-unchanged (o --force-build), --no-build-when-unchanged (o --no-force-build)

Activant aquesta opció explícitament desactiva l'omissió del procés de construcció (una optimització controlada per l'opció build-when-unchanged). Això és útil per a fer que el kdesrc-build executi la construcció quan heu canviat quelcom que el kdesrc-build no pot comprovar. Aquesta opció està activa de manera predeterminada.

--refresh-build (o -r)

Torna a crear el sistema de construcció i el crea des de zero.

--reconfigure

Executa de nou el cmake (per als mòduls del KDE) o el configure (per a les Qt™), sense netejar el directori de construcció. Normalment no hauríeu d'especificar això, ja que el kdesrc-build detectarà quan es canviïn les opcions rellevants i tornarà a executar automàticament la configuració de la construcció. Aquesta opció està implícita si s'utilitza l'opció --refresh-build.

--install-dir camí

Això permet canviar el directori en el qual s'instal·laran els mòduls. Aquesta opció implica --reconfigure, però encara podria ser necessari utilitzar --refresh-build.

--generate-vscode-project-config, --no-generate-vscode-project-config

Genera un directori .vscode amb configuracions per a construir i depurar en el Visual Studio Code. Aquesta opció està activa de manera predeterminada.

Execució de l'script

--async, --no-async

Activa o desactiva el mode asíncron, el qual pot realitzar actualitzacions de codi font i construccions de mòduls a la vegada. Si està desactivada, l'actualització es realitzarà completament abans que comenci la construcció. Desactivar aquesta opció alentirà el procés general, però si trobeu errors d'IPC mentre s'executa el kdesrc-build, proveu-ho desactivant-la i envieu un informe d'error. Aquesta opció està activa de manera predeterminada.

--color (o --colorful-output), --no-color (o --no-colorful-output)

Activa o desactiva la sortida amb color. De manera predeterminada, aquesta opció està activada per als terminals interactius.

--nice (o --niceness) valor

Aquest valor ajusta la prioritat de la CPU de l'ordinador sol·licitada pel kdesrc-build, i haurà d'estar en l'interval de 0 a 20. 0 és la prioritat més alta (perquè és la menys «nice»), 20 és la prioritat més baixa. L'opció predeterminada és 10.

--rc-file fitxer

El fitxer des del qual llegir les opcions de configuració. El valor predeterminat per a aquest paràmetre és kdesrc-buildrc (marcat en el directori de treball actual). Si aquest fitxer no existeix, en el seu lloc s'emprarà ~/.config/kdesrc-buildrc ($XDG_CONFIG_HOME/kdesrc-buildrc, si està establerta $XDG_CONFIG_HOME). Vegeu també Capítol 4, Configurar el kdesrc-build.

Configuració

--initial-setup

Fa que el kdesrc-build realitzi una única configuració inicial necessària per a preparar el sistema, de manera que funcioni el kdesrc-build i perquè s'executi el programari KDE instal·lat.

Això inclou:

  • Instal·lar les dependències conegudes (en les distribucions admeses de Linux®)

  • Afegir les variables d'entorn necessàries al ~/.bashrc

Aquesta opció és exactament equivalent a utilitzar --install-distro-packages --generate-config a la vegada. En el kdesrc-build (implementació del Perl) a més fa servir «--install-distro-packages-perl».

--install-distro-packages

Instal·la els paquets necessaris de la distribució (en les distribucions Linux® implementades) per a preparar el sistema de manera que funcioni el kdesrc-build, i perquè s'executi el programari KDE nou instal·lat.

Vegeu també --initial-setup

--generate-config

Genera el fitxer de configuració del kdesrc-build.

Vegeu també --initial-setup

Nivell de detall

--debug

Habilita el mode de depuració per a l'script. Actualment, això vol dir que tota la sortida es bolcarà a la sortida estàndard a més de registrar-se al directori de registre com de costum. A més, moltes funcions són molt més detallades sobre el que estan fent que en el mode de depuració.

--quiet (o --quite o -q)

No serà tan sorollós amb la sortida. Amb aquest interruptor només sortiran els elements bàsics.

--really-quiet

Només surten els avisos i errors.

--verbose

Serà molt descriptiu sobre el que està succeint i el que està fent el kdesrc-build.

Informació de l'script

--version (o -v)

Mostra la versió del programa.

--help (o -h)

Només mostra una ajuda senzilla sobre aquest script.

--show-info

Mostra informació sobre el kdesrc-build i el sistema operatiu, el qual pot ser útil en els informes d'error o en demanar ajuda en els fòrums o les llistes de correu.

--show-options-specifiers

Imprimeix les línies especificadores (en el format que accepta GetOpts::Long) per a totes les opcions de la línia d'ordres admeses per l'script. Això pot ser utilitzat pels desenvolupadors, per exemple, per a generar funcions d'autocompleció zsh.