Inhalt

2. Gute Projekt- und Archivnamens-Praxis

So wie das Uploaden auf Software-Archive wie Metalab, das PSA- und CAPN-Archiv immer mehr zunimmt, gibt es einen fortschreitenden Trend, diese Archivierung ganz oder teilweise automatisch durch Programme erledigen zu lassen (anstatt allein von Menschen).

Deshalb wird es immer wichtiger, daß die Namen der Projekte und der Dateinamen dieser Archive korrekten Vorschriften entsprechen, so daß sie von Computerprogrammen erkannt und verstanden werden können.

2.1 Benutzen Sie Namen im GNU-Stil mit einem Namensstamm und einer major.minor.patch-Nummerierung!

Es ist allgemein hilfreich, wenn die Dateinamen Ihres Projektes den GNU-Namenskonventionen entsprechen - der Namensstamm zu Beginn (ausschließlich kleinen Buchstaben und Zahlen), gefolgt von einem Gedankenstrich, dieser gefolgt von einer Versionsnummer, danach Erweiterungen und sonstige Zusätze.

Nehmen wir mal an, Sie haben ein Projekt namens `foobar' in der Version 1, Release 2, Level 3. Falls Sie daraus nur ein einziges Archiv bilden (vermutlich mit dem Quellcode), so sehen Sie im Folgenden, wie die Namen aussehen sollten.

foobar-1.2.3.tar.gz

Das ist das Archiv mit dem Quellcode.

foobar.lsm

Die LSM Datei (sofern Sie sich an Metalab wenden).

Aber bitte nicht so:

foobar123.tar.gz

Für viele Archivierungsprogramme wirkt das wie ein Software-Archiv namens `foobar123' ohne eine Versionsnummer.

foobar1.2.3.tar.gz

Für viele Programme erscheint das wie ein Projekt mit dem Namen `foobar1' in der Version 2.3.

foobar-v1.2.3.tar.gz

Viele Verwaltungsprogramme glauben ein Projekt namens `foobar-v1' vor sich zu haben.

foo_bar-1.2.3.tar.gz

Der Unterstrich im Namen ist für viele Leute schwer auszusprechen, zu schreiben und zu merken.

FooBar-1.2.3.tar.gz

Zu vermeiden, es sei denn Sie wollen wie ein Marketing-Zwerg erscheinen. Auch diese Form ist schwer zu sprechen, zu schreiben und zu merken.

Wenn Sie zwischen Quellcode- und Binär-Archiven zu unterscheiden haben, oder gar zwischen mehreren Binär-Archiven, oder im Dateinamen unterschiedliche Arten der Installation ausdrücken wollen, dann benutzen Sie dazu eine Namenserweiterung hinter der Versionsnummer. Das sollte dann etwa so aussehen:

foobar-1.2.3.src.tar.gz

das Archiv mit den Quellen

foobar-1.2.3.bin.tar.gz

Binärdateien ohne Spezifizierung

foobar-1.2.3.bin.ELF.tar.gz

Binärdateien im ELF-Format

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

Binärdateien im ELF-Format, statisch gelinkt

foobar-1.2.3.bin.SPARC.tar.gz

Binärdateien für SPARC-Maschinen

Bitte benutzen Sie keinesfalls Namen wie `foobar-ELF-1.2.3.tar.gz', denn Programme tun sich schwer, Typbezeichnungen (wie `ELF') vom Namensstamm zu unterscheiden.

Ein nützliches Schema für einen Namen umfaßt diese Teile in der angegebenen Reihenfolge:

  1. Stammname des Projekts
  2. Gedankenstrich
  3. Versionsnummer
  4. Punkt
  5. "src" oder "bin" (optional)
  6. Punkt oder Gedankenstrich (Punkt bevorzugt)
  7. Binärtyp und sonstige Optionen (optional)
  8. Archivierungs- und Datenkompressions-Erweiterungen im Namen

2.2 Beachten Sie ausnahmsweise spezielle Konventionen!

Einige Projekte und Entwickler-Gemeinschaften haben genau definierte Konventionen für Namen und Versionsnummern, die nicht notwendigerweise mit den eben ausgeführten Ratschlägen übereinstimmen. Beispielsweise liegen Module von Apache generell in der Namensform mod_foo vor und haben sowohl pro Modul eine eigene Versionsnummer als auch für die Version von Apache selbst, zu der sie gehören. Ähnlich haben Module von Perl-Programmen Versionsnummern, die als Gleitpunktzahlen betrachtet werden können (so werden sie eher 1.303 finden als 1.3.3), und die Distributionen werden üblicherweise Foo-Bar-1.303.tar.gz genannt (für Version 1.303 des Moduls Foo::Bar.

Schauen Sie, ob es für bestimmte Communities und Entwickler spezielle Namens-Konventionen gibt, und halten Sie diese ein. Ansonsten aber folgen Sie bitte den obigen Richtlinien.

2.3 Bemühen Sie sich um einen unverwechselbaren und leicht zu schreibenden Namen!

Der Namensstamm am Anfang sollte bei allen Projektdateien gleich sein, und er sollte einfach zu lesen, zu schreiben und zu merken sein. Deshalb benutzen Sie bitte keine Unterstriche. Und verwenden Sie keine großen Buchstaben am Anfang oder auch im Namen ohne wirklich guten Grund -- das bringt die dem Menschen vertraute Suchfolge des Auges durcheinander und sieht nach einem Marketing-Zwerg aus, der versucht, schlau zu sein.

Es verwirrt die Leute, wenn zwei verschiedene Projekte denselben Namensstamm haben. Versuchen Sie deshalb Kollisionen vor Ihrer ersten Veröffentlichung festzustellen. Ein geeigneter Ort, um dies zu überprüfen, ist der index file of Metalab


Inhalt