Parametri da riga di comando supportati

Generici

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

kdesrc-build farà il processo di aggiornamento e generazione, ma invece di aggiornare e generare davvero scriverà cosa avrebbe fatto (per esempio comandi da eseguire, passi vari, eccetera).

Nota

Dei semplici comandi di sola lettura (come leggere informazioni dei file) potrebbero comunque essere eseguiti per rendere l'output più significativo (come simulare correttamente se il codice sorgente debba essere ritirato o aggiornato).

Importante

Questa opzione richiede la disponibilità di alcuni metadati, i quali di norma vengono scaricati; ma gli scaricamenti sono disattivati in questa modalità di prova. Se non hai mai eseguito kdesrc-build, e quindi non hai questi metadati, dovresti eseguire prima kdesrc-build --metadata-only per scaricare i metadati necessari.

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

Questa opzione fa sì che kdesrc-build includa automaticamente gli altri moduli KDE e Qt™ nella compilazione, se richiesto per i moduli che hai indicato da compilare nella riga di comando o nel tuo file di configurazione.

I moduli inclusi vengono aggiunti come registrati all'interno del sistema di gestione del codice sorgente di KDE. Vedi la sezione chiamata «La banca dati dei moduli ufficiale di KDE».

L'opzione del file di configurazione corrispondente è include-dependencies.

Come impostazione predefinita questa opzione è abilitata.

--ignore-modules (o -!) module [modulo ...]

Non includere i moduli passati al resto della riga di comando nel processo di aggiornamento e generazione (ciò è utile se vuoi generare la maggior parte dei moduli nel file di configurazione e saltarne qualcuno).

Nota che questa opzione non aggira l'opzione di configurazione ignore-modules nella sezione globale. La aggiunge, invece.

--run (o --start-program) [-e|--exec name] [-f|--fork] programma [parametri ...]

Questa opzione interpreta il prossimo elemento sulla riga di comando come un programma da eseguire; kdesrc-build finirà di leggere il file di configurazione, prende prefix.sh per applicare le variabili d'ambiente, poi eseguirà il programma dato.

--revision id

Questa opzione fa ritirare a kdesrc-build la revisione corrispondente a un certo numero per ogni modulo di Git, sostituendosi a qualsiasi opzione di ramo, tag o revisione già impostata per questi moduli.

Questa opzione probabilmente non è una buona idea, ed è supportata per retrocompatibilità con vecchi script.

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

Questa opzione si usa per far eliminare a kdesrc-build le cartelle sorgente che potrebbero contenere dati dell'utente, in modo che i moduli possano essere scaricati di nuovo. Questo è normalmente utile solo agli sviluppatori di KDE (che potrebbero avere delle modifiche locali da eliminare).

Normalmente non dovresti usare questa opzione; kdesrc-build richiederà di venire eseguito una seconda volta, se necessario.

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

Questa opzione si usa per far sovrascrivere a kdesrc-build tutti i file preesistenti che potrebbero contenere dati dell'utente.

Al momento si usa soltanto per la configurazione di xsession per il gestore degli accessi. Normalmente non dovresti usare questa opzione; kdesrc-build richiederà di venire eseguito una seconda volta, se necessario.

--<nome_opzione> valore

Puoi usare questa opzione per sostituire un'opzione nel tuo file di configurazione per ogni modulo. Per esempio, per sostituire l'opzione log-dir, scriveresti: --log-dir /percorso/a/cartella.

Nota

Questa funzionalità può essere usata solo per i nomi di opzioni già note a kdesrc-build che non siano già supportate da appropriate opzioni da riga di comando. Per esempio, l'opzione del file di configurazione async ha le apposite opzioni da riga di comando --async e --no-async, che vengono preferite da kdesrc-build.

--set-module-option-value <nome-modulo>,<nome-opzione>,<valore-opzione>

Puoi usare questa opzione per sostituire un'opzione nel file di configurazione di un modulo particolare.

Riprendere e fermare

--resume-from (o --from o -f) modulo

