Taula de les opcions de configuració disponibles

Aquí hi ha taules de les diverses opcions, que contenen la informació següent:

  • El nom de l'opció

  • L'àmbit de l'opció: global, module o module-set. Les opcions en els àmbits module o module-set també es poden definir en les seccions de les opcions.

  • Comentaris especials sobre la finalitat i ús de l'opció.

Taula 4.1. Opcions només d'àmbit global

Nom de l'opcióDescripció
async
TipusBooleà
Valor per defecteCert
Disponible des de1.6

Aquesta opció activa el mode d'operació asíncron, on l'actualització del codi font i el procés de construcció es realitzaran en paral·lel, en lloc d'esperar totes les actualitzacions del codi font abans de començar el procés de construcció.

Opcions relacionades de la línia d'ordres: --async, --no-async

colorful-output
TipusBooleà
Valor per defecteCert

Establiu aquesta opció a false (fals) per a inhabilitar la sortida amb color de kdesrc-build. Recordeu que el kdesrc-build no generarà els codis de color enlloc més que no sigui un terminal (com xterm, Konsole o la consola normal de Linux®).

Opcions relacionades de la línia d'ordres: --color (o --colorful-output), --no-color (o --no-colorful-output)

disable-agent-check
TipusBooleà
Valor per defecteFals

Si esteu utilitzant SSH per a descarregar el codi font del Git (com quan s'utilitza el protocol git+ssh), aquesta opció controla si el kdesrc-build intentarà i s'assegurarà que si utilitzeu el ssh-agent, en realitat s'estaran gestionant algunes identitats SSH. Això és per a evitar que SSH sol·liciti una contrasenya per a cada mòdul.

Opcions relacionades de la línia d'ordres: --disable-agent-check, --no-disable-agent-check

git-desired-protocol
TipusCadena
Valor per defectegit
Informació de l'historialAquesta opció es va afegir en el kdesrc-build 1.16. Abans de la 20.06, aquesta opció s'utilitzava per a configurar l'URL de cerca en lloc de l'URL d'obtenció. A partir de la 20.06, s'utilitzarà sempre https en actualitzar els projectes del KDE.

Aquesta opció només s'aplicarà als mòduls des d'un repositori de projecte del KDE.

El que realment fa aquesta opció és configurar quin protocol de xarxa preferiu per a obtenir el codi font per a aquests mòduls. Normalment s'utilitza el protocol git, el qual és molt eficient, però pot estar bloquejat en algunes xarxes (p. ex., intranets corporatives, Wi-Fi públic). Un protocol alternatiu que és molt millor admès és el protocol https utilitzat per als llocs web d'Internet.

Si utilitzeu una d'aquestes xarxes restringides, podreu establir aquesta opció a http per a preferir-lo en comptes de les comunicacions https.

Suggeriment

També podríeu necessitar l'opció http-proxy si també es necessita un intermediari HTTP per al trànsit de xarxa.

En qualsevol altra situació, no haureu d'establir aquesta opció, ja que el protocol predeterminat és més eficient.

git-repository-base
TipusCadena
Disponible des de1.12.1

Aquesta opció s'utilitza per a crear un nom curt per a fer referència a un URL base del repositori Git específic, en les declaracions de conjunts de mòduls posteriors, la qual cosa és útil per a declarar amb rapidesa la creació de molts mòduls de Git.

Haureu d'especificar dues coses (separades per un espai): el nom que s'assignarà a l'URL base i l'URL base real en si. Per exemple:

global
    # Altres opcions
    # Aquest és el camí habitual per a tots els mòduls de servidor Git anònim.
    git-repository-base kde-git kde:
end global

# Declaracions del mòdul

module-set
    # Ara podreu fer servir àlies que heu definit amb anterioritat, però només sobre un conjunt de mòduls.    repository kde-git
    use-modules module1.git module2.git
end module-set

L'opció use-modules del conjunt de mòduls ha creat dos mòduls internament, amb el kdesrc-build comportant-se com si hagués llegit:

module module1
    repository kde:module1.git
end module

module module2
    repository kde:module2.git
end module

El prefix de repositori Git és kde:, utilitzat abans és una drecera que el kdesrc-build configurarà automàticament. Consulteu l'article URL Renaming de TechBase per a obtenir més informació. Recordeu que, a diferència de la majoria de les altres opcions, aquesta opció es pot especificar múltiples vegades per a crear tants àlies com sigui necessari.

Suggeriment

No es requereix utilitzar aquesta opció per a aprofitar el conjunt de mòduls, aquesta opció existeix per a facilitar l'ús del mateix repositori en molts conjunts de mòduls diferents.

install-environment-driver
TipusBooleà
Valor per defecteCert
Disponible des de17.08

Instal·la un script d'intèrpret d'ordres que pot obtenir-se en els scripts de configuració del perfil d'un usuari per a establir amb facilitat les variables d'entorn necessàries per a executar l'escriptori Plasma creat pel kdesrc-build.

Aquest controlador modificarà els següents fitxers:

  • $XDG_CONFIG_HOME/kde-env-master.sh (normalment es troba a ~/.config/kde-env-master.sh).

  • $XDG_CONFIG_HOME/kde-env-user.sh (normalment es troba a ~/.config/kde-env-user.sh).

El kde-env-user.sh és opcional. Està destinat a les personalitzacions de l'usuari (vegeu la secció Troubleshooting and Debugging (Solució de problemes i depuració) de la KDE UserBase per a veure exemples d'opcions personalitzades), però l'usuari podrà establir aquestes opcions en altres llocs en els seus scripts existents per a la configuració del perfil.

