Verwendung externer Versionskontrolle
Auf einen Blick
- Verstehen Sie die grundlegenden Unterschiede zwischen den Arbeitsabläufen mit Git- und SVN-Repositorys.
- Erfahren Sie, wo Sie in den Panels „Projects“ und „Storage Manager“ den Dateistatus anzeigen, auf die Versionshistorie zugreifen und Versionsverwaltungsaktionen ausführen können.
- Entdecken Sie, wie Funktionen zum Schaltplan- und Leiterplattenvergleich Teams bei der Arbeit an gemeinsamen Designs unterstützen.
Eine der größten Stärken einer elektronischen Erstellungs- und Bearbeitungsumgebung besteht darin, wie einfach sich Dateien erstellen und ändern lassen. Dadurch können Ideen schnell erfasst, untersucht und weiterentwickelt werden. Gleichzeitig kann es jedoch schwierig sein, Änderungen an wertvollen Dateien wie Quellcode und elektronischen Designdaten nachzuverfolgen.
Die Notwendigkeit, Änderungen an Dateien nachzuverfolgen und elektronisch erfasste Quelldaten systematisch zu verwalten, hat zur Entwicklung von Versionskontrollsystemen (VCS) geführt. Versionskontrollsysteme sind Softwarewerkzeuge, die nicht nur den Verlauf der verschiedenen Versionen einer Datei verwalten können, sondern auch das Öffnen beliebiger Revisionen dieser Datei sowie den Vergleich der Änderungen zwischen zwei beliebigen Dateiversionen unterstützen. Ein VCS integriert sich in der Regel in das lokale Betriebssystem (OS), indem es zusätzliche Versionierungsfunktionen und -aktionen für Ordner und Dateien bereitstellt.
Versionskontrollsysteme lassen sich völlig unabhängig von der Erstellungs- und Bearbeitungsumgebung betreiben, mit der eine Datei erstellt wurde. Sie bieten in der Regel eine Oberfläche, über die Sie Dateien zunächst hinzufügen (Add) und anschließend in einen zentralen Speicherbereich, das sogenannte Repository, einchecken (Commit) können. Hinzu kommen eine Checkout-Funktion zum Kopieren einer Datei aus dem Repository in einen Arbeitsordner, eine Commit-Funktion zum Zurückschreiben von Änderungen in das Repository, eine Möglichkeit zum Protokollieren von Informationen zu einer Änderung und vieles mehr.
Diese Funktionen finden sich in Windows-Shell-Erweiterungen wie dem Tortoise-Client und sind auch in Altium Designer selbst enthalten. VCS-Aktionen können innerhalb der Altium Designer-Umgebung ausgeführt werden, ohne auf das Dateisystem des Betriebssystems zugreifen zu müssen.
Es ist hilfreich, die im Zusammenhang mit Versionskontrollsystemen verwendete Terminologie zu kennen. Obwohl zahlreiche Systeme verfügbar sind, verwenden sie im Allgemeinen ähnliche Begriffe zur Beschreibung ihrer Funktionen.
Grundlagen der Versionskontrolle
Altium Designer unterstützt die Versionskontrollsysteme (VCS) Subversion (SVN) und Git. Dank der integrierten Unterstützung dieser Systeme stehen gängige SVN/Git-Befehle zur Dateiverwaltung wie Commit, Update usw. direkt in Altium Designer zur Verfügung. Hinzu kommen weitere Subversion-Funktionen, beispielsweise das Erstellen eines SVN-Repositorys. Diese Funktionen sind mit den Vergleichsfunktionen für Schaltpläne und Leiterplatten integriert. So lassen sich Unterschiede zwischen zwei Revisionen eines Schaltplan- oder Leiterplattendokuments schnell vergleichen und erkennen sowie bei Leiterplattendesigns Konflikte durch gleichzeitige Änderungen auflösen.
Die grundlegende Vorgehensweise bei der Arbeit mit einem Versionskontrollsystem (VCS) besteht darin, eine Kopie der zu bearbeitenden Projektdateien aus einem Repository abzurufen, die Dateien in Altium Designer zu bearbeiten und die geänderten Dateien anschließend wieder in das Repository einzuchecken („Commit“). Die Interaktion mit dem Repository erfolgt über eine Schnittstelle zur Versionskontrolle, die Altium Designer in sein Storage Manager-Panel und sein Projects-Panel integriert hat.
Entscheidend für die Funktionsweise eines Versionskontrollsystems ist, dass es den Status der Dateien überwacht, die über einen Arbeitsordner aus dem Repository abgerufen wurden. So verfolgt es nach, welche Revision bearbeitet wird und ob sie geändert wurde. Obwohl das Ergebnis dasselbe ist, unterscheiden sich die Anordnung von Repository und Arbeitsdateien je nach Versionskontrollsystem – Git oder SVN.
Git-VCS
Die folgende Abbildung veranschaulicht das Konzept eines freigegebenen Remote-Git-Repositorys, das eine Folge von Revisionen der Designdateien enthält (bis Revision 5). Dessen Inhalt wurde in ein lokales Git-Arbeitsrepository kopiert – in der Regel durch Klonen des Remote-Repositorys oder durch Abrufen seiner Daten in das Arbeitsrepository mittels Pull. Wenn die Dateien im Arbeitsrepository in der Altium Designer-Umgebung geöffnet werden, erkennt Altium Designer, dass eine Projektdatei unter Git-Versionskontrolle steht. Ihr aktueller Versionskontrollstatus wird sowohl im Storage Manager- als auch im Projects-Panel angezeigt.
► Weitere Informationen finden Sie auf der Seite Git-basierte Versionskontrolle.
Subversion-VCS
Die folgende Abbildung veranschaulicht das Konzept eines Subversion-Repositorys, das eine Folge von Revisionen der Designdateien enthält (bis Revision 5), wobei die neueste Kopie in einen Arbeitsordner ausgecheckt wurde (File » Check Out). Wenn die Dateien im Arbeitsordner in der Altium Designer-Umgebung geöffnet werden, erkennt Altium Designer, dass eine Projektdatei unter SVN-Versionskontrolle steht. Ihr aktueller Versionskontrollstatus wird sowohl im Storage Manager- als auch im Projects-Panel angezeigt.
► Weitere Informationen finden Sie auf der Seite SVN-basierte Versionskontrolle.
Bei beiden oben genannten VCS-Systemen ist die Verknüpfung zwischen dem Quellrepository und dem Arbeitsverzeichnis in der VCS-Datenbank des Arbeitsverzeichnisses hinterlegt (im Systemunterordner .svn oder .git).
Wenn VCS-Arbeitsdateien in Altium Designer geöffnet sind, können Sie über das Kontextmenü im Storage Manager-Panel (und im Projects-Panel) standardmäßige VCS-Aktionen ausführen, beispielsweise eine geänderte Datei in das zentrale Repository (SVN) oder das Arbeitsrepository (Git) einchecken.
Zugriff auf die Versionskontrolle
In Altium Designer können VCS-bezogene Aktionen über die Panels Projects und Storage Manager ausgeführt werden. Letzteres bietet direkten Zugriff auf zusätzliche VCS-Befehle und -Informationen. Beim Öffnen von Projektdokumenten in Altium Designer werden diese zusammen mit ihrem jeweiligen VCS-Status in den Panels angezeigt.
Die Panels können über das Menü der Schaltfläche
unten rechts im Arbeitsbereich oder über das Hauptmenü View » Panels geöffnet werden.
Projects-Panel
Das Projects-Panel zeigt alle aktuell in Altium Designer geöffneten Projekte zusammen mit den zugehörigen Dokumenten und dem jeweiligen Versionskontrollstatus jeder Datei an.
Der VCS-Dateistatus wird im Panel durch eine Reihe von Symbolen angezeigt, die sich auf bestimmte, vom Versionskontrollsystem erkannte Dateizustände beziehen. Der Status jeder Datei wird im Allgemeinen im Verhältnis zu ihrem versionsverwalteten Gegenstück im verknüpften Repository bestimmt. Die VCS-Befehle im Panel Projects sind über die Option Version Control im Rechtsklick-Kontextmenü des Panels zugänglich.
Symbole der Versionskontrolle, wie sie im Panel Projects angezeigt werden
► Weitere Informationen finden Sie auf der Seite Projects-Panel.
Storage Manager-Panel
Das Panel Storage Manager bietet eine umfassende Ansicht des aktiven Dokuments aus Sicht der Dateispeicherung sowie Zugriff auf den lokalen Dokumentverlauf und den Status bzw. die Befehle der Versionskontrolle.
Der VCS-Dateistatus wird im Panel durch eine Reihe von Beschreibungen und zugehörigen Symbolen angezeigt, die sich auf bestimmte, vom Versionskontrollsystem erkannte Dateizustände beziehen. Der Status jeder Datei wird im Allgemeinen im Verhältnis zu ihrem versionsverwalteten Gegenstück im verknüpften Repository bestimmt.
Die VCS-Befehle im Panel Storage Manager sind über das Rechtsklick-Kontextmenü zugänglich. Um eine VCS-Aktion für eine bestimmte Datei auszuführen, klicken Sie mit der rechten Maustaste auf deren Eintrag im Panel und wählen Sie den gewünschten Befehl aus – beispielsweise „Commit“, „Update“, „Resolve conflict“ usw.
Der Revisionsverlauf und der lokale Dokumentverlauf der ausgewählten Datei werden im unteren Bereich des Panels angezeigt. Wenn Sie über die Rechtsklick-Optionen zur „klassischen Ansicht“ wechseln – Switch to Classic View –, wird stattdessen eine vollständige Zeitleiste der Ereignisse angezeigt. Die angezeigte Revisionsnummer wird mit jedem VCS-Commit erhöht, wobei die erste Revision (Revision 1) der Erstellung der VCS-Projektordner entspricht, bevor Dateien hinzugefügt wurden.
► Weitere Informationen finden Sie auf der Seite Storage Manager-Panel.
Status der Versionskontrolle
Sowohl im Panel Projects als auch im Panel Storage Manager wird der aktuelle VCS-Status jeder versionsverwalteten Datei zusammen mit ihrem Eintrag im Panel angezeigt.
Das Versionskontrollsystem überwacht im Wesentlichen die Dateien im Arbeitsordner und vergleicht sie mit ihren Gegenstücken im Design-Repository. Altium Designer fordert über seine VCS-Schnittstelle Informationen vom Versionskontrollsystem an, tauscht Informationen mit ihm aus und reagiert entsprechend auf die beim Vergleich ermittelten Dateizustände. In der Praxis zeigt sich dies an den Dateisymbolen in den Panels Projects und Storage Manager, an verschiedenen VCS-Hinweisen sowie an entsprechenden Änderungen der verfügbaren Dateiverwaltungsbefehle.
Die Symbole und ihre Bedeutung werden im Abschnitt Statussymbole der Versionskontrolle auf der Seite Projektdokumente verwalten beschrieben.
Mehrbenutzerzugriff
In den meisten Fällen basiert die Versionskontrollinfrastruktur eines Unternehmens auf zentralen SVN- oder Git-Repositories, die über das Netzwerk mit einem der verfügbaren Protokolle bereitgestellt werden – svn, svn+ssh, https usw. Dies ermöglicht allen Benutzern im Netzwerk entsprechend ihren Berechtigungen den Zugriff und bietet eine Grundlage für die gemeinsame Projektentwicklung auf Basis einer einzigen Quelle.
Die Möglichkeiten des Mehrbenutzerzugriffs erlauben es verschiedenen Teammitgliedern wiederum, unabhängig an einem Projekt weiterzuarbeiten, ohne warten zu müssen, bis jemand anderes eine Datei wieder eingecheckt hat. Ein verteiltes Git-Versionskontrollsystem geht noch einen Schritt weiter: Dateien können während der Arbeit per Commit im lokalen Arbeits-Repository gespeichert und diese Änderungen zu einem beliebigen späteren Zeitpunkt in das zentrale Git-Repository übertragen („gepusht“) werden. Bis dahin ist keine Netzwerkverbindung erforderlich.
Dennoch muss ein für Teams geeignetes VCS Werkzeuge und Verfahren bereitstellen, um die unvermeidliche Situation zu lösen, in der zwei Benutzer dieselbe Datei geändert haben. Sind diese Funktionen vorhanden, ist die Grundlage für eine echte Zusammenarbeit mehrerer Benutzer am Design und die damit verbundenen Vorteile geschaffen.
Zur Unterstützung dieses Szenarios bietet Altium Designer Vergleichsfunktionen („Diff“) für Schaltpläne und Leiterplatten, die über das Storage Manager-Panel zugänglich sind.
VCS-Repositories
Die beste Möglichkeit, mit einem bekannten Satz von Quelldateien zu arbeiten, besteht darin, das Designprojekt in einer kontrollierten Umgebung zu speichern, beispielsweise in einem Versionskontroll-Repository. Dies ist wichtig, denn nur durch die folgenden Schritte lässt sich sicherstellen, dass die Ausgaben aus den richtigen Quelldateien erzeugt werden:
- Sicherstellen, dass der Quelldateisatz aktuell ist.
- Einen Snapshot dieser Dateien erstellen.
- Ausgaben aus diesem Snapshot erzeugen.
In Altium Designer wird ein solches Repository als Design Repository bezeichnet. Das Design-Repository liegt in der Verantwortung des Designteams, enthält eine detaillierte Historie des Designprozesses und ist das wichtigste Werkzeug für die Zusammenarbeit im Designteam.
Das Design-Repository wird zur zentralen Ablage, aus der mehrere Teammitglieder Daten auschecken und in die sie Daten einchecken können, während gleichzeitig ein vollständiger Revisionsverlauf aller am Design vorgenommenen Änderungen erhalten bleibt. Ein Design wird somit als eine Reihe von Versionen seiner zugehörigen Projekt- und Quelldokumente gespeichert. Dadurch entsteht im Laufe der Zeit ein immer vollständigeres Bild der Absichten des Entwicklers. Ein versionsverwaltetes Design-Repository bietet Ihnen die grundlegende Sicherheit, dass keine Revision eines Designs verloren geht. Dies ermöglicht die sichere Zusammenarbeit am selben Design zwischen Teammitgliedern, die sich an geografisch verteilten Standorten befinden können. Das Versionskontrollsystem stellt von sich aus einen Prüfpfad für das Design bereit. Die Transparenz darüber, wer was in welchem Quelldokument und zu welchem Zeitpunkt geändert hat, gewährleistet eine vollständige Nachvollziehbarkeit. Das System unterstützt mehrere versionsverwaltete Design-Repositories. Die Verknüpfung zu einem bestimmten Repository wird dabei durch die Versionskontrollverknüpfung innerhalb des Projektordners hergestellt.
Bevor Sie die Versionskontrolle verwenden, müssen die Projektdateien sowohl vom VCS als auch von Altium Designer als versionsverwaltet erkannt werden. Dieser Vorgang kann sich je nach VCS-Methode und Anwendung unterscheiden, umfasst aber im Wesentlichen das Erstellen eines Design-Repositories und/oder das Herstellen einer Verbindung damit sowie das Hinzufügen der Designprojektdateien zu diesem Repository.
Design-Repositories basieren auf einer Datenbankstruktur und speichern Informationen intern in einer Hierarchie aus Dateien und Verzeichnissen, die als Dateibaum bezeichnet wird. Bei dem Repository, mit dem Sie eine Verbindung herstellen, kann es sich um ein zentrales SVN-Repository, ein Git-Arbeits-Repository (das mit einem Remote-Git-Repository verknüpft ist) oder ein Repository handeln, das Sie an einem zugänglichen Speicherort erstellt haben, beispielsweise auf dem lokalen PC oder in einer Netzwerkfreigabe.
Neue Änderungen in die Versionsverwaltung übernehmen
Nachdem ein Projekt zur Versionsverwaltung hinzugefügt wurde, ist sein lokaler Arbeitsordner mit seinem Gegenstück im VCS-Repository verknüpft. Dies wird durch das Verknüpfungssymbol bei den Projektordnereinträgen im Bedienfeld Storage Manager angezeigt. Um die Speicherorte des verknüpften Ordners und des Repositorys zu überprüfen, klicken Sie mit der rechten Maustaste auf einen beliebigen Dateieintrag im Bedienfeld und wählen Sie die Option VCS Properties (bei Verwendung von Git nicht verfügbar). Der daraufhin angezeigte Dialog Properties enthält die Pfade der verknüpften Speicherorte sowie Informationen zur neuesten VCS-Revision.
Durch ein Verknüpfungssymbol gekennzeichnete Datei und das zugehörige Bedienfeld Properties mit Informationen zur neuesten VCS-Revision
Der Dialog Properties enthält die folgenden Informationen (diese dienen nur zur Ansicht; Änderungen sind nicht zulässig):
- Path - der Pfad zum lokalen Dokument in Ihrem Arbeitsordner.
- URL - die URL des Speicherorts des Dokuments im VCS-Repository.
- Repository Root - das Stammverzeichnis des Repositorys.
- Repository UUID - die UUID des Repositorys.
- Revision - die aktuelle Revision des Dokuments in Ihrem lokalen Arbeitsordner.
- Last Change Author - der Autor der letzten Änderung.
- Last Change Revision - die Revision der letzten Änderung.
- Last Change Time - Datum und Uhrzeit der letzten Änderung.
- Conflicted - ob für das Dokument ein Konflikt vorliegt.
Durch die registrierte VCS-Verknüpfung kann das Versionsverwaltungssystem Unterschiede zwischen Dateien im lokalen Projektordner und ihren Gegenstücken im VCS-Repository-Ordner überwachen und erkennen. Wenn ein Unterschied erkannt wird, etwa nachdem eine Designdatei in Altium Designer bearbeitet und gespeichert wurde, ändert das Versionsverwaltungssystem den Status der lokalen Datei in Modified , und Altium Designer stellt im Kontextmenü der Bedienfelder entsprechende VCS-Befehle bereit.
Änderungen committen
Nachdem eine Projektdokumentdatei in Altium Designer bearbeitet und gespeichert wurde, wird sie als Modified gekennzeichnet und sowohl im Bedienfeld Projects als auch im Bedienfeld Storage Manager entsprechend angezeigt Um diese Änderungen als neue Revision im VCS zu committen, klicken Sie mit der rechten Maustaste auf den Dateieintrag im Bedienfeld und wählen Sie den Befehl Commit im Kontextmenü oder den Befehl Project » History & Version Control » Commit in den Hauptmenüs.
Alternativ kann der Befehl Commit Whole Project verwendet werden, der alle geänderten Dateien im Projekt committet. Beim Committen des gesamten Projekts wird der Dialog Commit to Version Control geöffnet.

