JFritz CVS Howto

Aus JFritz
Wechseln zu: Navigation, Suche

JFritz verwendet kein CVS und kein Subversion mehr. Derzeit wird der aktuelle Code per GIT gepflegt. Bitte schreibt eine EMail an Support-EMail.png, wenn ihr den aktuellen Sourcecode haben wollt.

Inhaltsverzeichnis

Einführung

JFritz CVS ist der aktuellste Codestand von JFritz, an dem die Entwickler ständig weiterbasteln. Diese Codebasis ist höchst experimentell und enthält mit 100%er Sicherheit jede Menge Bugs. JFritz CVS ändert sich dazu tagtäglich, d.h. was heute in JFritz CVS funktioniert hat, dürfte morgen in JFritz CVS nicht mehr funktionieren. Die einzige Forderung an den Code, der in das CVS eingecheckt wird, ist, dass der Code sich sauber kompilieren lässt. Damit ich mich hier ganz klar ausdrücke, JFritz CVS sollte nur von denjenigen verwendet werden, die uns beim Testen und bei der Bugsuche helfen wollen.

Voraussetzungen

Man sollte auf jeden Fall(!) gute Kenntnisse in Sachen JFritz haben. Außerdem sollte JFritz CVS niemals in Umgebungen eingesetzt werden, die Stabilität verlangen. Bevor wir hier überhaupt los legen, solltet ihr jetzt unbedingt eine Sicherung von dem JFritz-Verzeichnis und dem Datenverzeichnis, und diese dann gut verstecken. JFritz CVS kann eure Daten fressen, seid gewarnt!

Jetzt kommen wir zur Sache. Das einzige Programm, das hierfür nötig ist, ist ein Java-JDK 1.6, was hier runtergeladen werden kann: http://java.sun.com

Windowsnutzer, die das Java JDK im Paket mit Netbeans 5.0 nutzen, können den integrierten CVS Support nutzen. Netbeans 7.0 Deutsch mit JDK 1.6 (Netbeans unterstützt mittlerweile auch Linux und MacOS)

Alle anderen bräuchten ein separates CVS-Tool (Linux und Mac haben eins per Default installiert). Dafür empfehle ich WinCVS, der kostenlos runtergeladen werden kann: http://www.wincvs.org

Code aus CVS Runterladen

Windows

Windowsbenutzer mit WinCVS entnehmen bitte der Dokumentation wie man Code aus CVS runterlädt. Netbeans-Nutzer wählen nach dem Start CVS in der Menüleiste an, dann Checkout und folgen den Anweisungen. Die nötigen Parameter sind:

CVS Root: :pserver:anonymous@jfritz.cvs.sourceforge.net:/cvsroot/jfritz
Passwort: <leer>
Modul: jfritz

Das Angebot aus den heruntergeladenen Quellen ein IDE-Projekt zu erstellen sollte man annehmen. Dazu wählt man Java Project with existing Ant Script und muss abschliessend noch das jfritz-Directory angeben, in das die Dateien entpackt wurde. Build-Script und Projekt-Name werden automatisch eingetragen. Weitere Optionen müssen nicht angegeben werden.

Linux/Mac

Der erste Schritt ist ein Terminal aufzumachen. Im Terminal solltet ihr zu einem Verzeichnis wechseln, in dem ihr die JFritz Quellcode abspeichern möchtet. Bei mir wird dieses Verzeichnis "/home/brian/CVS" sein. Jetzt solltet ihr den folgenden Befehl eingeben:

brian@battlebot CVS$ cvs -d:pserver:anonymous@jfritz.cvs.sourceforge.net:/cvsroot/jfritz login
Logging in to :pserver:anonymous@jfritz.cvs.sourceforge.net:2401/cvsroot/jfritz
CVS password: 

Für das Passwort drückt einfach auf Enter. Wenn es keinen Fehler gegeben hat, dann könntet ihr den nächsten Befehl ausführen:

brian@battlebot CVS$ cvs -z3 -d:pserver:anonymous@jfritz.cvs.sourceforge.net:/cvsroot/jfritz co -P jfritz
cvs checkout: Updating jfritz
U jfritz/.classpath
U jfritz/.cvsignore
U jfritz/.project
U jfritz/build.xml

...

cvs checkout: Updating jfritz/tests/de/moonflower/jfritz/testsuites/utils/reverselookup
U jfritz/tests/de/moonflower/jfritz/testsuites/utils/reverselookup/All_Utils_Reverselookup_Tests.java
U jfritz/tests/de/moonflower/jfritz/testsuites/utils/reverselookup/ReverseLookupTest.java


Falls die Ausgaben ähnlich wie meine aussehen, dann habt es geschafft, JFritz von CVS runterzuladen.

Kompilieren

Windows

Windowsnutzer mit Netbeans sollten das File build.xml jetzt im Projekt-Fenster angeboten bekommen. Nach einem Klick mit der rechten Maustaste auf dieses File wählt man Run Target -> Build. Als Ergebnis erhält man ein Unterdirectory ant/dist, das die fertigen jar-Files enthält.

Windowsnutzer ohne Netbeans sollten analog der Beschreibung für Linux/Mac vorgeben.

Das File jfritz.jar lässt sich dann durch einen Doppelklick starten.

Linux/Mac

Dieser Abschnit ist sehr einfach. Ihr solltet jetzt einen Unterzeichnis jfritz haben. Dieses Verzeichnis sollte folgende Unterordner haben:

brian@battlebot jfritz$ ls
CVS             lang            number          tests
build.xml       lib             src