Questa opzione è usata per riprendere la generazione a partire dal modulo dato. Non dovresti specificare altri nomi di moduli sulla riga di comando.

Nota

Se vuoi evitare gli aggiornamenti del sorgente quando riprendi, basta che passi --no-src insieme alle altre opzioni.

Vedi anche --resume-after e la sezione chiamata «Riprendere una generazione non riuscita o annullata». Probabilmente preferiresti usare questa opzione da riga di comando se hai corretto l'errore di generazione e vuoi che kdesrc-build la completi.

--resume-after (o --after o -a) modulo

Questa opzione è usata per riprendere la generazione da dopo il modulo dato. Non dovresti specificare altri nomi di moduli sulla riga di comando.

Nota

Se vuoi evitare gli aggiornamenti del sorgente quando riprendi, basta che passi --no-src insieme con le altre opzioni.

Vedi anche --resume-from e la sezione chiamata «Riprendere una generazione non riuscita o annullata». Probabilmente preferiresti usare questa opzione da riga di comando se hai corretto l'errore di generazione e hai anche generato e installato il modulo da te, e vuoi che kdesrc-build riparta dal modulo seguente.

--resume

Questa opzione può essere usata per eseguire kdesrc-build dopo che si è verificato un errore di generazione.

Riprende la generazione dal modulo che non è riuscito, usando l'elenco dei moduli in attesa di essere generati, e disattiva gli aggiornamenti del codice sorgente e dei metadati. L'uso tipico è quando un banale errore o una dipendenza mancante causano l'errore di generazione. Una volta che l'errore è stato corretto, puoi rapidamente tornare alla generazione dei moduli senza dover configurare --resume-from e --stop-before.

--stop-before (o --until) modulo

Quest'opzione si usa per fermare il normale processo di generazione appena prima della prevista generazione di un modulo.

Per esempio, se l'elenco di generazione normale era moduloA, moduloB, moduloC, --stop-before moduloB farà generare a kdesrc-build solo moduloA.

--stop-after (o --to) modulo

Quest'opzione si usa per fermare il normale processo di generazione appena dopo la generazione di un modulo.

Per esempio, se l'elenco di generazione normale era moduloA, moduloB, moduloC, --stop-after moduloB farà generare a kdesrc-build moduloA e moduloB.

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

Quest'opzione controlla se la generazione sarà interrotta non appena si verifica un errore. Il comportamento predefinito è --stop-on-failure. È possibile ignorarla se vuoi procedere con i moduli rimanenti della generazione, per evitare di perdere tempo nel caso in cui il problema fosse in un solo modulo.

Vedi anche l'opzione del file di configurazione stop-on-failure.

--rebuild-failures

Usa questa opzione per generare solo quei moduli la cui generazione non è riuscita in una precedente esecuzione di kdesrc-build. Questo è utile se si è verificato un numero notevole di generazioni errate miste a riuscite. Dopo aver corretto ciò che causa gli errori, puoi quindi facilmente rigenerare solo i moduli che prima non sono riusciti.

Nota

Nota che l'elenco di «moduli precedentemente non riusciti» viene azzerato ogni volta che un'esecuzione di kdesrc-build si conclude con errori. Tuttavia non viene azzerato in caso di generazione perfettamente riuscita, quindi puoi rigenerare correttamente un modulo o due e questa opzione funzionerà ancora.

Informazioni sui moduli

--querymodalità

Questo comando fa richiedere a kdesrc-build un parametro dei moduli nell'elenco di compilazione (o passato dalla riga di comando o letto dal file di configurazione), inviando il risultato allo schermo (un modulo per riga).

