Page suivantePage pr�c�denteTable des mati�res

2. R�gles d'usage pour l'appellation de votre projet et de votre archive

Au fur et � mesure que s'accro�t la charge de travail des gestionnaires d'archives comme Metalab, le site PSA ou le CPAN, les soumissions sont de plus en plus souvent trait�es, en tout ou en partie, par des programmes (et non en totalit� par des humains).

Il est donc tr�s important que le nom de votre projet et celui de votre fichier d'archive suivent des r�gles pr�cises, afin que des programmes informatiques puissent les analyser et les comprendre.

2.1 Utilisez le style d'appellation GNU, avec un pr�fixe suivi d'un num�ro du type majeur.mineur.patch.

Vous faciliterez la vie � tout le monde en donnant � vos archives des noms dans le style GNU : un pr�fixe-racine alphanum�rique tout en minuscules, suivi par un tiret, puis un num�ro de version, une extension et d'autres suffixes.

Supposons que vous ayez un projet nomm� "toto", qui en est � la version 1, mise � jour 2, niveau 3. S'il est compos� d'une seule archive (sans doute le code source), voici � quoi devrait ressembler son nom :

toto-1.2.3.tar.gz

L'archive des sources

toto.lsm

Le fichier LSM (si vous l'envoyez � Metalab).

N'utilisez pas les noms suivants :

toto123.tar.gz

Beaucoup de programmes croiront qu'il s'agit du fichier d'archive d'un projet nomm� `toto123', sans num�ro de version.

toto1.2.3.tar.gz

Beaucoup de programmes croiront qu'il s'agit de l'archive d'un projet nomm� `toto1' � la version 2.3.

toto-v1.2.3.tar.gz

Beaucoup de programmes prendront cela pour un projet nomm� `toto-v1'.

to_to-1.2.3.tar.gz

Le caract�re soulign� est difficile � prononcer, � taper, et � retenir.

ToTo-1.2.3.tar.gz

A moins que vous vouliez vraiment ressembler � un accroc du marketing. L� encore, c'est difficile � prononcer, � taper et � retenir.

Si vous voulez faire s�par�ment une archive de sources et une archive de binaires, ou diff�rentes archives de binaires, ou encore indiquer un certain type d'option de fabrication dans le nom de l'archive, rajoutez pour cela une extension apr�s le num�ro de version. Voici quelques exemples :

toto-1.2.3.src.tar.gz

sources

toto-1.2.3.bin.tar.gz

binaires, type non sp�cifi�

toto-1.2.3.bin.ELF.tar.gz

binaires ELF

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

binaires ELF li�s statiquement

toto-1.2.3.bin.SPARC.tar.gz

binaires pour SPARC

N'utilisez pas des noms comme `toto-ELF.1.2.3.tar.gz', car les programmes ont beaucoup de mal � s�parer un infixe (tel que `ELF') de la racine du mot.

Un bon sch�ma d'appellation g�n�rique contient, dans l'ordre, les parties suivantes :

  1. pr�fixe du projet
  2. tiret
  3. num�ro de version
  4. point
  5. "src" ou "bin" (optionnel)
  6. point ou tiret (un point de pr�f�rence)
  7. type de binaire et options (optionnel)
  8. extensions relatives au mode d'archivage et de compression

2.2 Mais respectez le cas �ch�ant les conventions locales

Certains projets ou communaut�s ont des conventions bien �tablies pour les noms et les num�ros de version, et ces conventions ne sont pas toujours compatibles avec les conseils qui pr�c�dent. Par exemple, les modules Apache ont en g�n�ral des noms du genre mod_foo, et ils ont � la fois un num�ro de version propre et le num�ro de la version d'Apache avec laquelle ils fonctionnent. De m�me, les num�ros de version des modules Perl peuvent �tre trait�s comme des nombres d�cimaux (par exemple, vous pouvez voir 1.303 � la place de 1.3.3), et les distributions s'appellent en g�n�ral Foo-Bar-1.303.tar.gz pour la version 1.303 du module Foo::Bar.

Apprenez et respectez les conventions des communaut�s et d�veloppeurs sp�cialis�s ; suivez les r�gles d�crites ci-dessus dans le cas g�n�ral.

2.3 Choisissez avec le plus grand soin un pr�fixe unique et facile � taper

Le pr�fixe-racine devrait �tre le m�me pour tous les fichiers d'un projet, et il devrait �tre facile � lire, � taper et � retenir. N'utilisez pas le caract�re "soulign�". Et ne mettez pas de majuscules ou de MajusculesInt�rieures sans une tr�s bonne raison -- cela d�range le trajet naturel de l'oeil humain, et vous aurez l'air de faire du marketing.

C'est difficile de s'y retrouver lorsque deux projets ont le m�me nom. Assurez-vous donc, dans la mesure du possible, qu'il n'y a pas de conflit de noms avant de publier votre premi�re version. Deux bons endroits pour v�rifier ceci sont l'index de Metalab et l'index des applications (appindex) � Freshmeat. Un autre endroit recommand� est SourceForge, en effectuant une recherche par nom.


Page suivantePage pr�c�denteTable des mati�res

Hosting by: Hurra Communications GmbH
Generated: 2007-01-26 18:01:16