Aggiungere funzionalità con le estensioni

belaran@976: belaran@976: belaran@976: Aggiungere funzionalità con le estensioni belaran@976: belaran@976: Se da una parte il nucleo di Mercurial è piuttosto completo dal punto di vista delle funzionalità, dall’altra è deliberatamente privo di caratteristiche ornamentali. Questo approccio orientato a preservare la semplicità mantiene il software facile da maneggiare sia per chi ne cura la manutenzione sia per chi lo usa. belaran@976: belaran@976: Tuttavia, Mercurial non vi vincola a usare un insieme di comandi immutabile: potete aggiungere nuove funzioni a Mercurial sotto forma di estensioni (talvolta note come plugin). Abbiamo già discusso alcune di queste estensioni nei capitoli precedenti. belaran@976: belaran@976: La parla dell’estensione fetch, che combina l’estrazione di nuovi cambiamenti e la loro unione con i cambiamenti locali in un singolo comando, fetch. belaran@976: belaran@976: Nel , abbiamo parlato di diverse estensioni le cui funzioni sono utilizzabili sotto forma di hook: acl aggiunge le liste di controllo d’accesso, bugzilla aggiunge l’integrazione con il sistema Bugzilla per la gestione dei bug e notify invia email di notifica in reazione all’inserimento di nuovi cambiamenti. belaran@976: belaran@976: L’estensione Mercurial Queues per la gestione delle patch è talmente importante da meritare due capitoli e un’appendice interamente dedicati: il copre le nozioni di base, il ne discute gli argomenti avanzati e l’ tratta ogni comando nei dettagli. belaran@976: belaran@976: belaran@976: belaran@976: In questo capitolo, parleremo di alcune delle altre estensioni disponibili per Mercurial e tratteremo brevemente alcuni dei meccanismi che avrete bisogno di conoscere se volete scrivere le vostre estensioni. belaran@976: belaran@976: belaran@976: belaran@976: Migliorare le prestazioni con l’estensione <literal role="hg-ext">inotify</literal> belaran@976: belaran@976: Siete interessati a ottenere esecuzioni fino a cento volte più veloci per alcune delle più comuni operazioni compiute da Mercurial? Continuate a leggere! belaran@976: belaran@976: Le prestazioni di Mercurial sono tipicamente eccellenti. Per esempio, quando invocate il comando hg status, Mercurial deve esaminare quasi ogni file e directory nel vostro repository in modo da mostrare lo stato dei file. Molti altri comandi Mercurial devono fare lo stesso lavoro dietro le quinte: per esempio, il comando hg diff usa il meccanismo dello stato per evitare costose operazioni di confronto su file che ovviamente non sono stati modificati. belaran@976: belaran@976: Dato che ottenere lo stato di un file è un’operazione cruciale per raggiungere buone prestazioni, gli autori di Mercurial hanno ottimizzato il più possibile questo codice. Tuttavia, quando invocate hg status, Mercurial dovrà necessariamente effettuare almeno una costosa chiamata di sistema per ogni file registrato in modo da determinare se è stato modificato dall’ultima volta che Mercurial ha controllato. Per repository di dimensioni sufficientemente grandi, questa operazione può durare molto tempo. belaran@976: belaran@976: Per esprimere numericamente la vastità di questo effetto, ho creato un repository contenente 150.000 file registrati e ho cronometrato hg status per scoprire che impiega dieci secondi a terminare, anche quando nessuno di quei file è stato modificato. belaran@976: belaran@976: Molti sistemi operativi moderni contengono utilità di notifica per i file. Se un programma si registra al servizio appropriato, il sistema operativo lo avvertirà ogni volta che un file di interesse viene creato, modificato, o cancellato. Sui sistemi Linux, il componente del kernel che si occupa di questa funzione si chiama inotify. belaran@976: belaran@976: L’estensione inotify di Mercurial interagisce con il componente inotify per ottimizzare l’esecuzione di hg status. Questa estensione ha due componenti. Un demone viene eseguito in background e riceve le notifiche dal sottosistema inotify, accettando connessioni anche dai normali comandi Mercurial. L’estensione modifica il comportamento di Mercurial in modo che, invece di esaminare il file system, interroghi il demone. Dato che il demone possiede informazioni esatte sullo stato del repository, può rispondere istantaneamente con un risultato, senza dover esaminare tutti i file e le directory nel repository. belaran@976: belaran@976: Ricordate i dieci secondi che ho misurato come il tempo impiegato dal solo Mercurial per eseguire hg status su un repository di 150.000 file? Con l’estensione inotify abilitata, il tempo è sceso a 0.1 secondi, più veloce di un fattore cento. belaran@976: belaran@976: Prima di continuare, vi prego di fare attenzione ad alcuni avvertimenti. belaran@976: belaran@976: L’estensione inotify è specifica per Linux. Dato che si interfaccia direttamente con il sottosistema inotify del kernel di Linux, non funziona su altri sistemi operativi. belaran@976: belaran@976: L’estensione dovrebbe funzionare su qualsiasi distribuzione Linux rilasciata dopo i primi mesi del 2005. È probabile che le distribuzioni più vecchie includano un kernel a cui manca inotify, o una versione di glibc senza il necessario supporto di interfaccia. belaran@976: belaran@976: Non tutti i file system sono adatti per essere usati con l’estensione inotify. I file system di rete come NFS sono fuori gioco, per esempio, in particolare se state eseguendo Mercurial su diversi sistemi che montano lo stesso file system di rete. Il sistema inotify del kernel non ha alcun modo di sapere quali cambiamenti sono avvenuti su un altro sistema. La maggior parte dei file system locali (e.g. ext3, XFS, ReiserFS) dovrebbe andare bene. belaran@976: belaran@976: belaran@976: A maggio 2007, l’estensione inotify non viene ancora distribuita con Mercurial, quindi è un po’ più complicata da installare rispetto ad altre estensioni.[NdT] A partire da Mercurial 1.0, l’estensione inotify è stata inclusa nella distribuzione. L’estensione deve comunque ancora considerarsi assolutamente in fase sperimentale. Ma il miglioramento delle prestazioni ne vale la pena! belaran@976: belaran@976: Attualmente, l’estensione è divisa in due parti: un insieme di patch al codice sorgente di Mercurial e una libreria di interfaccia Python al sottosistema inotify. belaran@976: belaran@976: Esistono due librerie di interfaccia Python per inotify. Una è chiamata pyinotify ed è inclusa in alcune distribuzioni Linux sotto il nome python-inotify. Questa non è quella di cui avete bisogno, dato che è troppo inefficiente e piena di problemi per essere pratica. belaran@976: belaran@976: Per cominciare, è meglio avere già installata una copia funzionante di Mercurial. belaran@976: belaran@976: Se seguite le istruzioni qui sotto, finirete per sostituire e sovrascrivere qualsiasi installazione esistente di Mercurial possiate già avere, usando l’ultima versione sperimentale di Mercurial. Non dite che non siete stati avvertiti! belaran@976: belaran@976: belaran@976: Clonate il repository della libreria di interfaccia Python per inotify. Assemblate il software e installatelo. belaran@976: hg clone http://hg.kublai.com/python/inotify belaran@976: cd inotify belaran@976: python setup.py build --force belaran@976: sudo python setup.py install --skip-build belaran@976: belaran@976: Clonate il repository Mercurial crew. Clonate il repository di patch per inotify in modo che Mercurial Queues sia in grado di applicare le patch alla vostra copia del repository crew. belaran@976: hg clone http://hg.intevation.org/mercurial/crew belaran@976: hg clone crew inotify belaran@976: hg clone http://hg.kublai.com/mercurial/patches/inotify inotify/.hg/patches belaran@976: belaran@976: Assicuratevi di aver abilitato mq, l’estensione Mercurial Queues. Se non avete mai usato MQ, leggete la per una rapida introduzione. belaran@976: belaran@976: Posizionatevi nel repository inotify e applicate tutte le patch per l’estensione inotify usando l’opzione del comando qpush. belaran@976: cd inotify belaran@976: hg qpush -a belaran@976: belaran@976: Se ottenete un messaggio di errore da qpush, dovreste fermarvi e chiedere aiuto. belaran@976: belaran@976: Assemblate e installate la versione modificata di Mercurial. belaran@976: python setup.py build --force belaran@976: sudo python setup.py install --skip-build belaran@976: belaran@976: belaran@976: Una volta che avete assemblato una versione adeguatamente modificata di Mercurial, tutto ciò che dovete fare per abilitare l’estensione inotify è aggiungere una voce al vostro file ~/.hgrc. belaran@976: [extensions] belaran@976: inotify = belaran@976: Quando l’estensione inotify è abilitata, Mercurial avvierà il demone in maniera automatica e trasparente la prima volta che invocherete un comando che ha bisogno di conoscere lo stato dei file nel repository. Mercurial esegue un demone di stato per ogni repository. belaran@976: belaran@976: Il demone di stato viene avviato silenziosamente ed eseguito in background. Se osservate la lista dei processi in esecuzione e invocate alcuni comandi in repository differenti dopo aver abilitato l’estensione inotify, vedrete alcuni processi hg in attesa di aggiornamenti dal kernel e di richieste da Mercurial. belaran@976: belaran@976: La prima volta che invocate un comando Mercurial in un repository dopo aver abilitato l’estensione inotify, il comando verrà eseguito con quasi le stesse prestazioni di un normale comando Mercurial. Questo accade perché il demone di stato deve effettuare una normale scansione di stato in modo da avere un rilevamento di base su cui applicare gli aggiornamenti successivi provenienti dal kernel. Tuttavia, ogni comando successivo che effettua qualunque tipo di controllo sullo stato dovrebbe essere visibilmente più veloce persino su repository di dimensioni abbastanza modeste. Ancora meglio, più grande è il vostro repository, più grande sarà il vantaggio che vedrete sulle prestazioni. Il demone inotify rende le operazioni di stato quasi istantanee su repository di tutte le dimensioni! belaran@976: belaran@976: Se preferite, potete avviare manualmente un demone di stato usando il comando inserve, che vi permette di controllare in maniera leggermente più accurata le modalità di esecuzione del demone. Naturalmente, questo comando sarà disponibile solo nel caso in cui l’estensione inotify sia abilitata. belaran@976: belaran@976: Quando state usando l’estensione inotify, non dovreste notare nessuna differenza nel comportamento di Mercurial, con la sola eccezione dei comandi relativi allo stato, che vengono eseguiti molto più velocemente di quanto accadeva di solito. Dovreste espressamente aspettarvi che i comandi non stampino messaggi differenti né restituiscano risultati differenti. Se una di queste situazioni si verifica, vi prego di segnalare il bug. belaran@976: belaran@976: belaran@976: belaran@976: Supporto flessibile per i diff con l’estensione <literal role="hg-ext">extdiff</literal> belaran@976: belaran@976: Il comando predefinito di Mercurial hg diff stampa il testo semplice di diff unificati. belaran@976: belaran@976: &interaction.extdiff.diff; belaran@976: belaran@976: Nel caso desideraste usare uno strumento esterno per visualizzare le modifiche, vorrete usare l’estensione extdiff, che vi permetterà di impiegare, per esempio, uno strumento di diff grafico. belaran@976: belaran@976: L’estensione extdiff è inclusa in Mercurial, quindi è facile da installare. Per abilitare l’estensione, vi basta aggiungere una voce di una riga nella sezione extensions del vostro file ~/.hgrc. belaran@976: [extensions] belaran@976: extdiff = belaran@976: Questa estensione introduce un comando chiamato extdiff, il cui comportamento predefinito è quello di usare il comando diff del vostro sistema per generare un diff unificato allo stesso modo del comando hg diff predefinito. belaran@976: belaran@976: &interaction.extdiff.extdiff; belaran@976: belaran@976: I risultati non saranno esattamente gli stessi ottenibili con le diverse versioni del comando predefinito hg diff, perché i risultati del comando diff variano da un sistema all’altro, persino quando gli vengono passate le stesse opzioni. belaran@976: belaran@976: Il comando extdiff funziona creando due fotografie del vostro albero sorgente. La prima fotografia è quella della revisione sorgente, la seconda è quella della revisione destinazione o della directory di lavoro. Il comando extdiff genera queste fotografie in una directory temporanea, passa il nome di ogni directory di fotografia a un visualizzatore di diff esterno, poi cancella la directory temporanea. Per lavorare in modo più efficiente, il comando fotografa solo le directory e i file che sono stati modificati tra le due revisioni. belaran@976: belaran@976: Il nome delle directory di fotografia è uguale al nome base del vostro repository. Se il percorso del vostro repository è /quux/bar/foo, allora foo sarà il nome di ognuna delle directory di fotografia. Nel caso sia appropriato, ogni nome di directory di fotografia termina con il proprio identificatore di changeset. Se la fotografia è quella della revisione a631aca1083f, la directory verrà chiamata foo.a631aca1083f. Una fotografia della directory di lavoro non terminerà con un identificatore di changeset, quindi in questo esempio il suo nome sarebbe semplicemente foo. Per vedere come questo appare in pratica, osservate ancora l’esempio di extdiff precedente. Notate che il diff contiene i nomi delle directory di fotografia nella propria intestazione. belaran@976: belaran@976: Il comando extdiff accetta due importanti opzioni. L’opzione vi permette di scegliere un programma diverso da diff con cui visualizzare le differenze. Con l’opzione , potete cambiare le opzioni che extdiff passa al programma (le opzioni predefinite sono -Npru, che hanno senso solo se state invocando diff). Sotto altri aspetti, il comando extdiff agisce in modo simile al comando predefinito hg diff: si usano gli stessi nomi di opzione, la stessa sintassi e gli stessi argomenti per specificare le revisioni che volete, i file che volete, e così via. belaran@976: belaran@976: Per esempio, ecco come invocare il normale comando diff di sistema per fargli generare diff contestuali (usando l’opzione ) invece di diff unificati e per fargli mostrare cinque righe di contesto invece delle tre predefinite (passandogli 5 come argomento per l’opzione ). belaran@976: belaran@976: &interaction.extdiff.extdiff-ctx; belaran@976: belaran@976: Lanciare uno strumento di diff visuale è altrettanto facile. Ecco come invocare il visualizzatore kdiff3. belaran@976: hg extdiff -p kdiff3 -o belaran@976: belaran@976: Se il comando che usate per visualizzare i diff non gestisce le directory, potete facilmente aggirare questo problema con un minimo di programmazione. Consultate la per vedere un esempio di un programma simile in azione con l’estensione mq e il comando interdiff. belaran@976: belaran@976: belaran@976: Definire alias per i comandi belaran@976: belaran@976: Potrebbe essere scomodo ricordare le opzioni sia per il comando extdiff che per il visualizzatore di diff che volete usare, quindi l’estensione extdiff vi permette di definire nuovi comandi che invocheranno il vostro visualizzatore di diff con le opzioni giuste. belaran@976: belaran@976: Tutto quello che dovete fare è modificare il vostro file ~/.hgrc aggiungendo una sezione chiamata extdiff dove potete definire vari comandi. Ecco come aggiungere un comando kdiff3. Una volta che lo avete definito, potete digitare hg kdiff3 e l’estensione extdiff lancerà kdiff3 per voi. belaran@976: [extdiff] belaran@976: cmd.kdiff3 = belaran@976: Se lasciate vuota la parte destra della definizione, come qui sopra, l’estensione extdiff usa il nome del comando che avete definito come il nome del programma esterno da usare. Ma questi nomi non devono necessariamente essere uguali. Qui di seguito definiamo un comando chiamato hg pippo che invoca kdiff3. belaran@976: [extdiff] belaran@976: cmd.pippo = kdiff3 belaran@976: belaran@976: Potete anche specificare le opzioni predefinite con cui volete invocare il vostro programma di visualizzazione di diff. Il prefisso da usare è opts., seguito dal nome del comando a cui applicare le opzioni. Questo esempio definisce un comando hg vimdiff che esegue l’estensione DirDiff dell’editor vim. belaran@976: [extdiff] belaran@976: cmd.vimdiff = vim belaran@976: opts.vimdiff = -f '+next' '+execute "DirDiff" argv(0) argv(1)' belaran@976: belaran@976: belaran@976: belaran@976: belaran@976: belaran@976: Inviare cambiamenti via email con l’estensione <literal role="hg-ext">patchbomb</literal> belaran@976: belaran@976: Molti progetti seguono una pratica di revisione dei cambiamenti in cui gli sviluppatori inviano le proprie modifiche a una mailing list in modo che altri possano leggerle e commentarle prima che la loro versione finale venga inserita in un repository condiviso. Alcuni progetti assegnano a qualcuno il ruolo del custode che applica le modifiche di altre persone a un repository a cui quelle persone non hanno accesso. belaran@976: belaran@976: Grazie alla sua estensione patchbomb, Mercurial facilita l’invio di email contenenti modifiche da rivedere o applicare. L’estensione è chiamata così perché le modifiche vengono inviate in forma di patch e solitamente viene inviato un singolo changeset per ogni messaggio email. Quindi, inviare una lunga serie di cambiamenti via email è molto simile a bombardare la casella del ricevente, da cui il nome patchbomb. belaran@976: belaran@976: Come al solito, la configurazione di base dell’estensione patchbomb occupa solo una o due righe del vostro file ~/.hgrc. belaran@976: [extensions] belaran@976: patchbomb = belaran@976: Una volta che avete abilitato l’estensione, avrete a disposizione un nuovo comando chiamato email. belaran@976: belaran@976: Il modo migliore e più sicuro di invocare il comando email è quello di eseguirlo sempre una prima volta con l’opzione . Questo vi mostrerà ciò che il comando invierebbe, senza in effetti inviare nulla. Una volta che avete dato una veloce occhiata ai cambiamenti e avete verificato di stare mandando quelli giusti, potete rieseguire lo stesso comando, questa volta senza l’opzione . belaran@976: belaran@976: Il comando email accetta lo stesso tipo di sintassi di revisione di tutti gli altri comandi Mercurial. Per esempio, questo comando invierà ogni revisione tra 7 e tip comprese. belaran@976: hg email -n 7:tip belaran@976: Potete anche specificare un repository con cui effettuare un confronto. Se fornite un repository senza indicare alcuna revisione, il comando email invierà tutte le revisioni del repository locale che non sono presenti nel repository remoto. Se in aggiunta specificate revisioni o il nome di un ramo (quest’ultimo usando l’opzione ), questo vincolerà le revisioni inviate. belaran@976: belaran@976: È assolutamente sicuro invocare il comando email senza i nomi delle persone a cui volete spedire un messaggio: se fate in questo modo, i destinatari vi verranno chiesti interattivamente. (Se state usando un sistema di tipo Unix o Linux, dovreste avere a disposizione le capacità avanzate di digitazione fornite da readline o librerie simili quando immettete quelle intestazioni, cosa che vi si rivelerà utile.) belaran@976: belaran@976: Quando state inviando una sola revisione, il comando email userà la prima riga della descrizione del changeset come oggetto predefinito del singolo messaggio email da spedire. belaran@976: belaran@976: Se inviate revisioni multiple, di solito il comando email spedirà un messaggio per ogni changeset. Farà precedere la serie da un messaggio introduttivo in cui dovreste descrivere lo scopo della serie di cambiamenti che state inviando. belaran@976: belaran@976: belaran@976: Modificare il comportamento di <literal role="hg-ext">patchbomb</literal> belaran@976: belaran@976: Non tutti i progetti hanno esattamente le stesse convenzioni per spedire cambiamenti via email, così l’estensione patchbomb prova a fornire un certo numero di variazioni attraverso le opzioni a riga di comando. belaran@976: belaran@976: Potete scrivere un oggetto per il messaggio introduttivo sulla riga di comando usando l’opzione . Questa opzione accetta come argomento il testo da usare per l’oggetto. belaran@976: belaran@976: Per cambiare l’indirizzo email da cui vengono spediti i messaggi usate l’opzione . Questa opzione accetta come argomento l’indirizzo email da usare. belaran@976: belaran@976: Il comportamento predefinito è quello di inviare diff unificati (leggete la per una descrizione del formato), uno per ogni messaggio. Potete invece usare l’opzione per inviare un bundle eseguibile. belaran@976: belaran@976: I diff unificati sono normalmente preceduti da un’intestazione di metadati. Potete ometterla e inviare diff disadorni con l’opzione . belaran@976: belaran@976: I diff vengono normalmente spediti in linea, nella stessa parte del corpo che contiene la descrizione della patch. Questo è il modo più facile per consentire al più ampio numero di lettori di rispondere citando parti di un diff, dato che alcuni client email citeranno soltanto la prima parte MIME del corpo di un messaggio. Se preferite inviare la descrizione e il diff in parti separate del corpo, usate l’opzione . belaran@976: belaran@976: Invece di spedire messaggi email, potete salvarli in una cartella email in formato mbox usando l’opzione . Questa opzione accetta come argomento il nome del file su cui scrivere. belaran@976: belaran@976: Se preferite aggiungere un riepilogo nel formato del comando diffstat a ogni patch e uno al messaggio introduttivo, usate l’opzione . Il comando diffstat mostra una tabella contenente il nome di ogni file coinvolto nella patch, il numero di righe modificate e un istogramma che illustra quante modifiche sono state apportate a ogni file. Questo riepilogo offre a chi legge una visione qualitativa della complessità di una patch. belaran@976: belaran@976: belaran@976: belaran@976: belaran@976: belaran@976: