Fügen Sie Ihr Dokument dem manual Modul hinzu

Anfordern der Commit-Berechtigungen
Was sollten Sie tun und was nicht, sobald Sie Commit-Rechte besitzen?
Committen Sie Ihre Arbeit

Wenn Ihr Dokument abgeschlossen ist, und Sie überprüft haben, dass es korrekt erstellt wird, möchten Sie es sicherlich in manual Modul hinzufügen. Wenn dies Ihr erster Beitrag zum Dokumentationsprojekt ist, werden Sie sicherlich verstehen, dass Sie Ihr Werk zuerst bei den Koordinatoren für die Überprüfung einreichen. Alternativ können Sie die HTML-Version auch auf einer Webseite zugänglich machen, sodass das Ergebnis auf der Mailingliste diskutiert werden kann. Danach - und vielleicht nach ein paar Korrekturen - kann das Dokument im Modul eingebunden werden. Wenn Sie die erforderlichen Rechte besitzen, können Sie dies selbst tun, wenn nicht, übernimmt das einer der Koordinatoren für Sie.

Anfordern der Commit-Berechtigungen

Um die Commit-Rechte zu erhalten benötigen Sie zunächst einen Account für SourceForge. Wenn Sie bisher keinen besitzen, registrieren Sie sich unter http://sourceforge.net/account/register.php. Schicken Sie dann eine Mitteilung an die firebird-docs Mailingliste mit Ihrem SF-Benutzernamen und der Bitte diesen zum Firebird-Projekt hinzuzufügen. Der Leiter des manual-Unterprojekt und diverse Firebird-Projektadmins verfolgen die Liste; Sie werden sich Ihrer Anfrage annehmen. Generell sollten Sie die Berechtigungen nach Ihrem ersten Beitrag anfordern, da die Entscheidungsträger etwas in der Hand haben wollen.

Die folgenden Phrasen sind gleichbedeutend:

Projektmitglied sein.
Commit-Rechte besitzen.
Schreibenden und lesenden Zugriff für das Repository zu besitzen.

Was sollten Sie tun und was nicht, sobald Sie Commit-Rechte besitzen?

Sobald Sie als Projekt-Mitglied angenommen werden, haben Sie Schreibzugriff auf die gesamte Firebird-Repository, nicht nur auf das manual Modul. Es ist kein technisches Hindernis, Änderungen für andere Module zu committen - das firebird2-Kernmodul zum Beispiel, oder sogar das CVSROOT -Modul, in dem wichtige Projektinformationen gespeichert sind.

Sie haben sich sicherlich schon gedacht, dass dies NICHT Sinn der Sache ist. Halten Sie sich an folgende Regeln:

Tätigen Sie niemals Eingaben zu anderen Modulen, es sei denn die Verantwortlichen fordern Sie ausdrücklich dazu auf.
Committen Sie nur Arbeiten zum manual Modul, wenn es eine Ihnen zugewiesenen Aufgabe betrifft. Selbst dann ist es eine gute Praxis, Änderungen und Ergänzungen auf der Mailing-Liste anzukündigen, so dass die anderen Schreiber eine Chance haben, sich dazu zu äußern. Immerhin ist dies eine kollektive Anstrengung.
Wenn Sie denken, dass ein neues Dokument oder ein Verzeichnis aufgenommen werden sollte, erstellen und committen Sie es nicht einfach, schlagen Sie es vor auf der Liste.

In der Praxis sind die Dinge ein bisschen entspannter als hier angegeben, insbesondere dann, wenn es Ihre eigenen Aufgaben betrifft. Wir wollen nicht, dass Sie sich beschränkt fühlen und sicherlich soll Ihnen nicht das Gefühl gegeben werden, dass man für jede kleine Änderung um Erlaubnis fragen muss. Aber wir möchten, dass Sie verantwortungsvoll handeln, und wir wollen von einander wissen, was wir tun. Außerdem ist einander zu kontakieren oft inspirierend. Gemeinsam können wir die Dinge am Laufen halten!

Committen Sie Ihre Arbeit

Selbst wenn Sie Projektmitglied sind, können Sie Änderungen Ihrer lokalen Kopie nur abgeben, wenn diese auch mit Ihrem SF-Login ausgecheckt wurde. Wenn Sie immer noch mit einer Kopie arbeiten, die anonym ausgecheckt wurde, müsen Sie erst einen frischen SSH-Checkout durchführen und die Änderungen erneut zuweisen. Danach führen Sie den Commit aus. Bitte vgl. Sie auch Docbuilding Howto, wenn Sie nicht mehr wissen, wie der SSH-Checkout durchzuführen ist.

Wenn zwischen Ihrem letzten Checkout oder Update einige Zeit vergangen ist, führen Sie erst ein Update vor dem Commit aus. Dies wird Ihre lokale Kopie mit dem Repository synchonisieren und die Anzahl möglicher Konflikte reduzieren.

Sobald Sie für einen Commit bereit sind, wechseln Sie in das manual-Verzeichnis. Wenn Sie command-line CVS verwenden, tippen Sie folgendes ein:

cvs update -d [ nur wenn Sie erst ein Update durchführen wollen ]

cvs add path/to/mydocument.xml [ nur wenn ein neues Dokument vorhanden ist, dass noch nicht im CVS liegt ]

cvs commit -m "Kurze Informationsbeschreibung, die hier einzugeben ist"

Nach dem -m und innerhalb der Anführungszeichen, ist eine kurze Information über diesen Commit anzugeben, z.B. "Neue Funktionen zur API-Referenz hinzugefügt" oder "Fehler im isql-Handbuch gefixt".

Geben Sie Ihr SF-Kennwort ein, wenn es abgefragt wird, damit alle Ihre durchgeführten Änderungen - inlusive der Unterverzeichnisese - committed werden. Ihr CVS-Client weiß welcher Server zu kontaktieren ist; diese und andere Informationen sind in den CVS-Unterverzeichnissen gespeichert, die während des Checkout erstellt wurden.

Wenn Sie einen anderen CVS-Client verwenden, konsultieren Sie hierzu bitte die Dokumentation.

Wichtig

Nachdem ein neues Dokument hinzugefügt wurde, müssen Sie einen separaten Commit durchführen. Dies gilt für command-line CVS und die meisten (wenn nicht für alle) anderen CVS-Clients.