1 Themenübersicht
Über das Tool „chkout“ können Dateien aus der Repository-Datenbank im Dateisystem abgelegt werden.
2 Zielgruppe
- Entwickler
- System-Administratoren.
3 Beschreibung
Das Tool „chkout“ beinhaltet drei wesentliche Funktionalitäten:
- Dateien aus dem Repository im Dateisystem abzulegen,
- Java-Klassen und Java-Quellen aus Dateisystem mit dem Repository zu vergleichen und
- Java-Klassen ins Repository zurück zu schreiben.
Folgende Dateien können aus dem Repository ins Dateisystem geschrieben werden:
- Java-Klassen,
- Java-Quellen,
- Icons,
- Dateiobjekte,
Zudem können auch Java-Klassen aus dem Dateisystem in das Repository geschrieben werden, dazu müssen die Java-Sourcen ausgecheckt und kompiliert werden. Die kompilierten Java-Klassen werden anschließend ins Repository zurück geschrieben. Beim Einchecken muss zusätzlich das Java-Quellverzeichnis angegeben werden, in diesem wird geprüft, ob die Java-Quellen zwischenzeitlich geändert wurden. Diese Java-Quellen werden nicht zurück geschrieben. Diese Funktionalität ist nützlich, um einen Stand einmal komplett zu kompilieren und die Ergebnisse in das Repository zu schreiben. Bevor ein Release freigegeben wird, wird das Tool „chkout“ angewendet.
3.1 Befehl
Nachfolgend finden Sie den Befehl inklusive aller möglichen Parameter.
| chkout | [-compare:<text>] [-checkout:<text>]
[-p:<str-1> … -p:<str-n>] [-r] [-sources] [-classes] [-files] [-icons] [-onlinehelp] [-systemCode] [-applicationCode] [-sourceType:<int>] [-readOnly] [-overwrite] [-filedate] [-verbose] [-chkinclasses] [-sourcepath:<string>] [-classpath:<string>] [-namespace:<string>] [-objectname:<string>] [-helpsources] [-helpfiles] |
3.2 Parameter
Die Parameter des Befehls werden in der folgenden Tabelle erläutert. Die in eckigen Klammern gesetzten Parameter sind optional, die anderen hingegen sind Pflichtparameter. Für einige Parameter kann ein Stern (*) als Platzhalter angegeben werden, um damit alle möglichen Werte ausgeben zu können.
Nicht alle Parameter können mehrfach genannt werden, nur die, die folgenden Zusatz an den Parametervariablen aufweisen, sind für die Mehrfachnennung zugelassen: „<str-1> … <str–n>“.
| Parameter | Erläuterung |
| [-checkout:<text>] | Schreibt die Dateien, die ausgecheckt werden sollen, in ein Verzeichnis oder ein Java-Archiv (*.jar). Falls das Verzeichnis nicht existiert wird ein Java-Archiv angelegt. Ein vorhandenes Java-Archiv kann auch direkt als Ziel angegeben werden.
Diese Option kann nicht in Verbindung mit |
| [-compare:<text>] | Vergleicht die Java-Klassen und/oder Java-Quellen aus dem angegebenen Verzeichnis mit der aktiven Version im Repository.
Diese Option kann nicht in Verbindung mit [-check |
| [-p:<str-1> … -p:<str-n>] | Einschränkung auf den Namensraum des Entwicklungsobjekts.
Kann mit den Optionen [-checkout:<string>], [-compare:<string>] und [-chkinclasses] verwendet werden. |
| [-r] | Wenn ein Namensraum angegeben ist (Option -[-p:<str-1> … -p:<str-n>]), werden alle drunter liegenden Namensräume berücksichtigt. |
| [-sources] | Java-Quellen (zu verwenden mit der Option -[-checkout:<string>] oder [-compare: <string>]) verwenden. |
| [-classes] | Java-Klassen (zu verwenden mit der Option -[-checkout:<string>] oder [-compare:<string>]) |
| [-files] | Dateien (zu verwenden mit der Option -[-check out:<string>]) |
| [-icons] | Icons (zu verwenden mit der Option -[-check out:<string>]) |
| [-onlinehelp] | Hilfedateien (zu verwenden mit der Option-[-check out:<string>]) |
| [-systemCode] | Es werden nur System-Entwicklungsobjektbereich betrachtet.
Hinweis: |
| [-applicationCode] | Es werden nur Objekte aus dem Anwendungsbereich betrachtet. |
| [-sourceType:<int>] | Beschränkung der Java-Klasse auf ihre Entstehung:
· 1 = Durch Benutzer angelegt · 2 = Generierung (Mehrsprachigkeit) · 3 = Generierung (UpdateInfo) · 4 = Generierung (TimeDependent) · 5 = Generierung (Managing-System) · 6 = Generierung (OQL-View) · 7 = Generierung (Business Object) · 8 = Generierung (Suche) · 9 = Generierung (Valueset) · 10 = Generierung (Part) · 11 = Generierung (OQL-Statement) |
| [-readOnly] | Die Dateien werden schreibgeschützt abgelegt. |
| [-overwrite] | Bestehende Dateien im angegebenen Verzeichnis werden überschrieben. Wird diese Option nicht angegeben und bestehende Datei müsste überschrieben werden, bricht das Tool ab. |
| [-fileDate] | Option zurzeit nicht unterstützt. |
| [-verbose] | Ausgabe auf der Komandozeile. |
| [-chkinclasses] | Schreibt die Java-Klassen aus dem Dateisystem in das Repository. Diese Option darf nur verwendet werden, wenn in dem System nicht entwickelt wird.
Kann mit den Optionen [-checkout:<string>] und [-compare:<string>] verwendet werden. |
| [-sourcepath: <string>] |
Verzeichnis, in dem sich die Java-Quellen befinden. Diese werden benötigt, um Veränderungen festzustellen. Ist eine Java-Quelle zwischenzeitlich geändert worden, so werden die zugehörigen Java-Klassen nicht in das Repository eingecheckt.
Diese Option kann nur mit [-chkinclasses] verwendet werden. |
| [-classpath: <string>] |
Verzeichnis, in dem sich die Java-Klassen befinden, die in das Repository eingecheckt werden.
Diese Option kann nur mit [-chkinclasses] verwendet werden. |
| [-namespace:<string>] | Einschränkung auf einen Namensraum beim Einchecken der Java-Klassen. Diese Option kann nur mit [-chkinclasses] verwendet werden. Die Option -r wird nicht unterstützt. |
| [-objectname: <string>] |
Einchecken der angegebenen Java-Klasse. Diese Option kann nur mit [-chkinclasses] verwendet werden. |
| [-helpsources] | Auschecken der Hilfe-Quellen. Diese Option muss mit [-checkout] [-onlinehelp] verwendet werden. |
| [-helpfiles] | Auschecken der Hilfe-Dateien. Diese Option muss mit [-checkout] und [-onlinehelp] verwendet werden. |
3.3 Beispiele zur Verwendung von chkout
Java-Quellen auschecken:
chkout -checkout:<pfad> -p:com.cisag.app.internal -sources
Java-Sourcen auschecken:
chkout -checkout:<pfad> -p:com.cisag.app.internal -classes
Datei-Objekte auschecken:
chkout -checkout:<pfad> -p:com.cisag.app.internal -files
Hilfe-Objekte auschecken:
chkout -checkout:<pfad> -p:com.cisag.app.help -r -onlinehelp -helpsources
Vergleich:
chkout -compare:<pfad> -p:com.cisag.app.internal -sources -verbose
Einchecken:
chkout -chkinclasses -sourcepath:<pfad> -classpath:<pfad> -namespace:com.cisag.app.internal –verbose