Der Dialog Commit to Version Control
Optionen und Bedienelemente des Dialogs „In die Versionsverwaltung committen“
Oberer Bereich
Im oberen Bereich werden alle Dateien des ausgewählten Projekts aufgelistet und es wird angezeigt, ob sie sich im VCS befinden. Außerdem werden weitere relevante Informationen aufgeführt, beispielsweise ob eine Datei zum Hinzufügen oder Löschen markiert ist. Der Entwickler kann die Dateien auswählen, die in die Versionsverwaltung committet werden sollen. Die Spalte Path zeigt den Pfad jeder Datei, die Spalte Status ihren aktuellen Status. Dieser Teil des Dialogs bietet außerdem ein kleines Kontextmenü mit den folgenden Optionen:
- Select All - Klicken Sie hier, um alle im Dialog aufgeführten Dateien auszuwählen. Ausgewählte Dateien werden zum VCS hinzugefügt.
- Select None - Klicken Sie hier, um die Auswahl aller im Dialog aufgeführten Dateien aufzuheben. Diese Dateien werden nicht zum VCS hinzugefügt.
- Select Project Documents - Klicken Sie hier, um nur Projektdokumente auszuwählen. Nur die ausgewählten Dateien werden zum VCS hinzugefügt.
Unterer Bereich
- Comment - In diesem Textfeld kann der Entwickler Kommentare eingeben, bevor die Dateien in die Versionsverwaltung committet werden.
- Commit and Push - Mit diesem Befehl werden Änderungen an der Arbeitskopie der ausgewählten Datei(en) (im Bereich „Files“ des Bedienfelds Storage Manager) in Ihr VCS-Repository eingecheckt und die Projektaktualisierungen auf den Server gepusht. Geänderte Dateien sind am Status Modified erkennbar.
- Commit - Über das Dropdown-Menü können Sie auf die Schaltfläche „Commit“ zugreifen. Damit werden Änderungen an der Arbeitskopie der ausgewählten Datei(en) (im Bereich „Files“ des Bedienfelds Storage Manager ) in Ihr VCS-Repository eingecheckt. Geänderte Dateien sind am Status Modified erkennbar.
-
When using Subversion (SVN): Beim Commit-Vorgang wird die aktualisierte Datei aus dem lokalen Ordner in das Repository kopiert. Dabei wird die Revisionsnummer des VCS-Eintrags erhöht und der Dateistatus auf
No Modificationzurückgesetzt. -
When using Git: Beim Commit-Vorgang wird das lokale VCS-Arbeitsrepository aktualisiert. Dabei wird die Revisionsnummer des Eintrags erhöht und der Dateistatus auf
Ahead of Servergesetzt. Sie können Dateien im Arbeitsrepository weiter bearbeiten, speichern und committen oder die neuen Änderungen mit dem Befehl Push übernehmen, um das Remote-Git-Repository zu aktualisieren. Der Dateistatus wird anschließend wieder aufNo Modificationgesetzt.
Öffnen Sie das Bedienfeld Storage Manager, um die Abfolge der Aktionen im Abschnitt VCS Revisions anzuzeigen. Dazu gehört auch die Erstellung einer neuen VCS-Revision (mit erhöhter Revisionsnummer) für diese Datei – in diesem Fall Revision 3 mit dem hinzugefügten Kommentar. Das Symbol
kennzeichnet die neueste und aktuelle Revision der ausgewählten Datei, in der Terminologie der Versionsverwaltung auch als Head-Revision bezeichnet.
Der Abschnitt „VCS Revisions“ des Storage Manager Panels
Für eine kombinierte Ansicht der Revisions- und Verlaufsereigniseinträge wechseln Sie zur einzelnen Timeline-Ansicht, indem Sie im Rechtsklick-Kontextmenü Switch to Combined View auswählen.
Aus der Versionsverwaltung auschecken
Wie oben beschrieben, kann ein lokales Projekt, das der Versionsverwaltung hinzugefügt wurde, in Altium Designer aus dem lokalen Projektordner heraus bearbeitet werden. Die Änderungen werden anschließend in das VCS-Repository übertragen. Der lokale Ordner und der Repository-Ordner sind miteinander verknüpft und werden durch das VCS synchronisiert.
Ein anderer Benutzer, der keinen Zugriff auf das Projekt in dessen Quellordner hat (da dieser lokal auf Ihrem PC liegt), kann mit „Clone“ (Git) oder „Check Out“ (SVN) eine eigene Kopie der Dateien aus dem VCS-Repository abrufen, in dem das Projekt gespeichert ist. Alle Benutzer, die gemeinsam am Projektentwurf arbeiten möchten, müssen eine Verbindung zu diesem gemeinsamen Design-Repository herstellen, das in der Regel über das lokale Netzwerk oder einen Server zugänglich ist.
Der ausgewählte Projektordner im Repository und die darin enthaltenen Dateien werden in den angegebenen lokalen Ordner ausgecheckt und in Altium Designer geöffnet. Beachten Sie, dass der lokale Ordner dem für das ausgewählte Repository definierten Checkout-Ordner entspricht und das ausgecheckte Projekt anschließend mit seinem Gegenstück im VCS-Repository verknüpft ist. Über die VCS-Verknüpfung überwacht das Versionsverwaltungssystem die Dateien und erkennt Unterschiede zwischen den Dateien im lokalen Checkout-Ordner und ihren Entsprechungen im VCS-Repository-Ordner.
Übertragen Sie mit „Commit“ die Änderungen, sobald die Dateibearbeitung abgeschlossen ist. Dadurch werden die Dateien im Design-Repository mit denen im Checkout-Ordner synchronisiert und eine neue VCS-Revision erstellt.
Auschecken oder Projekt öffnen
Wenn ein local-Projekt der Versionsverwaltung hinzugefügt wurde, gibt es tatsächlich zwei Möglichkeiten, es zu bearbeiten und im VCS zu aktualisieren:
-
Indem Sie das lokale Projekt (File » Open Project) in Altium Designer öffnen und anschließend die gespeicherten Änderungen in das VCS-Repository übertragen. In diesem Fall sind der lokale Projektordner und sein Gegenstück im Repository über das VCS verknüpft.
-
Indem Sie das Projekt (File » Check Out) aus dem VCS-Repository auschecken und anschließend die in Altium Designer vorgenommenen und gespeicherten Änderungen zurück in das Repository übertragen. In diesem Fall sind das Projekt im festgelegten Checkout-Ordner und sein Gegenstück im Repository über das VCS verknüpft.
Das lokale Projekt ist die Quelle bzw. der Ursprung des VCS-Projekts, das mit anderen Benutzern geteilt wird. Je nach bevorzugter Arbeitsweise kann diese lokale Quellversion entfernt oder als archivierte Projektquelle gesperrt werden. Weitere Bearbeitungen erfolgen dann über Check Out. Sie können die Projektdateien aber auch weiterhin aus dem lokalen „Quellordner“ öffnen und bearbeiten (Open Project).
Am besten bleiben Sie bei einer Methode (Auschecken wird empfohlen), da die beiden Optionen mit Arbeitsordnern an unterschiedlichen Speicherorten arbeiten – dem lokalen Quellprojektordner oder dem festgelegten VCS-Checkout-Ordner. Werden hingegen beide Methoden verwendet, befinden sich mehrere aktive Kopien desselben Projekts auf dem lokalen PC. Wenn diese Versionen jedoch nach jeder Bearbeitung konsequent per Commit in das zentrale VCS-Repository übertragen werden, enthält das Repository wie vorgesehen stets die neueste Revision des Projekts.
Beachten Sie außerdem, dass ein Projekt nach dem erstmaligen Auschecken aus dem VCS-Repository lokal vorhanden ist und direkt aus dem Checkout-Ordner erneut geöffnet werden kann (File » Open Project). In diesem Fall besteht wiederum die Wahl, ein Projekt aus dem VCS auszuchecken oder die lokale Version zu öffnen. Es gibt jedoch immer nur eine lokale Kopie. Aus praktischer VCS-Sicht sind die beiden Methoden sehr ähnlich, verhalten sich aber unter bestimmten Umständen unterschiedlich – etwa wenn eine lokale Datei fehlt: Beim Auschecken wird sie wiederhergestellt, während sie durch einen Open Project-Befehl aus dem Projekt entfernt wird.
Revisionen in der Versionsverwaltung
Bei der Arbeit mit Designdokumenten in Altium Designer, die der Versionsverwaltung unterliegen, entsprechen die aus dem zentralen (gemeinsamen) VCS-Repository abgerufenen Designdateien der jeweils neuesten Revision dieser Dateien. Sobald die lokalen Änderungen abgeschlossen und per Commit (bzw. bei Git per Push) zurück in das gemeinsame VCS-Repository übertragen wurden, werden diese Dateiversionen zu den neuesten Revisionen.
Die übliche Abfolge aus Auschecken, Bearbeiten, Speichern und Commit (sowie Push bei Git) fügt dem zentralen VCS somit im Verlauf der Projektentwicklung fortlaufend neue Dateirevisionen hinzu. Wenn jedoch mehrere Entwickler gemeinsam an einem Projekt arbeiten, können jederzeit von jedem Entwickler neue Revisionen in das zentrale (gemeinsame) Repository übertragen werden.
Veraltete Revision
Das Zusammenspiel zwischen mehreren Entwicklern und dem zentralen Repository kann sich auf verschiedene Weise bemerkbar machen. Beispielsweise kann ein lokal geöffnetes Projekt nicht mehr der neuesten Revision entsprechen: Ein aus dem Repository ausgechecktes oder aus dem lokalen Arbeitsordner geöffnetes Projekt hat dann im Projects-Panel den Status Out of date
Als veraltet gekennzeichnete Datei
In diesem Fall hat ein anderer Benutzer dasselbe Projekt bearbeitet und in das Repository übertragen, seit es zuletzt lokal bearbeitet wurde. Beispielsweise arbeitet der lokale Benutzer Barry am Projekt und hat etwa Revision 14 per Commit übertragen. Ein anderer Benutzer Harold hat jedoch danach Revision 15 übertragen, wie im unten gezeigten Storage Manager-Panel zu sehen ist. Da das VCS den Unterschied zwischen einer Datei im lokalen Arbeitsordner und ihrem Gegenstück im Repository erkennt (das in diesem Fall neuer ist), stuft das System die neueste local-Revision (gekennzeichnet durch das Symbol als veraltet ein.
Unterschiedliche Revisionsstände im Storage Manager
Diese Situation lässt sich beheben, indem Sie die lokalen Dateien mit dem Befehl Update aus dem Rechtsklick-Kontextmenü des Projects- oder Storage Manager-Panels auf den Stand im zentralen VCS-Repository bringen. Die beiden Dateiversionen sind dann synchronisiert, wobei die lokale Version (für Benutzer Barry) auf die neueste Revision aktualisiert wird – in diesem Beispiel Revision 15. Beachten Sie, dass ein Save für eine als Out of date gekennzeichnete Datei zu einer VCS-Conflict-Situation führt, da das VCS erkennt, dass eine ältere Revision einer Datei im Arbeitsordner aktualisiert wurde.
Das zentrale Repository und die lokale Revision im Storage Manager
Sie können auch den Befehl Update Whole Project auswählen, um den Dialog Update from Version Control zu öffnen, in dem Sie Dateien zum Auschecken aus einem gemeinsamen Repository auswählen können. Alle Dokumente im Projekt, die veraltet sind oder Konflikte enthalten, werden im Dialog angezeigt. Sie können bestimmte Dokumente zum Aktualisieren auswählen oder alle auf einmal aktualisieren. Die ausgewählten Dokumente werden aus dem Repository aktualisiert; standardmäßig sind alle veralteten Dokumente ausgewählt. Alle ausgewählten Dokumente werden auf die neueste Version im Repository aktualisiert.

Der Dialog Update from Version Control
Die Spalte Path zeigt das Dateiverzeichnis an. Die Status Spalte zeigt den aktuellen Status der Datei an. Wenn der Status einer Datei als Conflict angezeigt wird, öffnet sich beim Klicken auf OK zum Aktualisieren der Dateien ein Bestätigungsdialog. Klicken Sie auf OK, um auf die neueste Version im Repository zu aktualisieren, oder auf Cancel, um den Vorgang zu beenden und die Änderungen an der derzeit im Repository vorhandenen Version zu speichern.
Revisionskonflikt
Durch die Interaktion mehrerer Entwickler mit dem zentralen Repository kann auch eine Situation entstehen, in der dieselbe Datei von zwei Altium Designer-Benutzern lokal bearbeitet und gespeichert wurde und einer von ihnen diese Änderungen eingecheckt hat.
Das bedeutet, dass sich die Arbeitsschritte eines Entwicklers (Auschecken, Bearbeiten, Speichern, Einchecken) mit denen eines anderen Entwicklers überschnitten haben. Daher wird eine Datei, die ein Benutzer zur Bearbeitung aus dem Repository ausgecheckt hat, während der Bearbeitung möglicherweise nicht mehr als neueste Revision remain – ein anderer Benutzer hat die Revision zwischenzeitlich aktualisiert. Wer in diesem Fall seine Änderungen zuerst in das Repository eincheckt, erstellt die maßgebliche neue Revision. Ein anderer Benutzer, der dieselbe Datei bearbeitet und gespeichert hat, steht dagegen vor einer Conflict-Situation, die durch das Symbol
angezeigt wird.
Beispiel für einen Revisionskonflikt
Aus Sicht eines VCS, das die Dateien im Arbeitsordner mit den Dateien im Repository vergleicht, liegt ein Konflikt vor, wenn eine veraltete Revision einer Datei im Arbeitsordner bearbeitet und gespeichert wurde.
Git-VCS-Revisionen im Panel Storage Manager
Für Dateien mit dem Status Conflict stehen mehrere Befehlsoptionen zur Verfügung. Sie sind über das History & Version Control-Kontextmenü des Panels Projects, das Project » History & Version Control-Hauptmenü und das Panel Storage Manager zugänglich:
-
Commit – Diese Option löst einen Subversion-Fehler aus, da das Einchecken der lokal bearbeiteten Revision (beispielsweise
Revision 15) die neuere Revision (Revision 16) überschreiben würde, die bereits von einem anderen Benutzer eingecheckt wurde. -
Update – Diese Option aktualisiert die lokale Dateirevision auf die neueste Version aus dem zentralen Repository (
Revision 16). Dabei gehen alle lokalen Änderungen verloren, die Sie anRevision 15vorgenommen haben. -
Resolve Conflict – Diese Option verwirft Änderungen, die seit Ihrer letzten Aktualisierung in das Repository eingecheckt wurden. Nach dem Aufrufen des Befehls erscheint ein Bestätigungsdialog – klicken Sie auf Yes, um fortzufahren. Die Projektdatei in Ihrem Arbeitsordner wird auf die neueste Revision aktualisiert, die der andere Benutzer in das Repository eingecheckt hat. Der Editor behält jedoch die Änderungen bei, die Sie an der vorherigen Revision vorgenommen haben. Die lokale Datei erhält somit den Status Modified. Dadurch können Sie diese Änderungen mit dem Befehl Commit oder dem Befehl Commit Whole Project als neue Revision in das Repository einchecken. Sobald Sie die Projektdatei eingecheckt haben, wird dem anderen Benutzer für die Datei(en) der Status Out of date angezeigt, da Sie eine neuere Revision im Repository erstellt haben.
Diese Option wird nur bei einem Konflikt in einer text-Datei empfohlen, da das Subversion-System versucht, die Unterschiede in der lokalen Datei zusammenzuführen. Dieser Vorgang kann andere Dateitypen, beispielsweise Designdokumente, beschädigen. Daher sollte ein Konflikt vorzugsweise durch Aktualisieren auf die neueste Quellrevision oder durch Zurücksetzen der lokalen Änderungen behoben werden.
-
Revert – Diese Option verwirft die lokalen Änderungen (macht sie rückgängig) und setzt die lokale Datei auf ihre Basisrevision zurück – hier
Revision 15. Der Revisionskonflikt ist damit behoben, die Datei wird jedoch anschließend alsOut of dategekennzeichnet, da im Repository eine neuere Revision (Revision 16) vorhanden ist.
Revisionen vergleichen
Ein wertvolles Hilfsmittel bei der Arbeit mit der Versionskontrolle ist die Möglichkeit, frühere Revisionen von Designdateien zu vergleichen. Diese Funktion bietet der integrierte Differenzkomparator von Altium Designer, der über das Panel Storage Manager aufgerufen wird. In Verbindung mit dem Panel Differences können VCS-Revisionen logisch oder grafisch verglichen und die betroffenen Objekte dabei interaktiv untersucht werden. Sowohl Schaltplan- als auch PCB-Revisionen lassen sich vergleichen.
► Weitere Informationen zum Navigieren zwischen Unterschieden finden Sie auf der Seite zum Differences-Panel.
Um einen Vergleich zwischen zwei Revisionen zu starten, wählen Sie beide Einträge (mit der üblichen Methode Ctrl+click) in der Liste VCS Revisions des Panels Storage Manager aus. Wählen Sie anschließend den Befehl Compare aus dem Kontextmenü des Panels.
Der Befehl Compare im Panel Storage Manager
Beide Dateirevisionen werden nebeneinander geöffnet, sodass sie visuell verglichen werden können. Welche Unterschiede angezeigt werden, hängt von den Optionen ab, die für die physischen Vergleichstypen auf der Registerkarte „Comparator“ des Dialogs Options for Project ausgewählt wurden – Project » Project Options.
Das zentrale Hilfsmittel zum Auffinden und Anzeigen der Vergleichsunterschiede ist das Panel Differences. Es enthält eine auswählbare Liste der logischen oder grafischen Unterschiede zwischen den Dokumenten. Die für jede Dokumentrevision aufgeführten Einträge im Panel interagieren mit dem Editor, sodass ein erkannter Unterschied (beispielsweise ein verschobenes Objekt) bei Auswahl grafisch hervorgehoben wird.
Auffinden und Anzeigen der Vergleichsunterschiede im Panel Differences
Die Vergleichsfunktion steht neben Revisionen von Schaltplan- und textbasierten Dokumenten auch für Revisionen von PCB-Dokumenten zur Verfügung.
- Bei Schaltplan- oder PCB-Dokumenten (Designs oder Bibliotheken) wird ein grafischer Vergleich durchgeführt. Die erkannten Unterschiede werden im Panel Differences aufgelistet. Wenn die beiden Versionen des Dokuments nebeneinander im Designeditorfenster geöffnet sind, können Sie die Unterschiede grafisch prüfen. Durch Klicken auf einen Ordner der obersten Ebene für einen erkannten Unterschied wird dieser in beiden Dokumenten gleichzeitig hervorgehoben.
- Bei textbasierten ASCII-Dokumenten wird CompareForm Dialog wird angezeigt, der die Unterschiede zwischen den beiden Versionen des Dokuments grafisch darstellt. Die ausgewählten Dokumente werden nebeneinander angezeigt. Der Dialog dient ausschließlich dem Vergleich – Änderungen an einem geladenen Dokument sind nicht möglich. Durch Farbcodierung hebt der Dialog die verschiedenen Unterschiede zwischen den beiden Dokumentversionen hervor: hinzugefügte Zeilen (rosa), geänderte Zeilen (grün) und gelöschte Zeilen (blau). Unten links im Dialog werden eine Zusammenfassung der Änderungen und eine Legende zur Farbcodierung angezeigt.
Der Befehl Compare kann auf zwei beliebige Revisionen angewendet werden, auch auf die aktuelle lokale Revision (im Arbeitsordner) und eine neuere Revision im Repository. In diesem Fall wird die neueste lokale Revision im Panel Storage Manager als Out of date angezeigt, kann aber dennoch mit einer neueren Revision verglichen werden, die ein anderer Benutzer dem Repository hinzugefügt hat.
Die lokale Revision wird im Panel Storage Manager als „Veraltet“ angezeigt
Mit diesem Ansatz können Sie sich eine grafische Vorschau der Änderungen ansehen, die durch die Aktualisierung auf die neue Revision übernommen werden. Im obigen Beispielbild ist die aktuelle lokale Revision (gekennzeichnet durch das Symbol Revision 19, aber ein anderer Benutzer hat eine neue Revision in das Repository eingecheckt (Revision 22). Ein visueller Vergleich zwischen Revision 19 und Revision 22 ermöglicht Ihnen eine fundierte Entscheidung darüber, ob Sie die neuen Änderungen aus dem Repository übernehmen möchten und somit den Befehl Update anwenden oder dies durch das Herbeiführen eines Konflikts umgehen – indem Sie die lokale Datei erneut speichern und den Konflikt zugunsten Ihrer lokalen Version lösen.
Begriffe der Versionsverwaltung
| Begriff | Bedeutung |
|---|---|
| Base | Die Revision im Repository, die Sie als lokale Working Copy ausgecheckt haben. Auch als ausgecheckte Revision bezeichnet. |
Check-in |
Ihre Arbeitskopie der Datei im Repository speichern. In Altium Designer als Commit bezeichnet. |
Check-out |
Eine Kopie einer Datei aus dem VCS-Repository in einen Arbeitsordner übernehmen. Dabei handelt es sich in der Regel um die neueste Revision der Datei, es können jedoch auch alle früheren Revisionen ausgecheckt werden. Je nach VCS kann die Datei als einfach ausgecheckt oder als exklusiv ausgecheckt (gesperrt) gekennzeichnet werden. |
Clone |
Ein Git-Befehl, der ein entferntes Git-Repository in ein Git-Arbeitsrepository in einem lokalen Ordner kopiert (klont) und dabei automatisch die HEAD-Version (die neueste Version) in den Ordner auscheckt. Das lokale Repository enthält den Verweis auf das entfernte Repository (in diesem Fall |
Commit |
Die Arbeitskopie der Datei wieder im Repository speichern. In einigen Versionsverwaltungssystemen als Check-in bezeichnet. In der Altium-Designsoftware speichert der normale Befehl Save eine bearbeitete Datei im Arbeitsordner, während Commit diese Datei aus dem Ordner als neue Revision (Version) im Repository speichert. |
Conflict |
Die Situation, in der zwei Altium Designer-Benutzer versuchen, Änderungen einzuchecken, die denselben Bereich derselben Datei betreffen. Diese Konflikte müssen aufgelöst werden – entweder mit einem Merge-Tool, manuell oder durch die Festlegung, welche Version Vorrang erhält (zur neuen Revision wird). |
Database |
Der zentrale Speicherort aller Dateien unter Versionsverwaltung (oder Quellcodeverwaltung) – in der Praxis auch als Repository bezeichnet. |
Git |
Git ist ein Open-Source-Versionsverwaltungssystem. Altium Designer bietet Git-Funktionen (über die Erweiterung VCS Provider - Git), mit denen Revisionen direkt über die Panels Storage Manager und Projects verfolgt und abgerufen werden können. |
Head |
Die neueste in das Versionsverwaltungssystem eingecheckte Revision. |
Log message |
Ein Kommentar zu den Änderungen an einer Revision, der beim erneuten Einchecken (Commit) in das Repository erfasst wird. Die Protokollmeldungen können als Zusammenfassung des Änderungsverlaufs einer Datei dienen. |
Project |
Viele Versionsverwaltungssysteme unterstützen das Konzept eines Projekts. Ein VCS-Projekt ist eine Gruppe zusammengehöriger Dateien, die gemeinsam ein- und ausgecheckt werden können. Das VCS unterstützt möglicherweise auch weitere projektbezogene Funktionen, beispielsweise das Festlegen einer Versionsnummer für alle Dateien in einem Projekt. Dies unterscheidet sich vom Konzept eines Altium Designer-Projekts, das mit dem Befehl Projektordner zur Versionsverwaltung hinzufügen zur Versionsverwaltung hinzugefügt werden kann. |
Push |
Ein entferntes Git-Repository mit den Dateien aus dem lokalen Arbeitsrepository aktualisieren, um das lokale und das entfernte Repository zu synchronisieren. Dieser Befehl ist verfügbar, wenn eine Datei im lokalen Git-Repository neuer ist als ihr Gegenstück im entfernten Git-Repository. Er ist das logische Gegenstück zum Git-Befehl Pull. |
Repository |
Der zentrale Speicherort aller Dateien unter Versionsverwaltung (oder Quellcodeverwaltung) – auch als Database bezeichnet. |
Revision |
Eine eingecheckte Änderung im Verlauf einer Datei oder einer Gruppe von Dateien. Dabei handelt es sich um die alphanumerische Kennung, die das VCS vergibt, um die verschiedenen darin gespeicherten Ausgaben (Versionen) der Datei nachzuverfolgen. |
Sandbox |
Der Ordner, in den Dateien aus dem Repository ausgecheckt werden, damit sie bearbeitet werden können – auch als Working Folder bezeichnet. Dateien, die aus der Altium-Designsoftware ausgecheckt werden, werden automatisch geladen. |
| SVN | Subversion ist ein Open-Source-Versionsverwaltungssystem. Altium Designer bietet SVN-Funktionen (über die Erweiterung VCS Provider - SVN), mit denen Revisionen direkt über die Panels Storage Manager und Projects verfolgt und abgerufen werden können. |
Update |
Das Prüfen auf Änderungen an der Repository-Version einer Datei und deren Übernahme in eine Arbeitskopie (das Gegenstück zu Commit oder Check-in). Das Zusammenführen etwaiger Unterschiede erfordert ein Merge-Tool oder eine manuelle Aktualisierung. |
VCS |
Versionsverwaltungssystem: Ein allgemeiner Begriff für jedes Werkzeug, das den Versionsverlauf von Dateien verwalten und Dateien abrufen kann. |
Version |
Der Begriff „Version“ bezeichnet normalerweise die externe Referenznummer, die eine Person den verwalteten Dateien oder deren Ausgabe (beispielsweise bei Quellcode) zuweist. Meist wird dies als Revision betrachtet. |
Working Copy |
Die „lokale“ Kopie einer Datei, an der Änderungen vorgenommen werden – befindet sich normalerweise im Working Folder. |
Working Folder |
Der Ordner, in den Dateien aus dem Repository ausgecheckt werden, damit sie bearbeitet werden können – bei Git handelt es sich dabei um ein lokales Arbeitsrepository. Dateien, die aus Altium Designer ausgecheckt werden, werden automatisch geladen. |
Referenzen
- SVN-Website: http://subversion.apache.org/
- SVN-Onlinehandbuch: http://svnbook.red-bean.com/
- SharpSVN-Projektwebsite: https://sharpsvn.open.collab.net
- Git-Website: https://git-scm.com/
- Git-Onlinedokumentation: https://git-scm.com/doc
- Die Tortoise-Clients: http://tortoisesvn.net und https://tortoisegit.org/
- Anleitung zur Quellcodeverwaltung von Eric Sink: http://www.ericsink.com/scm/source_control.html


