doc/de_DE.ISO8859-1/books/fdp-primer/working-copy/chapter.xml

<?xml version="1.0" encoding="iso-8859-1"?>
<!-- Copyright (c) 2013 Warren Block
    All rights reserved.

     Redistribution and use in source (SGML DocBook) and 'compiled' forms
     (SGML HTML, PDF, PostScript, RTF and so forth) with or without
     modification, are permitted provided that the following conditions
     are met:

      1. Redistributions of source code (SGML DocBook) must retain the above
         copyright notice, this list of conditions and the following
         disclaimer as the first lines of this file unmodified.

      2. Redistributions in compiled form (transformed to other DTDs,
         converted to PDF, PostScript, RTF and other formats) must reproduce
         the above copyright notice, this list of conditions and the
         following disclaimer in the documentation and/or other materials
         provided with the distribution.

     THIS DOCUMENTATION IS PROVIDED BY THE AUTHOR "AS IS" AND ANY EXPRESS OR
     IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
     OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
     DISCLAIMED. IN NO EVENT SHALL NIK CLAYTON BE LIABLE FOR ANY DIRECT,
     INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES
     (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
     SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
     HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT,
     STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN
     ANY WAY OUT OF THE USE OF THIS DOCUMENTATION, EVEN IF ADVISED OF THE
     POSSIBILITY OF SUCH DAMAGE.

     $FreeBSD$
     $FreeBSDde$
     basiert auf: 45384
-->

<chapter xmlns="http://docbook.org/ns/docbook" xmlns:xlink="http://www.w3.org/1999/xlink" version="5.0" xml:id="working-copy">
  <title>Die Arbeitskopie</title>

  <para>Die <emphasis>Arbeitskopie</emphasis> ist eine Kopie des &os;
    Dokumentationsrepositories, die Sie auf Ihren lokalen Computer
    heruntergeladen haben.  Änderungen an der Dokumentation werden
    in der Arbeitskopie durchgeführt und getestet. Patches für
    Änderungen im Hauptrepository werden aus der Arbeitskopie
    erzeugt, nachdem Sie Ihre Änderungen durchgeführt haben.</para>

  <para>Eine komplette Kopie des Dokumentationsbaums ist etwa 700 Megabyte
    groß.  Damit Sie die Dokumentation auch in verschiedenen Formaten
    testen und bauen können, sollten Sie für das Repository mindestens
    1 Gigabyte an freiem Speicherplatz bereitstellen.</para>

  <para>Die Dateien der &os;-Dokumentation werden mit <link
    xlink:href="&url.books.handbook;/svn.html"><application>Subversion</application></link>
    verwaltet.  Falls es auf Ihrem System noch nicht vorhanden ist,
    wird dieses Werkzeug vom Port <package>textproc/docproj</package>
    automatisch installiert.</para>

  <sect1 xml:id="working-copy-doc-and-src">
    <title>Die Dokumentation und Manualpages</title>

    <para>Die &os;-Dokumentation besteht nicht nur aus Büchern und
      Artikeln.  Auch die Manualpages für alle Befehle und
      Konfigurationsdateien sind Teil des <acronym>FDP</acronym>.
      Die Dokumentation ist dabei auf zwei Repositories verteilt:
      <literal>doc</literal> für Bücher und Artikel sowie
      <literal>base</literal> für das Betriebssystem und Manualpages.
      Um Manualpages zu bearbeiten, muss zusätzlich das Repository
      <literal>base</literal> ausgecheckt werden.</para>

    <para>Ein Repository kann multiple Versionen der Dokumentatation
      enthalten.  Änderungen werden in der Regel aber  immer nur an
      der aktuellen Version durchgeführt, die als
      <literal>head</literal> bezeichnet wird.</para>
  </sect1>

  <sect1 xml:id="working-copy-choosing-mirror">
    <title>Einen Spiegelserver wählen</title>

    <para>Um die Geschwindigkeit zu erhöhen (und die Downloadzeit zu
      reduzieren), wählen Sie bitte aus der Liste der <link
      xlink:href="&url.books.handbook;/svn.html#svn-mirrors">Subversion
      Spiegelserver</link> einen Server in Ihrer Nähe.  Ersetzen Sie
      dazu in den folgenden Beispielen die <acronym>URL</acronym>
      <replaceable>https://svn0.us-west.FreeBSD.org/</replaceable>
      durch die des von Ihnen gewählten Spiegelservers.</para>
  </sect1>

  <sect1 xml:id="working-copy-choosing-directory">
    <title>Ein Verzeichnis für die Arbeitskopie wählen</title>

    <para>Die &os;-Dokumentation wird üblicherweise unter
      <filename>/usr/doc/</filename>, Quellcode (inklusive Manualpages)
      unter <filename>/usr/src/</filename> installiert.  Es ist
      sinnvoll, Arbeitskopien in einen anderen Ordner auszuchecken,
      um potentielle Konflikte mit bereits in diesen Ordnern vorhandenen
      Dokumenten zu vermeiden.  Die folgenden Beispiele verwenden daher
      die Verzeichnisse <filename>~/doc</filename> sowie
      <filename>~/src</filename>.  Bei beiden Verzeichnissen handelt
      es sich um Unterverzeichnisse des home-Verzeichnisses des
      jeweiligen Benutzers.</para>
  </sect1>

  <sect1 xml:id="working-copy-checking-out">
    <title>Die Arbeitskopie auschecken</title>

    <para>Der Download einer Arbeitskopie wird als
      <emphasis>checkout</emphasis> bezeichnet und erfolgt über den
      Befehl <command>svn checkout</command>.  Das folgende Beispiel
      checkt die aktuelle Version der Dokumentatation
      (<literal>head</literal>) aus dem Hauptdokumentationsbaum aus:</para>

    <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org/doc/head</replaceable> <replaceable>~/doc</replaceable></userinput></screen>

    <para>Das Auschecken des Quellcodes für die Arbeit an den Manualpages
      erfolgt analog:</para>

    <screen>&prompt.user; <userinput>svn checkout <replaceable>https://svn0.us-west.FreeBSD.org/base/head</replaceable> <replaceable>~/src</replaceable></userinput></screen>
  </sect1>

  <sect1 xml:id="working-copy-updating">
    <title>Die Arbeitskopie aktualisieren</title>

    <para>Die Dokumente und Dateien im &os;-Repository ändern sich
      beinahe täglich.  Änderungen werden durchgeführt und committed.
      Bereits kurz nach einem Checkout kann es daher Unterschiede
      zwischen Ihrer Arbeitskopie und dem &os;-Hauptrepository geben.
      Um eine lokale Arbeitskopie auf den Stand des Hauptrepository zu
      aktualisieren, wenden Sie den Befehl
      <command>svn update</command> auf das Verzeichnis an, in dem sich
      Ihre lokale Arbeitskopie befindet:</para>

    <screen>&prompt.user; <userinput>svn update <replaceable>~/doc</replaceable></userinput></screen>

    <para>Gewöhnen Sie sich an, <command>svn update</command> auszuführen,
      bevor Sie Dokumente bearbeiten.  Sonst kann es passieren, dass
      das Dokument in der Zwischenzeit bearbeitet wurde, Ihre lokale
      Kopie diese Änderungen aber noch nicht enthält.  Es ist deutlich
      einfacher, die aktuelle Version zu bearbeiten, als Ihre älteren
      lokalen Änderungen mit den aktuellen Änderungen des Repositories
      zu kombininieren.</para>
  </sect1>

  <sect1 xml:id="working-copy-revert">
    <title>Änderungen an der Arbeitskopie zurücknehmen</title>

    <para>Manchmal ist es notwendig, durchgeführte Änderungen
      zurück zu nehmen oder überhaupt von vorne zu beginnen.  Änderungen
      an einer Datei können über den Befehl <command>svn revert</command>
      <quote>zurückgesetzt</quote> werden (die Datei ist danach wieder in
      ihrer ursprünglichen Version vorhanden).  Wollen Sie beispielsweise
      Ihre Änderungen an der Datei <filename>chapter.xml</filename>
      zurücksetzen, um die unbearbeitete Originalversion zu erhalten,
      geben Sie den folgenden Befehl ein:</para>

    <screen>&prompt.user; <userinput>svn revert chapter.xml</userinput></screen>
  </sect1>

  <sect1 xml:id="working-copy-making-diff">
    <title>Eine Differenzdatei erstellen</title>

    <para>Nachdem Sie eine oder mehrere Dateien bearbeitet haben,
      müssen Sie die Unterschiede zwischen Ihrer lokalen Arbeitskopie
      und dem &os;-Repository in einer Datei sammeln, bevor Sie Ihre
      Änderungen einreichen können.  Diese Dateien werden als
      <emphasis>diff</emphasis>-Dateien bezeichnet und können durch
      den Befehl <command>svn diff</command> erzeugt werden:</para>

    <screen>&prompt.user; <userinput>cd <replaceable>~/doc</replaceable></userinput>
&prompt.user; <userinput>svn diff &gt; <replaceable>doc-fix-spelling.diff</replaceable></userinput></screen>

    <para>Geben Sie der Datei einen Namen, die den Inhalt beschreibt.
      Die Differenzdatei im Beispiel enthält Rechtschreibkorrekturen
      für den gesamten Dokumentationsbaum.</para>

    <para>Wenn Sie Ihre Änderungen über das Webformular
      <quote><link xlink:href="https://bugs.FreeBSD.org/bugzilla/enter_bug.cgi">Submit a &os;
      problem report</link></quote> einreichen wollen, fügen Sie bitte
      die Erweiterung <filename>.txt</filename> an den Dateinamen an,
      damit das Formular sicher erkennt, dass Sie gewöhnlichen Text
      hochladen wollen.</para>

    <para>Vorsicht: <command>svn diff</command> protokolliert ALLE
      Änderungen im aktuellen Verzeichnis (und dessen Unterverzeichnissen).
      Wollen Sie einige dieser Änderungen noch nicht einreichen,
      müssen Sie angeben, für welche Dateien Sie eine Differenzdatei
      erstellen wollen.</para>

    <screen>&prompt.user; <userinput>cd <replaceable>~/doc</replaceable></userinput>
&prompt.user; <userinput>svn diff <replaceable>disks/chapter.xml printers/chapter.xml</replaceable> &gt; <replaceable>disks-printers.diff</replaceable></userinput></screen>
  </sect1>

  <sect1 xml:id="working-copy-subversion-references">
    <title>Referenzen zu <application>Subversion</application></title>

    <para>Diese Beispiele haben Ihnen den prinzipiellen Umgang mit
      <application>Subversion</application> gezeigt.  Weitere
      detaillierte Informationen finden Sie im
      <link xlink:href="http://svnbook.red-bean.com/">Subversion Book</link>
      sowie in der <link
      xlink:href="http://subversion.apache.org/docs/">Subversion documentation</link>.</para>
  </sect1>
</chapter>