És possible inhabilitar aquesta característica establint aquesta opció a false (fals) i assegurant-vos que l'opció install-session-driver també està inhabilitada.

Suggeriment

El kdesrc-build no sobreescriurà els vostres fitxers existents (si n'hi ha) a menys que també passeu l'opció --delete-my-settings de la línia d'ordres.

Opcions relacionades de la línia d'ordres: --install-environment-driver, --no-install-environment-driver

install-session-driver
TipusBooleà
Valor per defecteCert
Disponible des de1.16

Si està habilitada, el kdesrc-build intentarà instal·lar un controlador per al gestor d'inici de sessió gràfic, el qual us permetrà iniciar la sessió a l'escriptori KDE construït amb el kdesrc-build.

Aquest controlador modificarà els següents fitxers:

  • ~/.xsession

  • $XDG_CONFIG_HOME/kde-env-master.sh (normalment es troba a ~/.config/kde-env-master.sh).

  • $XDG_CONFIG_HOME/kde-env-user.sh (normalment es troba a ~/.config/kde-env-user.sh).

Si manteniu el vostre propi controlador d'inici de sessió, podreu inhabilitar aquesta característica establint aquesta opció a false (fals). Si està habilitada, aquesta característica també habilitarà la característica install-environment-driver.

Suggeriment

El kdesrc-build no sobreescriurà els vostres fitxers existents (si n'hi ha) a menys que també passeu l'opció --delete-my-settings de la línia d'ordres.

Opcions relacionades de la línia d'ordres: --install-session-driver, --no-install-session-driver

niceness
TipusEnter
Valor per defecte10

Establiu aquesta opció a un número entre el 20 i el 0. Com més gran sigui el número, menor serà la prioritat que establirà el kdesrc-build per si mateix, és a dir, com més gran sigui el número, més «nice» serà el programa.

Opcions relacionades de la línia d'ordres: --nice (o --niceness) valor

num-cores
TipusEnter
Valor per defecteDepèn del sistema
Disponible des de20.07

Aquesta opció està definida pel kdesrc-build (quan s'utilitza kdesrc-build --generate-config), establerta al nombre de CPU disponibles (com ho indica l'aplicació externa nproc). Si el kdesrc-build no pot detectar el nombre de CPU, aquest valor s'establirà a 4.

Vegeu Exemple 2.1, «Configurar el Make per a emprar totes les CPU disponibles, amb excepcions» per a un exemple de l'ús d'aquesta opció.

Opcions relacionades de la línia d'ordres: --num-cores valor

num-cores-low-mem
TipusEnter
Valor per defecteDepèn del sistema
Disponible des de20.07

Aquesta opció està definida pel kdesrc-build (quan s'utilitza kdesrc-build --generate-config), establerta al nombre de CPU que es considera segur per mòduls pesats o altres mòduls altament intensius, com el qtwebengine, per a evitar quedar-se sense memòria durant la compilació.

El càlcul típic és un nucli de CPU per cada 2 gigabytes (GiB) de memòria total. Almenys s'especificarà 1 nucli, i no s'especificaran més que a num-cores.

Tot i que aquesta opció està pensada per a admetre els mòduls de les Qt™, podeu utilitzar-la per a qualsevol mòdul de la mateixa manera que s'utilitza num-cores.

Si el kdesrc-build no pot detectar la memòria disponible, aquest valor s'establirà a 2.

Opcions relacionades de la línia d'ordres: --num-cores-low-mem valor

persistent-data-file
TipusCadena
Disponible des de1.15

Aquesta opció permet canviar on emmagatzema el kdesrc-build les seves dades persistents. De manera predeterminada s'emmagatzemen en un fitxer anomenat .kdesrc-build-data, ubicat al mateix directori que el fitxer de configuració en ús. Si s'utilitza el fitxer de configuració global, es desarà a ~/.local/state/kdesrc-build-data ($XDG_STATE_HOME/kdesrc-build-data, si està establerta $XDG_STATE_HOME). Si teniu múltiples configuracions disponibles al mateix directori, és possible que vulgueu establir aquesta opció manualment perquè les diferents configuracions no acabin amb dades persistents en conflicte.

Opcions relacionades de la línia d'ordres: --persistent-data-file fitxer

ssh-identity-file
TipusCadena
Disponible des de1.14.2

Establiu aquesta opció per a controlar quin fitxer de clau SSH privat es passarà a l'ordre ssh-add quan el kdesrc-build està descarregant el codi font des dels repositoris que requereixen autenticació. Vegeu també: les «Comprovacions de l'agent SSH».

use-idle-io-priority
TipusBooleà
Valor per defecteFals
Disponible des de1.12

Utilitza una prioritat més baixa per al disc i altres usos de l'E/S, el qual pot millorar significativament la capacitat de resposta de la resta del sistema amb un cost en el temps d'execució una mica més llarg per al kdesrc-build.

Opcions relacionades de la línia d'ordres: --use-idle-io-priority, --no-use-idle-io-priority

use-inactive-modules
TipusBooleà
Valor per defecteFals

Permet que el kdesrc-build també faci «clone» i «pull» des dels repositoris marcats com inactius.

Opcions relacionades de la línia d'ordres: --use-inactive-modules, --no-use-inactive-modules


Taula 4.2. Opcions de tots els àmbits (mòdul, conjunt de mòduls i global)

Nom de l'opcióDescripció
binpath
TipusCadena

Establiu aquesta opció per a establir la variable d'entorn PATH mentre es construeix. No podreu superposar aquesta opció en una opció de mòdul. De manera predeterminada és la $PATH que s'estableix quan s'inicia l'script. Aquesta variable d'entorn haurà d'incloure els camins separats per dos punts de la vostra cadena d'eines de desenvolupament. Els camins ${install-dir}/bin i ${qt-install-dir}/bin s'afegiran de manera automàtica. Feu servir la titlla (~) per a qualsevol camí que afegiu utilitzant aquesta opció.

Opcions relacionades de la línia d'ordres: --binpath camí

branch
TipusCadena
Valor per defectemaster

Extreu la branca especificada en lloc de la branca per defecte.

Nota

Per a la majoria dels mòduls del KDE, és probable que vulgueu utilitzar l'opció branch-group en el seu lloc i utilitzar aquesta opció per a excepcions cas per cas.

Opcions relacionades de la línia d'ordres: --branch valor

branch-group
TipusCadena
Disponible des de1.16-pre2

Establiu aquesta opció a un grup general del qual voleu triar els mòduls.

Per als tipus de mòduls de Git, el kdesrc-build determinarà la branca real que s'utilitzarà automàticament segons les regles codificades pels desenvolupadors del KDE (aquestes regles es poden veure a kde-build-metadata del repositori del codi font al vostre directori de codi font). Després de determinar una branca, aquesta s'utilitzarà com si l'haguéssiu especificat utilitzant l'opció branch.

Això és útil si només intenteu mantenir actualitzada alguna pista de desenvolupament normal sense haver de prestar atenció a tots els canvis en el nom de la branca.

Recordeu que si trieu una branch, se superposarà aquesta opció. El mateix passarà amb les altres opcions de selecció d'una branca específica, com a etiqueta.

Nota

Aquesta opció només s'aplica als mòduls de Git de kde-projects (el cas habitual). Vegeu també «La base de dades oficial de mòduls del KDE».

Opcions relacionades de la línia d'ordres: --branch-group valor

build-dir
TipusCadena
Valor per defecte~/kde/build

Utilitzeu aquesta opció per a canviar el directori que conté el codi font de construcció. Hi ha tres maneres diferents de fer-ho servir:

  1. En relació amb el directori del codi font del Git de KDE (vegeu l'opció source-dir). Aquest és el valor per defecte, i se selecciona si escriviu un nom de directori que no comenci per una titlla (~) o una barra (/).

  2. Camí absolut. Si especifiqueu un camí que comença per una /, llavors aquest camí s'utilitza directament. Per exemple, /tmp/kde-obj-dir/.

  3. Relatiu al vostre directori personal. Si especifiqueu un camí que comença per una ~, el camí s'utilitzarà de manera relativa al vostre directori personal, de manera anàloga a l'expansió de la titlla de l'intèrpret d'ordres. Per exemple, ~/builddir establiria el directori de construcció a /home/user-name/builddir.

Potser de manera sorprenent, aquesta opció es pot canviar segons cada mòdul.

Opcions relacionades de la línia d'ordres: --build-dir camí

build-when-unchanged
TipusBooleà
Valor per defecteCert

Controla si el kdesrc-build intentarà construir sempre un mòdul que no hagi tingut actualitzacions en el codi font.

Si s'estableix a true (cert), el kdesrc-build sempre intentarà la fase de construcció per a un mòdul, encara que no tingui actualitzacions en el codi font. Amb aquest valor és més probable que condueixi a una construcció amb èxit.

Si s'estableix a false (fals), el kdesrc-build només intentarà executar la fase de construcció per a un mòdul, si aquest té una actualització en el codi font, o en altres situacions on és probable que sigui necessària una reconstrucció. Això pot estalviar temps, especialment si executeu diàriament el kdesrc-build, o amb més freqüència.

Important

Aquesta característica es proporciona només com una optimització. Com moltes altres optimitzacions, hi ha compensacions per a l'exactitud de la vostra instal·lació. Per exemple, els canvis en els mòduls qt o kdelibs poden fer que sigui necessari reconstruir altres mòduls, encara que el codi font no hagi canviat.

Opcions relacionades de la línia d'ordres: --build-when-unchanged (o --force-build), --no-build-when-unchanged (o --no-force-build)

cmake-generator
TipusCadena
Valor per defecteMakefiles de l'Unix

Especifiqueu quin generador utilitzar amb el CMake. Actualment s'admet tant el Ninja com els Makefiles de l'Unix, així com generadors addicionals basats en ells com Eclipse CDT4 - Ninja. Els valors no vàlids (no admesos) seran ignorats i es tractaran com si no s'haguessin establert.

Tingueu en compte que si també s'especifica un generador vàlid mitjançant l'opció cmake-options, se superposarà el valor de cmake-generator.

Opcions relacionades de la línia d'ordres: --cmake-generator valor

cmake-toolchain
TipusCadena

Especifiqueu un fitxer de cadena d'eines per a utilitzar-lo amb el CMake.

Quan es configura un fitxer de cadena d'eines vàlid, el kdesrc-build ja no establirà automàticament les variables d'entorn. Utilitzeu «set-env», «binpath» i «libpath» per a arreglar l'entorn manualment si el vostre fitxer de cadena d'eines no funciona de manera predeterminada amb el kdesrc-build. Per a més informació consulteu el resum dels indicadors estàndard afegits pel kdesrc-build.

Tingueu en compte que si també s'especifica una cadena d'eines vàlida mitjançant l'opció cmake-options, se superposarà el valor de cmake-toolchain.

Opcions relacionades de la línia d'ordres: --cmake-toolchain valor

cmake-options
TipusCadena

Afegeix opcions globals per al sistema de construcció predeterminat, superposarà les opcions globals per als altres sistemes de construcció.

Utilitzeu aquesta opció per a especificar quins indicadors passar al CMake en crear el sistema de construcció per al mòdul. Quan s'utilitza com una opció global, s'aplicarà a tots els mòduls que construeixi aquest script. Quan s'utilitza com una opció de mòdul, s'afegirà al final de les opcions globals. Això permet especificar opcions habituals al CMake en la secció global.

Aquesta opció no s'aplicarà a les qt (les quals no utilitzen el CMake). En el seu lloc utilitzeu configure-flags.

Si s'especifica un generador vàlid entre les opcions llistades, se superposarà el valor de cmake-generator. Els generadors no vàlids (no admesos) seran ignorats i no es passaran al CMake.

Si s'especifica un fitxer de cadenes d'eines vàlid entre les opcions llistades, se superposarà el valor de cmake-toolchain. Les cadenes d'eines no vàlides (no admeses) seran ignorades i no es passaran al CMake.

Atès que aquestes opcions es passen directament a la línia d'ordres de CMake, s'hauran de proporcionar com s'escriurien dins del CMake. Per exemple:

cmake-options -DCMAKE_BUILD_TYPE=RelWithDebInfo

Atès que això és una molèstia, el kdesrc-build s'esforça per a garantir que, sempre que la resta de les opcions estiguin establertes correctament, hauríeu de poder deixar aquesta opció en blanc. (En altres paraules, els paràmetres necessaris de CMake s'establiran automàticament).

Opcions relacionades de la línia d'ordres: --cmake-options valor

compile-commands-export
TipusBooleà
Valor per defecteCert

Permet la generació d'un compile_commands.json a través de CMake a dins el directori de construcció.

Opcions relacionades de la línia d'ordres: --compile-commands-export, --no-compile-commands-export

compile-commands-linking
TipusBooleà
Valor per defecteFals

Permet la creació d'enllaços simbòlics des del compile_commands.json generats a través de CMake a dins el directori de construcció amb el directori de codi font corresponent.

Opcions relacionades de la línia d'ordres: --compile-commands-linking, --no-compile-commands-linking

configure-flags
TipusCadena

Afegeix opcions globals per al sistema de construcció predeterminat, superposarà les opcions globals per als altres sistemes de construcció.

Utilitzeu aquesta opció per a especificar quins indicadors passar a ./configure en crear el sistema de construcció per al mòdul. Quan s'utilitza això com una opció global, s'aplicarà a tots els mòduls que construeixi aquest script. Aquesta opció només funcionarà per a les qt.

Per a canviar les opcions de la configuració per als mòduls del KDE, vegeu cmake-options.

Opcions relacionades de la línia d'ordres: --configure-flags valor

custom-build-command
TipusCadena

Aquesta opció es pot establir per a executar una ordre diferent (que no sigui make, per exemple) per a realitzar el procés de construcció. En general, el kdesrc-build hauria de fer el correcte, per la qual cosa no hauríeu de necessitar establir aquesta opció. No obstant això, podria ser útil utilitzar sistemes de construcció alternatius.

El valor d'aquesta opció s'utilitzarà com la línia d'ordres on executar, modificat de forma normal per l'opció make-options.

Opcions relacionades de la línia d'ordres: --custom-build-command valor

cxxflags
TipusCadena

Afegeix opcions globals per al sistema de construcció predeterminat, superposarà les opcions globals per als altres sistemes de construcció.

Utilitzeu aquesta opció per a especificar quins indicadors utilitzar per a construir el mòdul. Aquesta opció s'especifica aquí en lloc d'amb configure-flags o cmake-options perquè aquesta opció també establirà la variable d'entorn CXXFLAGS durant el procés de construcció.

Recordeu que per al KDE 4 i qualsevol altre mòdul que utilitzi el CMake, cal establir l'opció CMAKE_BUILD_TYPE a none (cap) en configurar el mòdul. Això es pot fer utilitzant l'opció cmake-options.

Opcions relacionades de la línia d'ordres: --cxxflags valor

dest-dir
TipusCadena

Utilitzeu aquesta opció per a canviar el nom que se li dona a un mòdul en el disc. Per exemple, si el mòdul era extragear/network, podreu canviar-li el nom a extragear-network amb aquesta opció. Recordeu que encara que això canvia el nom del mòdul en el disc, no és una bona idea incloure directoris o separadors de directoris en el nom, ja que això interferirà amb les opcions build-dir o source-dir.

Opcions relacionades de la línia d'ordres: --dest-dir camí

do-not-compile
TipusCadena

Utilitzeu aquesta opció per a seleccionar un conjunt específic de directoris que no es construiran en un mòdul (en lloc de tots). Els directoris que no es construiran hauran d'estar separats per espais.

Recordeu que el codi font dels programes encara es descarregarà.

Per exemple, per a inhabilitar la creació dels directoris codeeditor i minimaltest del marc de treball syntaxhighlighting, afegireu a la compilació do-not-compile codeeditor minimaltest, afegireu «do-not-compile juk kscd» a les vostres opcions de ressaltat de la sintaxi.

Per a un exemple, vegeu «Eliminar directoris d'una construcció».

Opcions relacionades de la línia d'ordres: --do-not-compile valor

git-user
TipusCadena
Disponible des de15.09

Aquesta opció està destinada als desenvolupadors del KDE. Si es configura, s'utilitzarà per a configurar automàticament la informació d'identitat per al programari de control del codi font de Git per als mòduls de Git descarregats recentment (inclosa la gran majoria dels mòduls KDE).

Específicament, el nom de l'usuari i els camps de correu electrònic per a cada repositori nou de Git es completen amb els valors establerts per aquesta opció.

El valor s'haurà d'especificar en la forma Nom Usuari <correu_electrònic@exemple.com>.

Per exemple, un desenvolupador anomenat «Foo Barbaroja» amb l'adreça de correu electrònic «foo@abc.xyz» faria servir:

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

http-proxy
TipusCadena
Disponible des de1.16

Aquesta opció, si està establerta, utilitzarà l'URL especificat com un servidor intermediari per a utilitzar-lo en qualsevol comunicació de xarxa HTTP (per exemple, en descarregar la base de dades del projecte KDE).

A més, el kdesrc-build intentarà assegurar que les eines de les quals depèn també utilitzaran aquest servidor intermediari, si és possible, establint la variable d'entorn http_proxy al servidor indicat, si aquesta variable d'entorn encara no està establerta.

Opcions relacionades de la línia d'ordres: --http-proxy valor

directory-layout
TipusCadena
Valors vàlidsflat, invent i metadata
Valor per defecteflat

Aquesta opció s'utilitza per a configurar la disposició que ha d'emprar el kdesrc-build quan crea els directoris de codi font i de construcció.

La disposició flat agruparà tots els mòduls directament sota dels directoris de construcció i de codi font de nivell superior. Per exemple, source/extragear/network/telepathy/ktp-text-ui en la disposició metadata seria source/ktp-text-ui emprant la disposició flat en el seu lloc.

La disposició invent crea una jerarquia de directoris que reflecteix els camins relatius dels repositoris a invent.kde.org. Per exemple, source/kde/applications/kate a la disposició metadata seria source/utilities/kate emprant la disposició invent al seu lloc. Aquesta disposició només afecta els projectes del KDE. És una bona opció per a les persones que comencen amb el kdesrc-build.

Finalment, la disposició metadata és la mateixa que en l'antic comportament predeterminat. Aquesta disposició organitza els projectes del KDE d'acord amb els camins de projecte especificats en les metadades del projecte per a aquests mòduls. Aquesta és una bona opció si voleu una disposició de directoris que faci un seguiment de certs processos del KDE i cal tenir en compte que, per tant, aquest camí no serà sempre estable. Com a resultat, el kdesrc-build pot abandonar una còpia antiga del repositori i clonar-ne una de nova a causa dels canvis en les metadades del projecte.

Opcions relacionades de la línia d'ordres: --directory-layout valor

generate-vscode-project-config
TipusBooleà
Valor per defecteFals

La configuració del mòdul superposa la global

Establiu aquesta opció a true (cert) perquè el kdesrc-build creï els fitxers del projecte VS Code (directori .vscode) en el directori de codi font del mòdul.

La carpeta .vscode es crearà en el directori del codi font del projecte, només si no existeix. Les configuracions permetran l'ús del LSP, la construcció, la depuració i l'execució del projecte des del VS Code.

La configuració també recomana les extensions a instal·lar que són útils per a treballar en la majoria dels projectes KDE.

Opcions relacionades de la línia d'ordres: --generate-vscode-project-config, --no-generate-vscode-project-config

include-dependencies
TipusBooleà
Valor per defecteCert

Controla si el kdesrc-build inclourà les dependències conegudes d'aquest mòdul en la seva construcció, sense requerir que les esmenteu (fins i tot indirectament).

Nota

Aquesta opció només funciona per als mòduls basats en kde-project i requereix que les metadades mantingudes pels desenvolupadors del KDE siguin exactes per al branch-group seleccionat.

Aquesta opció és per a admetre aplicacions de construcció que necessiten versions de les Qt™ o el Plasma™ més recents que les admeses en els sistemes operatius habituals.

Opcions relacionades de la línia d'ordres: --include-dependencies (o -d), --no-include-dependencies (o -D)

install-after-build
TipusCadena
Valor per defecteCert

Aquesta opció s'utilitza per a instal·lar el paquet després que es construeixi amb èxit. També podreu utilitzar l'indicador --no-install de la línia d'ordres.

Opcions relacionades de la línia d'ordres: --install-after-build, --no-install-after-build

install-dir
TipusCadena
Valor per defecte~/kde/usr

Aquesta opció controla a on s'instal·larà el mòdul després de la seva construcció. Si ho canvieu a un directori al qual es necessita accedir com a superusuari (root), és possible que també vulgueu llegir sobre l'opció make-install-prefix.

Canviar aquesta opció per a un mòdul específic permet instal·lar-lo en un directori diferent d'on estan instal·lades les biblioteques de la plataforma KDE, com si estiguéssiu utilitzant el kdesrc-build només per a construir aplicacions.

Podeu utilitzar ${MODULE} o $MODULE en el camí per a expandir el nom del mòdul.

Opcions relacionades de la línia d'ordres: --install-dir camí

libname
TipusCadena
Valor per defecteDetectat automàticament

Establiu aquesta opció per a canviar el nom predeterminat del directori de la biblioteca instal·lada dins de ${install-dir} and ${qt-install-dir}. En molts sistemes això és «lib» o «lib64». La detecció automàtica s'intenta establir el nom correcte per defecte, però si la suposició és incorrecta, es pot canviar amb aquesta opció.

Opcions relacionades de la línia d'ordres: --libname valor

libpath
TipusCadena

Establiu aquesta opció per a establir la variable d'entorn LD_LIBRARY_PATH mentre es construeix. No podreu superposar aquesta opció en una opció de mòdul. El valor predeterminat és en blanc, però els camins ${install-dir}/$LIBNAME i ${qt-install-dir}/$LIBNAME s'afegiran de manera automàtica. Utilitzeu la titlla (~) per a qualsevol camí que afegiu utilitzant aquesta opció.

Opcions relacionades de la línia d'ordres: --libpath camí

log-dir
TipusCadena

Utilitzeu aquesta opció per a canviar el directori utilitzat per a mantenir els fitxers de registre generats per l'script.

Opcions relacionades de la línia d'ordres: --log-dir camí

make-install-prefix
TipusCadena

Establiu aquesta variable en una llista separada per espais, la qual s'interpretarà com una ordre i les seves opcions per a precedir a l'ordre make install utilitzada per a instal·lar els mòduls. Això és útil per a instal·lar paquets amb el Sudo, per exemple, però aneu amb compte en tractar amb els privilegis del superusuari (root).

Opcions relacionades de la línia d'ordres: --make-install-prefix valor

make-options
TipusCadena

Establiu aquesta variable per a passar les opcions de línia d'ordres a l'ordre make. Això és útil per als programes com distcc o els sistemes amb més d'un nucli de processador.

Tingueu en compte que no tots els sistemes de construcció admesos utilitzen el make. Per als sistemes de construcció que utilitzen el ninja per a la construcció (com el sistema de construcció Meson), vegeu l'opció ninja-options.

Opcions relacionades de la línia d'ordres: --make-options valor

manual-build
TipusBooleà
Valor per defecteFals

Establiu el valor de l'opció a true (cert) per a evitar que el procés de construcció intenti construir aquest mòdul. Encara es mantindrà actualitzat quan s'actualitzi des de Git. Aquesta opció és exactament equivalent a l'opció --no-build de la línia d'ordres.

manual-update
TipusBooleà
Valor per defecteFals

Establiu el valor de l'opció a true (cert) per a evitar que el procés de construcció intenti actualitzar (i, per extensió, construir o instal·lar) aquest mòdul. Si establiu aquesta opció per a un mòdul, essencialment l'haureu de descomentar.

ninja-options
TipusCadena

Establiu aquesta variable per a passar les opcions de la línia d'ordres a l'ordre de construcció ninja. Això pot ser útil per a habilitar la sortida «detallada» o per a reduir manualment el nombre de tasques de construcció en paral·lel que faria servir el ninja.

Nota

Recordeu que aquesta opció només controla el ninja quan utilitzeu el kdesrc-build. El mòdul «webengine» de les Qt™ utilitza indirectament el ninja, però només admet oficialment la construcció amb el make. En aquesta situació, podreu configurar NINJAFLAGS com una forma de fer passar els indicadors apropiats quan després es cridi al ninja, utilitzant make-options.

options qtwebengine
    # Restringeix el make i el ninja a l'ús de no més de 6 tasques de
    # compilació separades, fins i tot quan hi hagi més CPU disponible,
    # per a evitar quedar-se sense memòria
    make-options -j6 NINJAFLAGS=-j6
end options

Opcions relacionades de la línia d'ordres: --ninja-options valor

override-build-system
TipusCadena
Valor per defecteDetectat automàticament
Valors vàlidsKDE, Qt, qmake, generic, autotools, meson
Disponible des de1.16

Normalment, el kdesrc-build detectarà el sistema de construcció adequat a utilitzar per a un mòdul després de descarregar-lo. Això es realitza comprovant l'existència de certs fitxers en el directori de codi font del mòdul.

Alguns mòduls poden incloure més d'un conjunt requerit de fitxers, el qual podria confondre la detecció automàtica. En aquest cas, podreu especificar manualment el tipus de construcció correcte.

Els tipus de construcció actualment admesos que es poden establir són:

KDE

S'utilitza per a construir els mòduls del KDE. En realitat, es pot utilitzar per a construir gairebé qualsevol mòdul que utilitzi el CMake, però és millor no confiar-hi.

Qt

S'utilitza per a construir la biblioteca de les Qt™.

qmake

S'utilitza per a construir els mòduls de les Qt™ que utilitzen fitxers .pro a l'estil de qmake.

generic

S'utilitza per a construir els mòduls que utilitzen els Makefile senzills i que no requereixen cap configuració especial.

autotools

Aquesta és l'eina de configuració estàndard utilitzada per la majoria del programari lliure i de codi obert que no es troba en cap de les altres categories.

meson

Aquesta és una eina relativament nova que està guanyant popularitat com a substitució de les «autotools», i pot ser necessària per a alguns mòduls que no són del KDE.

Opcions relacionades de la línia d'ordres: --override-build-system valor

purge-old-logs
TipusBooleà
Valor per defecteCert

Aquesta opció controla si els directoris de registre antics se suprimiran automàticament o no.

Opcions relacionades de la línia d'ordres: --purge-old-logs, --no-purge-old-logs

qmake-options
TipusCadena
Disponible des de1.16

Qualsevol opció especificada aquí es passarà a l'ordre qmake, per als mòduls que utilitzen el sistema de construcció qmake. Per exemple, podeu utilitzar l'opció PREFIX=/camí/a/qt per al qmake per a superposar a on instal·larà el mòdul.

Opcions relacionades de la línia d'ordres: --qmake-options valor

qt-install-dir
TipusCadena

Aquesta opció controla a on s'instal·laran els mòduls qt després de la construcció. Si no especifiqueu aquesta opció, el kdesrc-build assumirà que el sistema operatiu proporciona les Qt™.

Opcions relacionades de la línia d'ordres: --qt-install-dir camí

remove-after-install
TipusCadena
Valors vàlidsnone, builddir, all
Valor per defectenone

Si teniu poc espai al disc dur, és possible que vulgueu utilitzar aquesta opció per a suprimir automàticament el directori de construcció (o els directoris de codi font i de construcció per a les instal·lacions d'una vegada) després que el mòdul s'hagi instal·lat correctament.

Els valors possibles per a aquesta opció són:

  • none: no se suprimeix res.

  • builddir: se suprimirà el directori de construcció, però no el de codi font.

  • all: se suprimirà tant el directori de codi font com el de construcció.

Recordeu que l'ús d'aquesta opció podria tenir un impacte perjudicial significatiu tant en l'ús en l'amplada de banda (si utilitzeu all) com en el temps necessari per a compilar el programari KDE, ja que el kdesrc-build no pot realitzar construccions incrementals.

Opcions relacionades de la línia d'ordres: --remove-after-install valor

repository
TipusCadena
Disponible des de1.10

Aquesta opció s'utilitza per a especificar el repositori del Git des d'on descarregar el codi font del mòdul. Les Qt™ (i per tant, qt) necessitaran aquesta opció, així com diversos mòduls del KDE que estan en procés de conversió per a utilitzar el Git.

revision
TipusCadena
Disponible des de1.16

Si aquesta opció s'estableix en un valor diferent de 0 (zero), el kdesrc-build forçarà l'actualització del codi font per a portar el mòdul a la revisió exacta indicada, fins i tot si estan vigents opcions com la branch (branca). Si el mòdul ja es troba en la revisió indicada, no s'actualitzarà més a menys que aquesta opció es canviï o s'elimini de la configuració.

Opcions relacionades de la línia d'ordres: --revision id

run-tests
TipusBooleà
Valor per defecteFals

Si s'estableix a true (cert), el mòdul es construirà amb suport per a executar el seu conjunt de proves, i el conjunt de proves s'executarà com a part del procés de construcció. El kdesrc-build mostrarà un informe senzill dels resultats de les proves. Això és útil per als desenvolupadors o aquells que volen assegurar-se que el seu sistema està configurat correctament.

Opcions relacionades de la línia d'ordres: --run-tests, --no-run-tests

set-env
TipusCadena

Aquesta opció accepta un conjunt de valors separats per espais, on el primer valor és la variable d'entorn per a establir, i la resta dels valors són el que voleu que estableixi la variable. Per exemple, per a establir la variable RONALD a McDonald, haureu de posar aquesta ordre a la secció corresponent:

set-env RONALD McDonald

Aquesta opció és especial perquè pot repetir-se sense superposar la configuració anterior de «set-env» a la mateixa secció del fitxer de configuració. D'aquesta manera, podreu establir més d'una variable d'entorn per mòdul (o globalment).

source-dir
TipusCadena
Valor per defecte~/kde/src

Aquesta opció s'utilitza per a configurar el directori a l'ordinador per a emmagatzemar el codi font de Git del KDE. Podeu utilitzar la titlla (~) per a representar el directori d'inici si feu servir aquesta opció.

Opcions relacionades de la línia d'ordres: --source-dir camí

stop-on-failure
TipusBooleà
Valor per defecteCert

Establint aquesta opció a false (fals) es permet que l'script continuï l'execució després que succeeixi un error durant el procés de construcció o instal·lació.

Opcions relacionades de la línia d'ordres: --stop-on-failure, --no-stop-on-failure

etiqueta
TipusCadena
Disponible des de1.16

Empreu aquesta opció per a descarregar una versió específica d'un mòdul.

Nota: Les probabilitats són molt bones perquè no vulgueu utilitzar aquesta opció. Les versions del KDE estan disponibles en format arxiu tar des del lloc de descàrrega del KDE.

Opcions relacionades de la línia d'ordres: --tag valor

use-clean-install
TipusBooleà
Valor per defecteFals
Disponible des de1.12

Establiu aquesta opció a true (cert) perquè el kdesrc-build executi make uninstall directament abans d'executar make install.

Això pot ser útil per a assegurar que no hi hagi fitxers antics de biblioteca que estan perduts, les metadades de CMake, etc. que puguin causar problemes a les instal·lacions del KDE de llarga durada. Tanmateix, això només funciona en els sistemes de construcció que admeten la desinstal·lació.

Opcions relacionades de la línia d'ordres: --use-clean-install, --no-use-clean-install


Aquestes opcions no requereixen cap valor (excepte «filter-out-phases»). S'apliquen si es presenten en una secció.

Taula 4.3. Opcions de selecció de fase

Nom de l'opcióÀmbitDescripció
no-src
global
module
module-set

Elimina la fase d'actualització. Les altres fases que es presentin encara es processaran.

Opcions relacionades de la línia d'ordres: --no-src (o -S)

no-install
global
module
module-set

Elimina la fase d'instal·lació. Les altres fases que es presentin encara es processaran.

Opcions relacionades de la línia d'ordres: --no-install

no-tests
global
module
module-set

Elimina la fase de proves. Les altres fases que es presentin encara es processaran.

Opcions relacionades de la línia d'ordres: --no-tests

no-build
global
module
module-set

Elimina la fase de construcció. Les altres fases que es presentin encara es processaran.

Opcions relacionades de la línia d'ordres: --no-build

build-only
global
module
module-set

Si té la fase de construcció, elimina qualsevol altra fase. En cas contrari, elimina totes les fases.

Opcions relacionades de la línia d'ordres: --build-only

install-only
global
module
module-set

Si té la fase d'instal·lació, elimina qualsevol altra fase. En cas contrari, elimina totes les fases.

Opcions relacionades de la línia d'ordres: --install-only

uninstall
global
module
module-set

Si té la fase de desinstal·lació, elimina qualsevol altra fase. En cas contrari, elimina totes les fases.

Opcions relacionades de la línia d'ordres: --uninstall

filter-out-phases
global
module
module-set

Elimina les fases que es llisten (separades per espais) en aquesta opció. Les altres fases que es presentin encara es processaran.


Taula 4.4. Opcions de selecció de mòduls

Nom de l'opcióÀmbitDescripció
ignore-modules
global
module-set
TipusCadena
Disponible des de1.16

Tingueu en compte que quan s'especifica a la secció global, l'opció --ignore-modules de la línia d'ordres no anul·la aquesta opció, sinó que l'afegeix.

Els mòduls nomenats per aquesta opció, els quals serien triats pel kdesrc-build a causa d'una opció use-modules, s'ometran completament. Utilitzeu aquesta opció quan vulgueu construir una tota agrupació de projectes kde-projects, excepte alguns mòduls específics.

El valor de l'opció no necessàriament haurà de nomenar el mòdul directament. S'ignorarà qualsevol mòdul que tingui parts consecutives completes del seu camí de mòduls de projectes del KDE que coincideixi amb un dels valors de l'opció, d'aquesta manera es podran ignorar múltiples mòduls.

Per exemple, un valor d'opció libs donaria lloc a l'exclusió de kde/kdegraphics/libs i de playground/libs (encara que no kde/kdelibs, ja que es compara la part completa «kdelibs»).

Opcions relacionades de la línia d'ordres: --ignore-modules (o -!) module [mòdul ...]

use-modules
module-set
TipusCadena
Disponible des de1.12.1

Aquesta opció permet especificar amb facilitat molts mòduls diferents per a construir en el mateix punt el fitxer de configuració.

Cada identificador passat a aquesta opció es convertirà internament en un mòdul del kdesrc-build, amb una opció repository establerta al repositori del conjunt de mòduls combinada amb el nom de l'identificador per a configurar el repositori final des d'on descarregar. Totes les altres opcions que s'assignin en el conjunt de mòduls també es copiaran sense modificacions als mòduls generats.

L'ordre en què es defineixen els mòduls en aquesta opció és important, perquè aquest serà també l'ordre en què el kdesrc-build processarà els mòduls generats en actualitzar, construir i instal·lar. Tots els mòduls definits en el conjunt de mòduls indicat es gestionaran abans que el kdesrc-build passi al següent mòdul després del conjunt de mòduls.

Si necessiteu canviar les opcions per a un mòdul generat, simplement declareu el mòdul de nou després que estigui definit en el conjunt de mòduls i establiu les opcions segons sigui necessari. Encara que canvieu d'aquesta manera les opcions establertes per al mòdul, el mòdul se seguirà actualitzant i construint en l'ordre establert pel conjunt de mòduls (és a dir, fent això no podreu tornar a ordenar la seqüència de construcció).

Important

El nom a utilitzar per al mòdul si feu això, serà el nom que vàreu passar a use-modules, amb l'excepció que s'elimina qualsevol .git.

Vegeu «Conjunts de mòduls» i git-repository-base per a obtenir una descripció del seu ús i un exemple.