Um JFritz zu kompilieren, gebt auf der Kommandozeile (im verzeichnis jfritz) den Befehl ein:

brian@battlebot jfritz$ ant
Buildfile: build.xml

init:
     [echo] ant version:   Apache Ant version 1.6.2 compiled on March 20 2005
     [echo] java version:  1.5

     [echo]    ---------------------------------------------------------------
     [echo]    project home:  ant
     [echo]    project build:   ant/build
     [echo]    project source: src
     [echo]    ---------------------------------------------------------------

     [echo] Building JFritz...

compile:
    [mkdir] Created dir: /Users/brian/CVS/jfritz/ant/build
    [mkdir] Created dir: /Users/brian/CVS/jfritz/ant/build/classes
    [javac] Compiling 195 source files to /Users/brian/CVS/jfritz/ant/build/classes
    [javac] Note: /Users/brian/CVS/jfritz/src/de/moonflower/jfritz/utils/ImportOutlookContacts.java uses or overrides a deprecated API.
    [javac] Note: Recompile with -Xlint:deprecation for details.
    [javac] Note: Some input files use unchecked or unsafe operations.
    [javac] Note: Recompile with -Xlint:unchecked for details.

jar:
     [copy] Copying 72 files to /Users/brian/CVS/jfritz/ant/build/classes/de/moonflower/jfritz/resources
      [jar] Building jar: /Users/brian/CVS/jfritz/ant/build/other.jar
      [jar] Building jar: /Users/brian/CVS/jfritz/ant/build/jfritz.jar
      [jar] Building jar: /Users/brian/CVS/jfritz/ant/build/fritzbox.jar
      [jar] Building jar: /Users/brian/CVS/jfritz/ant/build/reverselookup.jar

build:
    [mkdir] Created dir: /Users/brian/CVS/jfritz/ant/dist
     [copy] Copying 39 files to /Users/brian/CVS/jfritz/ant/dist/lib
     [copy] Copying 1 file to /Users/brian/CVS/jfritz/ant/dist
     [copy] Copying 246 files to /Users/brian/CVS/jfritz/ant/dist/lang
     [copy] Copying 4 files to /Users/brian/CVS/jfritz/ant/dist

BUILD SUCCESSFUL
Total time: 22 seconds

Jetzt solltet ihr einen lauffähigen Version von JFritz im Unterzeichnis ant/dist. JFritz kann jetzt ausgeführt werden mit dem Befehl:

brian@battlebot jfritz$ java -jar ant/dist/jfritz.jar -v
JFritz v0.6.2 (c) 2005 by Arno Willig <akw@thinkwiki.org>
(17:50:36) DEBUG: debugging mode has been enabled
...

Eclipse

Dieser Abschnitt ist sowohl für Windows- als auch Linux / Mac benutzer, die mit eclipse arbeiten wollen. Falls ihr etwas am Code verändern wollt, empfehle ich euch drigend mit Eclipse zu arbeiten. Das macht unser Leben und auch euer Leben leichter. Wie ihr Patches zu uns schickt, werde ich im nächsten Abschnitt beschreiben.

Zunächst solltet ihr auf jeden Fall Eclipse >= 3.1 installiert haben. Als erstes machen wir die CVS-Repository von JFritz verfügbar. Macht dazu die CVS-View auf (Windows / Views / CVS View). Im CVS-View Fenster rechtsklicken, und im Untermenü New -> Repository Location auswählen. Jetzt sollte die Add CVS Repository Location im Vordergrund kommen. Ihr solltet die Felder wie unten beschrieben ausfüllen:

  • Host: jfritz.cvs.sourceforge.net
  • Path to Repository: /cvsroot/jfritz
  • User: anonymous
  • Passord:
  • Connection Type: pserver

Und abschließend auf Finish klicken. Wenn alles geklappt hat, solltet ihr in diesem View einen Ordner JFritz sehen.

Jetzt wollen wir den Code auschecken. Macht dazu die Java-View auf (Window / Views / Java). Im Workspace Fenster rechtsklicken und im Menü Import... auswählen. Im Importfenster wähle From CVS Repository -> JFritz. Im nächsten Fenster wähle jfritz als Module Name aus. Auf ok drücken und der JFritz code sollte automatisch ins Workspace importiert werden.

Um Jfritz zu kompilieren könnt ihr dann auf die Datei build.xml rechtsklicken und run -> as ant build auswählen. Um Jfritz zu starten müsst ihr wie im vorherigen Abschnitt vorgehen.

Bei JFritz mitmachen

Wenn ihr bei JFritz mitmachen wollt, dann freuen wir uns natürlich auch. Am besten setzt ihr euch mit uns über die Mailingliste in Verbindung. Wir bitten euch aber nur um eines: Wenn ihr etwas am Code verändert haben und es zum offiziellen Quellcode-Repository eingecheckt haben möchtet, bitte nur Patches an uns schicken, die mit dem Eclipse diff-tool (Team -> Create Patch) erstellt wurden. Dadurch müssen wir nicht extra Zeit verschwenden, um zu sehen, was ihr alles verändert habt. [bearbeiten] Fehler! Was tun?

Ich fange damit an, was ihr nicht tun solltet. Bitte auf keinen Fall Bugs von JFritz CVS ins Forum posten oder auf die Sourceforge Projektseite. Diese Seiten sind ausschließlich für Bugs mit offiziellen Versionen. Bugs von CVS solltet ihr ausschließlich in die Entwickler-Maillingliste posten, damit wir das klar trennen können. Auch bitte immer angeben, an welchem Tag ihr JFritz CVS runtergeladen habt.