Questa opzione deve essere fornita con «modalità», che potrebbe essere una delle seguenti:

  • source-dir: kdesrc-build restituisce il percorso completo in cui è memorizzato il codice sorgente del modulo.

  • build-dir: kdesrc-build restituisce il percorso completo in cui si è compiuto il processo di generazione del modulo.

  • install-dir, kdesrc-build restituisce il percorso completo in cui il modulo sarà installato.

  • project-path: kdesrc-build restituisce la posizione del modulo all'interno della gerarchia dei depositi di codice sorgente di KDE. Consulta la sezione chiamata «La banca dati dei moduli ufficiale di KDE» per maggiori informazioni su questa gerarchia.

  • branch: kdesrc-build restituisce il ramo git risolto che verrà usato per ciascun modulo, basato sulle impostazioni effettive di tag, branch e branch-group.

  • module-set, fa sì che kdesrc-build restituisca il nome del gruppo di moduli che contiene il modulo. Può essere utilizzato per generare la cache di completamento automatico zsh.

  • build-system, che fa sì che kdesrc-build restituisca il sistema di generazione rilevato per il modulo. Può essere utilizzato per eseguire il debug dei problemi di rilevamento automatico dei sistemi di generazione, o quando si sviluppano test per sistemi di generazione specifici.

  • Qualsiasi nome di opzione che è valido per i moduli contenuti nel file di configurazione.

Per esempio, il comando kdesrc-build --query branch kactivities kdepim potrebbe concludersi con un risultato tipo:

kactivities: master
kdepim: master
--dependency-tree

Restituisce le informazioni di dipendenza sui moduli che devono essere compilati, utilizzando un formato ad albero (ricorsivo). Le informazioni elencate includono anche da quale commit/ramo/tag dipendono e se la dipendenza deve essere compilata. Nota: l'output generato può diventare molto grande per le applicazioni con molte dipendenze.

--dependency-tree-fullpath

Restituisce le informazioni di dipendenza sui moduli che devono essere compilati, utilizzando un formato ad albero (ricorsivo). In formato «fullpath». Nota: l'output generato può diventare molto grande per le applicazioni con molte dipendenze.

--list-installed

Restituisce i moduli installati ed esce. Può essere utilizzato per generare il completamento automatico per l'opzione --run.

Escludi l'azione specifica

--no-metadata (o -M)

Non scaricare automaticamente i metadati necessari per i moduli git di KDE. Gli aggiornamenti del codice sorgente dei moduli stessi avverrà comunque, a meno che passi anche --no-src.

Questo può essere utile quando esegui più volte kdesrc-build, visto che i metadati non cambiano spesso. Nota però che molte altre funzionalità richiedono la presenza dei metadati. Potresti considerare di eseguire kdesrc-build con l'opzione --metadata-only una volta, e usare questa opzione per le esecuzioni seguenti.

--no-src (o -S)

Salta la connessione al server Git.

--no-build

Salta il processo di generazione.

--no-install

Non installare automaticamente i pacchetti dopo averli generati.

Solo l'azione specifica

--metadata-only

Effettua solo il processo di scaricamento dei metadati. kdesrc-build normalmente lo gestisce automaticamente, ma potresti usarlo per far funzionare l'opzione --pretend.

--src-only (o -s)

Fai solo l'aggiornamento del codice sorgente.

--build-only

Fai solo la generazione.

--install-only

Se questa è l'unica opzione dalla riga di comando, cerca di installare tutti i moduli contenuti nella cartella log/latest/build-status. Se sono specificate opzioni da riga di comando dopo questa opzione, sono tutte considerate essere moduli da installare (anche se non sono stati generati correttamente l'ultima volta).

--build-system-only

Questa opzione fa interrompere a kdesrc-build la generazione di un modulo appena prima dell'esecuzione del comando make. Ciò viene supportato solo per retrocompatibilità con vecchie versioni; questo effetto non è utile per l'attuale sistema di generazione di KDE.

Comportamento di generazione

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

Abilitare questa opzione disabilita esplicitamente il salto del processo di generazione (un'ottimizzazione controllata dall'opzione build-when-unchanged). Ciò è utile per far eseguire a kdesrc-build la generazione quando hai cambiato qualcosa che kdesrc-build non può controllare. Questa opzione è abilitata in modo predefinito.

--refresh-build (o -r)

Ricrea il sistema di generazione e compila da zero.

--reconfigure

Riesegui cmake (per i moduli di KDE) o configure (per Qt™), senza ripulire la cartella di generazione. Normalmente non avresti bisogno di specificarlo, perché kdesrc-build rileverà il cambiamento di opzioni rilevanti e rieseguirà automaticamente la configurazione. Questa opzione è sottintesa se si usa --refresh-build.

