Quellcode mit Git holen

1.  Einleitung

Git ist ein Versionierungssystem, das die parallele Arbeit mehrerer Entwickler am Quellcode vereinfacht. Weitere Informationen über Git und/oder Anleitungen, wie Sie das Programm installieren können, erhalten Sie hier.

Einzelheiten zum Gebrauch mit LyX (besonders relevant, wenn Sie an der Entwicklung mitarbeiten wollen) finden Sie auf unseren Wiki-Seiten.

Einige wenige Teile von LyX wurden noch nicht auf Git portiert und werden statt dessen über das alternative Versionierungssystem Subversion (SVN) gepflegt, welches früher für die gesamte LyX-Entwicklung eingesetzt wurde. Hier (und weiter unten) finden Sie mehr Informationen dazu.

2.  Das GIT-Repositorium für LyX

lyxgit
Dieses Repositorium (so nennt man die zentrale Speichereinheit eines Versionierungssystems, das die Daten und Änderungen bereithält) enthält den LyX-Quellcode. Die Entwicklung zukünftiger Haupt-Versionen findet im master-Zweig statt, und die Unter-Versionen (Wartungs-Veröffentlichungen) werden in Zweigen wie 2.0.2 vorbereitet. Die zukünftige stabile Version befindet sich zur Zeit im neuesten 2.0.x-Zweig. Aus alter Gewohnheit nennen wir den master-Zweig trunk (Stamm) und den Wartungszweig einfach branch (Zweig).

Sie müssen Projektplan anklicken, um zu dem Zweig zu gelangen, den Sie ansehen wollen.

3.  Der Quellbrowser Trac

Mit Git können Sie ein ganzes Repositorium mit nur einem Befehl herunterladen. Wenn Sie sich nur eine Git-Datei ansehen wollen, sollten Sie den Quellbrowser Trac benutzen. Trac ist ein Werkzeug, mit dem Sie unter anderem ein Git-Repositorium durchstöbern und Unterschiede zwischen zwei Versionen ansehen als auch Log-Dateien und Ähnliches lesen können

Der Quellbrowser Trac für das Git-Repositorium (und das ältere SVN) von LyX befindet sich auf der Homepage von LyX. Aber wahrscheinlich wollen Sie ein Git-Repositorium herunterladen. Also weiter.

4.  Anonyme Git-Kopie

In einem Terminal geben Sie in dem Verzeichnis, das Ihre lokale Kopie des Quellcodes enthalten soll, folgendes ein:

 git clone git://git.lyx.org/lyx [Name]

Dieser Befehl erstellt das Verzeichnis Name und lädt viele Dateien dort hinein. Wenn Sie Name weglassen, wird das Verzeichnis lyx benutzt. Für Name empfiehlt sich lyx-devel. (Eine frische Kopie benötigt ca. 300 MB, aber nach dem Kompilieren sind es ca. 1,2 GB.)

Mit

 git checkout 2.0.x

innerhalb des lyx-Verzeichnisses gelangen Sie zum Wartungszweig.

5.  Nach dem ersten Download

Wenn Sie im Name-Verzeichnis

 git pull

eingeben, werden geänderte Dateien aktualisiert und neue hinzugefügt. Damit sparen Sie viel Zeit.

Wenn Sie nur wissen wollen, was sich in Ihrer lokalen Kopie gegenüber dem entfernten Repositorium geändert hat, geben Sie

 git status

ein.


6.  Die Quellen kompilieren

Wenn Sie die Entwicklungsversion kompilieren und ausführen wollen, wird es etwas komplizierter, weil Sie die Pakete automake, autoconf und gettext (oder alternativ cmake) benötigen.

Unter Linux müssen Sie nur die Anweisung in INSTALL (oder INSTALL.cmake, wenn Sie cmake bevorzugen) befolgen. Das bedeutet, nacheinander

./autogen.sh
./configure [Optionen]
make
sudo make install

auszuführen. Als Option empfiehlt sich --with-version-suffix=-devel, damit die Entwicklungsversion mit sudo make install nach /usr/local/bin/lyx-devel installiert wird und nicht ein vorhandenes /usr/local/bin/lyx überschreibt.

Für andere Betriebssysteme müssen Sie die Anweisungen in INSTALL.Win32 oder MacOSX befolgen.


7.  Den Quellcode ändern

Wir unterstützen jede kreative Idee, die Sie haben. Fehlerkorrekturen, Dokumentation und neue Funktionen werden immer sorgfältig geprüft und meistens akzeptiert, mit ein paar Ausnahmen. Neue Funktionen werden selten in eine stabile Version übernommen.

Wenn Sie LyX ändern wollen, wird es leichter für die anderen, wenn Sie die neueste Git-Version statt der letzten stabilen Version benutzen. Dies sollten Sie berücksichtigen:

  • Holen Sie die neueste Version mit git pull. Eine Änderung an alten Quellen ist viel schwerer anzuwenden und wird wahrscheinlich ignoriert werden.
  • Ändern Sie die Dateien.
  • Erzeugen Sie mit git diff > mypatch.diff eine Korrektur.
  • Schicken Sie die Korrektur an die LyX-Entwickler Mailing-Liste.

8.  Schreibzugriff mit ssh

Wenn Sie viele Korrekturen gemacht haben, die das LyX-Team eingebaut hat, wird Ihnen wahrscheinlich Schreibzugriff auf Git gewährt. Das wird Ihre Arbeit noch mehr erleichtern. Weitere Einzelheiten finden Sie auf unserer Git-Wiki-Seite.

Der Nicht-Wiki-Inhalt der LyX-Homepage (z. B. Nachrichten und Ankündigungen) sowie Wörterbücher und Thesauri werden weiterhin mittels Subversion statt Git gepflegt.

9.  Git-Zweige

Die Hauptentwicklung von LyX findet in Git-Zweigen (branches) statt. Wenn Sie bei der Entwicklung oder beim Testen dieser Zweige helfen wollen, können Sie sich eine Kopie bspw. mit

 git checkout 2.0.x

oder

 git checkout master

aus bereits geklonten Repositorien holen.

Dies sind die derzeit aktiv gepfelgten Zweige:

ZweigameHerausgeberBetreuerStatusBemerkung
master (trunk)VF Ravesteijn instabilHauptzweig (nächste Hauptversion 2.1)
Zweig 2.0.xP SandaRG HeckstabilStabiler Zweig der Serie 2.0

Folgende älteren Zweige werden nicht mehr weitergepflegt:

ZweignameHerausgeberBetreuerStatusBemerkung
BRANCH_1_6_XJMatosJSpitzmstabilStabile 1.6-Serie
BRANCH_1_5_XJMatosJSpitzmstabilStabile 1.5-Serie
BRANCH_1_4_XLGBjønnesJMarcstabilStabile 1.4-Serie
BRANCH_1_3_X JMarcstabilStabile 1.3-Serie
BRANCH-1_2_XLGBjønnesJMarcstabilStabile 1.2-Serie
BRANCH_1_1_6 JMarcstabilStabilisierung von 1.1.6