Subversion Repositories SvarDOS

Paketdateien bieten eine einfache Möglichkeit, Software unter SvarDOS zu

verwalten. Diese Pakete müssen sich an eine strenge Konvention halten, damit

sie vom SvarDOS-Paketmanager richtig behandelt werden können.

%hDateinamen von Paketen

Die Namen der Pakete müssen einigen Grundregeln entsprechen. Sie sollen max. 8

Buchstaben lang sein (sollten aber auch nicht zu kurz sein, da ein Paketname

mit 1 oder 2 Buchstaben verwirrend sein könnte) und dürfen nicht aus anderen

Zeichen als a-b, 0-9 und '_' bestehen. Dies geschieht aus Gründen der

Abwärtskompatibilität mit kurzen Dateinamen (8+3) und ISO 9660-Dateisystemen

(auf CD-ROMs verwendet). Auf den Dateinamen des Pakets folgt immer die

Erweiterung .SVP ("SvarDOS Package").

%hPaketdateien

SvarDOS verwendet ZIP-Dateien als Paketdateiformat. Dieses Format wurde

gewählt, weil ZIP-Dateien unter DOS de facto zum Standardformat für die

Verteilung von Dateisammlungen geworden sind. Außerdem ist das ZIP-Dateiformat

gut dokumentiert, wird gut unterstützt und ist Public Domain.

Nachfolgend finden Sie die empfohlene Befehlszeile, mit der Sie ein Paket für

ein Programm namens BEISPIEL mit info-zip erstellen können:

  zip -9rkDX BEISPIEL.SVP untverz1 untverz2 ... untverzN

Wenn Sie 7za verwenden, um Ihre Pakete zu erstellen, dann verwenden Sie dies:

  7za a -mm=deflate -mx=9 -tzip BEISPIEL.SVP untverz1 untverz2 ... untverzN

%hVerzeichnisstruktur für Pakete

Die Verzeichnisstruktur eines Pakets hängt von der Art des Pakets ab.

Für Kernpakete haben wir dies:

  APPINFO            Legen Sie die LSM-Datei des Programms hier ab

  BIN                Binärdateien, wie z. B. exe- und com-Dateien

  DOC\PKGNAME        Dokumentation zum Paket

  HELP               Wird NUR vom Paket "help" verwendet

  NLS\PKGNAME        Lokalisierungen (NLS-Sprachdateien) des Pakets

Nicht-Kernpakete verwenden eine etwas andere Verzeichnisstruktur. Wenn wir

zum Beispiel ein Paket FOO betrachten, könnten wir die folgende Struktur

erhalten:

  APPINFO\FOO.LSM    Paket-Metadatei für das Programm FOO

  PROGS\FOO\FOO.EXE  Die ausführbare Datei des Programms

  PROGS\FOO\FOO.TXT  Eine Dokumentation

  PROGS\FOO\FILE.DAT Vom Programm FOO verwendete Datendatei

Beachten Sie das Verzeichnis PROGS oben. Dies ist die Kategorie, zu der das

Paket gehört. Der Paketinstaller kann dieses Verzeichnis bei der Installation

anpassen, je nach den Präferenzen des Benutzers. Mögliche Kategorien sind

unten aufgeführt:

Kategorie | Beschreibung

DEVEL     | Entwicklungswerkzeuge (hauptsächlich Compiler)

DRIVERS   | Treiber

GAMES     | Spiele

PROGS     | Anwendungen, Hilfsprogramme...

Hinweis: Die Verzeichnisse "DOC", "NLS", "BIN" und "HELP" sind ausschließlich

         den Kernpaketen vorbehalten.

%hLSM-Metadaten-Dateien

Jedes Paket MUSS eine LSM-Datei in seinem "APPINFO"-Verzeichnis enthalten.

Diese LSM-Datei ist eine Textdatei, die grundlegende Informationen über das

Paket enthält. Ihr Format ist sehr einfach, sie muss mindestens zwei Zeilen

enthalten:

  version: x.y.z

  description: Beschreibung des Pakets

Alle anderen Zeilen werden vom SvarDOS-Paketmanager ignoriert.

%hPaketversionen

Die in der LSM-Datei enthaltene Version soll die Version der Software

widerspiegeln, aber es kann vorkommen, dass ein Paket geändert werden muss, um

um ein rein paketbezogenes Problem zu beheben (zum Beispiel eine vergessene

Dokumentationsdatei oder eine Neukompilierung der Binärdatei unter Verwendung

eines besseren Satzes von Flags...). In einem solchen Fall ändert sich die

Version der Software nicht, aber die Version des Pakets selbst muss sich

ändern, damit die Benutzer wissen, dass sich etwas geändert hat. Das ist der

Punkt, wo "SvarDOS-Revisionen" ins Spiel kommen. Eine Versionszeichenkette hat

im Wesentlichen folgendes Format:

  UPSTREAM_VER[+SVARREV]

UPSTREAM_VER ist die genaue Versionsbezeichnung, die von der Software selbst

angegeben wird. Sie kann so ziemlich alles sein. Dieser Upstream-Version kann

optional ein Pluszeichen und die SvarDOS-Revision folgen. Falls die Upstream-

Version bereits ein Pluszeichen enthält, wird die SvarDOS-Revision mit einer

Tilde abgeteilt.

Die SvarDOS-Revision beginnt bei 0 und wird jedes Mal um 1 erhöht, wenn die

gegebene Upstream-Revision neu paketiert wird. Die SvarDOS-Revision wird bei

jeder Änderung der Upstream-Version neu gestartet. Die SvarDOS-Revision 0 ist

immer versteckt.

Beispiele:

FDISK 1.54      <- ursprünglich paketierte Version

FDISK 1.54+1    <- Paket wurde geändert, aber nicht die Upstream-Version

FDISK 1.55      <- Upstream-Version erhöhte sich, so dass SvarDOS neu startet

FDISK 1.55+1    <- neue Version des Pakets, enthält aber immer noch FDISK 1.55

FDISK 1.55+2    <- eine weitere neue Version des Pakets, usw.

The entire version string of a package must never exceed 16 characters.

%hDer Quellcode

When a packaged software has its sources available, then it is recommended to

archive also them. To that effect, put the sources into a ZIP archive that has

the same filename as the package, but a *.ZIP extension (as opposed to the

*.SVP extension of the proper package). The result would be that the packaged

software would be distributed within two files. Example for FDISK:

FDISK.SVP       <- binaries (ZIP archive following the SVP structure)

FDISK.ZIP       <- sources (flat, unstructured ZIP archive)

The ZIP file must obviously contain the source code that belongs to the exact

same version present in the SVP package.