--install-dir percorso

Permette di cambiare la cartella dove saranno installati i moduli. Questa opzione implica --reconfigure, ma potrebbe ancora essere richiesto di usare --refresh-build.

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

Genera una cartella .vscode con configurazioni per la generazione e il debug in Visual Studio Code. Questa opzione è disabilita in modo predefinito.

Tempo di esecuzione degli script

--async, --no-async

Abilita o disabilita la modalità asincrona, che può eseguire contemporaneamente gli aggiornamenti del codice sorgente e la generazione dei moduli. Se disabilitato, l'aggiornamento verrà invece interamente effettuato prima dell'inizio della generazione. Disabilitare questa opzione rallenterà il processo complessivo. Se si verificano errori IPC durante l'esecuzione di kdesrc-build, prova a disabilitarla e invia una segnalazione di errore. Questa opzione è abilita in modo predefinito.

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

Abilita o disabilita l'output colorato. Per impostazione predefinita, questa opzione è abilitata per i terminali interattivi.

--nice (o --niceness) valore

Questo valore regola la priorità di processore richiesta da kdesrc-build, e dovrebbe essere tra 0 e 20. 0 è la priorità massima (perché è la meno «cortese», in inglese nice), 20 la minima. Il valore predefinito di questa opzione è 10.

--rc-file file

Il file da cui leggere le opzioni di configurazione. Il valore predefinito di questo parametro è kdesrc-buildrc (spuntato nell'attuale cartella di lavoro). Se questo file non esiste, sarà usato invece ~/.config/kdesrc-buildrc ($XDG_CONFIG_HOME/kdesrc-buildrc, se $XDG_CONFIG_HOME è impostato). Vedi anche Capitolo 4, Configurare kdesrc-build.

Configurazione

--initial-setup

Consente a kdesrc-build di eseguire una prima configurazione necessaria per preparare il sistema affinché kdesrc-build possa operare e il software KDE appena installato possa avviarsi.

Questo include:

  • l'installazione delle dipendenze conosciute (sulle distribuzioni Linux® supportate)

  • l'aggiunta delle variabili d'ambiente richieste in ~/.bashrc

Questa opzione è esattamente uguale all'uso concomitante di --install-distro-packages --generate-config. In kdesrc-build (implementazione perl) usa in aggiunta «--install-distro-packages-perl».

--install-distro-packages

Installa i pacchetti della distribuzione (nelle distribuzioni Linux® supportate) necessari a preparare il sistema al funzionamento di kdesrc-build e all'esecuzione del software KDE installato di recente.

Vedi anche --initial-setup

--generate-config

Genera il file di configurazione di kdesrc-build.

Vedi anche --initial-setup

Livello di verbosità

--debug

Abilita la modalità di debug per lo script. Attualmente ciò significa che tutto l'output sarà riversato sullo standard output oltre ad essere registrato nella cartella di registro, come sarebbe normale. Inoltre, molte funzioni sono molto più verbose riguardo a quello che stanno facendo in modalità di debug.

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

Non scrivere tanto output. Con questa opzione vengono scritte solo le cose fondamentali.

--really-quiet

scrivi solo avvertimenti ed errori.

--verbose

Scrivi molte cose su quello che sta succedendo, e su cosa sta facendo kdesrc-build.

Informazioni sugli script

--version (o-v)

Mostra la versione del programma.

--help (o -h)

Mostra soltanto un semplice aiuto sull'uso di questo script.

--show-info

Visualizza informazioni su kdesrc-build e il sistema operativo, che si mostrano utili nelle segnalazioni di errori o quando richiedi aiuto nei forum o nelle mailing list.

--show-options-specifiers

Stampa le linee degli specificatori (nel formato accettato da GetOpts::Long) per tutte le opzioni della riga di comando supportate dallo script. Può essere utilizzato dagli sviluppatori, per esempio, per la generazione di funzioni di completamento automatico zsh.