Namcap (Italiano)

The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.

Namcap è uno strumento per controllare pacchetti binari ed codice sorgente di PKGBUILD alla ricerca di errori comuni nella pacchettizzazione; lo si può anche abilitare in modalità automatica. Namcap è stato scritto da Jason Chu.

Cambiamenti: Il file NEWS nei repository git contiene le novità introdotte dalla versione precedente.

Sezione di sviluppo: https://gitlab.archlinux.org/pacman/namcap

Per segnalare un bug o richiedere nuove funzionalità per namcap, inviare un bug nella sezione Packages:Extra di Arch Linux bugtracker specificandone priorità ed importanza. Quando si segnalano bug è importante fornire esempi concreti dei pacchetti dove si verificano gli errori e non si dimentichi di comunicare il numero di versione.

Se si possono fornire delle patch (per correzione di bug o per nuovi moduli namcap), è possibile inviarle alla mailing list arch-projects. Lo sviluppo di Namcap viene gestito con git, quindi sono preferibili le patch in formato git.

Installazione

Installare il pacchetto namcap dagli official repositories.

Come usarlo

Per lanciare namcap su un PKGBUILD o su un pacchetto binario pkg.tar.xz:

$ namcap FILENAME

Per visualizzare messaggi con ulteriori informazioni, invocare namcap con la flag -i:

$ namcap -i FILENAME

Si può anche consultare il manuale namcap(1) digitando man namcap dalla riga di comando.

Comprendere il significato dell'output

Namcap usa un sistema di tags per classificare gli output. Attualmente, i tags sono di tre tipi, errors (identificati da E), warnings (identificati da W) e informational (identificati da I). Gli errori sono importanti e dovrebbero essere corretti immediatamente; nella maggior parte dei casi sono relativi ad un insufficiente livello di sicurezza, licenze mancanti o problemi di permessi.

Normalmente namcap stampa una spiegazione "umanamente comprensibile" (talvolta con suggerimenti per la risoluzione dei problemi). Se si preferisce un output che possa essere facilmente interpretato da un programma aggiungere la flag -m (machine-readable) a namcap (questa funzionalità è attualmente in fase di sviluppo).

Creazione di un modulo namcap

Questa sezione documenta namcap internamente e specifica come creare un nuovo modulo namcap.

Il programma principale di namcap, namcap.py, prende come parametri il nome del file di un pacchetto o un PKGBUILD e lo converte in un oggetto pkginfo, che lo passa ad un elenco di regole definite nel __tarball__ e nel __pkgbuild__.

__tarball__ definisce le regole che elaborano pacchetti binari.
__pkgbuild__ definisce le regole che elaborano i PKGBUILDs.

Una volta che il modulo è finalizzato, ricordarsi di aggiungerlo all'array relativo (__tarball__ o __pkgbuild__) definito in Namcap/init.py

Un esempio di modulo namcap è questo (Namcap/url.py):

import pacman

 class package:
 	def short_name(self):

return "url" def long_name(self): return "Verifies url is included in a PKGBUILD" def prereq(self): return "" def analyze(self, pkginfo, tar): ret = [[],[],[]] if not hasattr(pkginfo, 'url'): ret[0].append(("missing-url", ())) return ret def type(self): return "pkgbuild"

Fondamentalmente, il codice si spiega da sé. Di seguito viene riportato l'elenco dei metodi che ogni modulo namcap deve avere:

short_name(self) Restituisce una stringa contenente un nome breve del modulo. Di solito, questo equivale al nome di base del file modulo.
long_name(self) Restituisce una stringa contenente una descrizione sintetica del modulo. Tale descrizione è utilizzata quando si elencano tutte le regole con namcap -r list.
prereq(self) Restituisce una stringa contenente i prerequisiti necessari al modulo per funzionare correttamente. Solitamente "" per moduli di elaborazione PKGBUILD e "tar" per moduli di elaborazione di file pacchetto. "extract" deve essere specificato se il contenuto del pacchetto deve essere estratto in una directory temporanea prima di procedere.
analyze(self, pkginfo, tar) Dovrebbe restituire un elenco che comprende, a sua volta tre elenchi: errore di tag, etichette di avvertimento e di informazione. Ogni membro di questi elenchi tag deve essere una tupla composta da due componenti: la forma breve con trattini del tag con gli appropriati specificatori di formato (%s, etc.) La prima parola di questa stringa deve essere il nome del tag. La forma "umanamente" leggibile del tag deve essere messa nel file tags. Il formato del file tags è descritta di seguito; i parametri che dovrebbero sostituire il formato specifico rimangono nell'output finale.

type(self) "pkgbuild" per un modulo di elaborazione dei PKGBUILDs, "tarball" per un modulo di elaborazione di un pacchetto binario.

Il file dei tag è costituito da righe che riportano la forma "umanamente" leggibile dei tag a fianco della forma scritta coi trattini del codice namcap. Una riga che inizia con un '#' viene considerata commentata. In caso contrario, il formato del file è:

 machine-parseable-tag %s :: This is machine parseable tag %s

Si noti che un "doppio due punti" (::) è utilizzato per separare i tag scritti con trattini dalla descrizione leggibile.

Namcap reports

namcap-reports è un report generato automaticamente ed ottenuto dopo l'esecuzione di namcap rispetto a core, extra e community.

Come funziona:

namcap viene eseguito rispetto all'intero albero ABS per generare namcap.log.
I pacchetti in core, extra e community vengono messi in file chiamati core, extra e community (usando pacman -Slq).
namcap-report.py prende il codice e prepara il report e i feed RSS, per essere poi copiato nel server web.

Namcap (Italiano)

Contents

Installazione

Come usarlo

Comprendere il significato dell'output

Tags

Link simbolici

Dipendenze

Licenze

File

Varie

PKGBUILDs

Unreleased

Creazione di un modulo namcap

Namcap reports