2. Buone regole per dare un nome a un progetto e a un archivio

Poiché il carico sui distributori di archivi, come Sunsite, il sito del PSA e CPAN, è in aumento, si tende sempre più a far processare le proposte da valutare in parte o completamente da dei programmi (piuttosto che interamente da una persona).

Questo rende più importante, per un progetto o un nome di un archivio, adattare bene i nomi a modelli regolari che il programma possa analizzare e capire.

2.1 Usare nomi nello stile GNU, con una radice e numerazione delle patch primarie.secondarie

È bene che tutti i file dell'archivio abbiano nomi sullo stile GNU: radice prefissante in caratteri tutti minuscoli, seguiti da un trattino, dal numero della versione, dall'estensione, e da altri suffissi.

Supponiamo che si abbia un progetto di nome `foobar', alla versione 1, release 2, livello 3. Se si tratta di un solo archivio (presumibilmente i sorgenti), ecco come dovrebbero essere i nomi:

foobar-1.2.3.tar.gz

L'archivio dei sorgenti

foobar.lsm

Il file LSM (assumendo che si sia sottoposti a Sunsite).

per favore non usare:

foobar123.tar.gz

Questo sembrerà a molti programmi un archivio di un progetto chiamato `foobar123' senza numero della versione.

foobar1.2.3.tar.gz

Questo sembrerà a molti programmi un archivio di un progetto chiamato `foobar1' nella versione 2.3.

foobar-v1.2.3.tar.gz

Molti programmi lo interpreterebbero come un progetto chiamato `foobar-v1'.

foo_bar-1.2.3.tar.gz

La sottolineatura è difficile da leggere, scrivere e ricordare

FooBar-1.2.3.tar.gz

A meno che non si voglia assomigliare ad una mezza cartuccia del marketing. Inoltre è difficile da leggere, scrivere, e ricordare.

Se si deve distinguere tra archivi di sorgenti e di binari, o tra tipi diversi di binari, o esprimere alcuni tipi di opzioni nel nome del file, si è pregati di considerarle come un' estensione del file e metterle dopo il numero della versione. Cioè, è meglio scrivere:

foobar-1.2.3.src.tar.gz

sorgenti

foobar-1.2.3.bin.tar.gz

binari, di tipo non precisato

foobar-1.2.3.bin.ELF.tar.gz

binari di tipo ELF

foobar-1.2.3.bin.ELF.static.tar.gz

binari ELF linkati staticamente

foobar-1.2.3.bin.SPARC.tar.gz

binari SPARC

Si è pregati di non usare nomi come `foobar-ELF-1.2.3.tar.gz', perché i programmi hanno difficoltà a distingure i suffissi (come `-ELF') dalla radice del nome.

Un buon modello generale per un nome è costituito, nell'ordine, da:

1. prefisso del progetto
2. trattino
3. numero della versione
4. punto
5. "src" o "bin" (facoltativo)
6. punto o trattino (meglio un punto)
7. tipologia del binario e opzioni (facoltativo)
8. estensioni dell'archivio e del tipo di compressione

2.2 Scegliere con accuratezza un nome per il prefisso che sia unico e facile da digitare

La radice prefissante dovrebbe essere comune a tutti i file di un progetto, facile da leggere, scrivere e ricordare. Si è pregati quindi di non usare sottolineature. Ugualmente non usare caratteri maiuscoli e maiuscoletti senza una buona ragione -- confondono l'ordine di ricerca dell'occhio umano e ricordano una mezza cartuccia del marketing che voglia fare l'intelligente.

Crea inoltre confusione il fatto che due progetti diversi hanno lo stesso nome. Si cerchi così di controllare eventuali conflitti prima di rilasciare la propria nuova release. Un buon luogo dove controllare è costituito dal file di indice di Sunsite http://sunsite.unc.edu/pub/Linux.

Hosting by: hurra.com
Generated: 2007-01-26 17:56:18