Difference between revisions of "Creating A Patch/de"

From Free Pascal wiki
Jump to navigationJump to search
 
m (Remove defunct git-svn note reference)
 
(15 intermediate revisions by 7 users not shown)
Line 1: Line 1:
 
{{Creating A Patch}}
 
{{Creating A Patch}}
−
==Anleitung==
 
−
Dies setzt voraus, daß sie Lazarus von SVN erhalten haben. [[Getting Lazarus#Via SVN| Getting Lazarus Via SVN]]
 
  
−
Öffnen sie eine command oder cmd Kommandozeile und wechseln (cd) sie zu dem Verzeichnis, in dem sich die Lazarus Quellen befinden.
+
Falls Sie Verbesserungen am Code von FPC oder Lazarus haben, sollten Sie uns diese als "Patch" zusenden, den die Entwickler leicht einbauen können.
  
−
'''Anleitung für Windows:'''
+
Ausnahmen:
 +
# .po Übersetzungsdateien sollten Sie als vollständige Dateien schicken.
 +
# Neue Dateien sollten Sie ebenso als vollständige Dateien schicken, zusammen mit Instruktionen wo diese plaziert werden müssen.
  
−
Wir setzen voraus, daß sie ihr SVN checkout von Lazarus im Verzeichnis C:\lazarus haben:
+
__TOC__
 +
==Voraussetzungen==
  
−
# Öffnen sie eine MS-DOS Kommandozeile
+
Sie können sich Lazarus mittels Git oder SVN besorgen.
−
# c: {Enter drücken}
+
* Git: https://gitlab.com/freepascal.org/lazarus/lazarus Dies ist das originale Repositorium.
−
# cd \lazarus {Enter drücken}
+
* SVN:
−
# svn diff > mypatch.dif {Enter drücken}
 
  
−
'''Anleitung für Linux/BSD etc:'''
+
svn checkout --depth files https://github.com/fpc/Lazarus/branches all
 +
cd all
 +
svn update --set-depth infinity main
  
−
Wir setzen voraus, daß sie ihr SVN checkout von Lazarus im Verzeichnis $HOME/lazarus haben:
+
==Plattformspezifische Unterschiede==
 +
Die folgenden Instruktionen setzen voraus, dass Sie eine Befehlszeile geöffnet haben und dass Sie mittels des Befehls cd in das Verzeichnis des Repositoriums gewechselt haben. Hier sind die Details:
  
−
# Öffnen sie ihr bevorzugtes Terminalprogramm.
+
===Windows===
−
# cd $HOME {Enter drücken}
+
Falls Sie ein Checkout von Lazarus in C:\lazarus haben:
−
# cd lazarus {Enter drücken}
 
−
# svn diff > mypatch.diff {Enter drücken}
 
  
 +
# Öffnen Sie eine Befehlszeile, z.B. Start, geben Sie '''cmd.exe''' ein, {drücken Sie EINGABE} und gehen Sie ins Lazarus-Quelltext-Verzeichnis:
 +
# <syntaxhighlight lang="dos">c:</syntaxhighlight>
 +
# <syntaxhighlight lang="dos">cd \lazarus</syntaxhighlight>
  
−
''Notiz: I also like to look the file over to see if there is anything in there that shouldn't be.''
+
{{Anmerkung| Falls Sie [http://tortoisesvn.tigris.org/ TortoiseSVN] benutzen, können Sie den Ordner, in den Lazarus ausgecheckt wurde, im Windows-Explorer auswählen. Dann rechtsklicken Sieund wählen TortoiseSVN->Create Patch... }}
  
−
Jetzt zippen sie die Datei (auch mit gzip), die sie erstellt haben und senden sie per Email an die Lazarus Mailing Liste (40 kB Limit) oder an die Mailbox für Patches [mailto:patch@lazarus.dommelstein.net patch@lazarus.dommelstein.net].
+
Siehe auch [[TortoiseSvn#Troubleshooting]], wenn es Probleme gibt.
  
−
Das ist alles!
+
===*nix Systeme===
 +
Falls Sie ein Checkout von Lazarus in ~/lazarus haben:
  
−
== Fehlersuche ==
+
# Öffnen Sie Ihr bevorzugtes Terminalprogramm
−
Dies trifft meistens auf Windows zu kann aber ebenso auch für andere Plattformen zutreffen.
+
# <syntaxhighlight lang="bash">cd ~/lazarus</syntaxhighlight>
  
−
'''Sie erhalten die Fehlermeldung "svn command not found" oder ähnlich.'''
+
==Erzeugen eines Patchs mittels SVN==
−
Wahrscheinlich befindet sich die svn.exe nicht in ihrer PATH Umgebungsvariablen. Die folgenden Schritte sollten dieses Problem lösen:
+
<syntaxhighlight lang="bash">svn diff > mypatch.diff</syntaxhighlight>
 +
Dies schließt sämtliche veränderten Dateien im gesamten SVN-Repositorium ein.
  
−
# Locate svn.exe using the Find Files feature of your Start menu.
+
Sie können aber auch die einzelnen Dateien definieren, damit sicher kein überflüssiger Dateimüll enthalten ist, z.B.:
−
# Once you have located svn.exe you need to add the directory it is in to your PATH.
+
<syntaxhighlight lang="bash">svn diff ide/main.pp ideintf/objectinspector.pp > mypatch.diff</syntaxhighlight>
−
As an example: From the command prompt type:  
 
−
  set PATH=%PATH%;"C:\Program Files\TortoiseSVN\"
 
  
−
''Bemerkung: Ihr Verzeichnis welches svn.exe enthält muß nicht das selbe sein wie dasjenige, welches in diesem Dokument verwendet wird. Es wird hier als ein Beispiel verwendet.''
+
==Erzeugen eines Patchs mittels Git==
 +
Als Erstes: Entwickeln Sie Ihren Code in einem separaten Zweig!
 +
Solange Ihr Entwicklungszweig aktiv ist, können Sie Patches all Ihrer lokalen Commits erzeugen über:
 +
<syntaxhighlight lang="bash">git format-patch master</syntaxhighlight>
 +
Dies erzeugt einen Satz von Patches mit Namen wie "0001-CommitMsg.patch", "0002-CommitMsg.patch" und so weiter.
  
 +
Falls Sie all Ihre Änderungen in einem einzigen Patch wollen, kombinieren Sie entweder die Commits mittels "git rebase -i ..." oder benutzen Sie folgenden Befehl:
 +
<syntaxhighlight lang="bash">git format-patch master --stdout > mypatch.patch</syntaxhighlight>
  
−
Das folgende ist optional:
+
==Übermitteln des Patchs==
 +
Jetzt haben Sie einen Patch. Ich empfehle Ihnen, sich diese Datei einmal anzusehen, ob alles gut aussieht (- keine unerwarteten Änderungen).
  
−
'''To make this permanant'''
+
Der empfohlene Weg, einen Patch zu übermitteln, ist über den [http://bugs.freepascal.org bug tracker], siehe [[How do I create a bug report]] für Details. Falls dort ein Bericht vorliegt über das Problem, das Ihr Patch beseitigt, dann benutzen Sie diesen. Andernfalls erzeugen Sie einen neuen Eintrag. Laden Sie die Datei als Anhang zu diesem Fehlerbericht hoch.
  
−
Für Windows98 oder niedriger, sie können die obige Zeile zu ihrer C:\autoexec.bat Datei nahe dem Ende hinzufügen.  
+
==Using a forked Git repository directly==
 +
It is possible to use Git in a distributed manner also for Lazarus development.
 +
At least developers JuhaManninen and Alexander Klenin ("Ask") are ready to accept code in a Git repository.
  
−
Für Windows2000 oder höher können sie dieses Verzeichnis zu ihrem PATH hinzufügen durch:
+
In practice the repository must be forked from the Lazarus mirror in GitHub.
 +
The code must be in a separate branch and rebased against "upstream" branch.
 +
This is not tested yet, we can add more details here when somebody actually forks the repo and creates code.
  
−
# Rechtsklick auf "My Computer"
+
The limitation of this model is that the code must belong to the area of expertise of the developers working with Git.
−
# Auswahl von "Eigenschaften"
+
If the code is outside that area, you can still use Git but you must create patches and send them to bug tracker.
−
# Wählen sie den "Erweitert" Tab.
 
−
# Klicken sie auf den "Umgebungsvariablen" Button.
 
−
# Locate the "Path" line in "System Variables" and add: ;"C:\Program Files\TortoiseSVN\" to the end.
 
  
−
''Bemerkung: Ihr Verzeichnis welches svn.exe enthält muß nicht das selbe sein wie dasjenige, welches in diesem Dokument verwendet wird. Es wird hier als ein Beispiel verwendet.''
+
==Applying a patch==
 +
This explains how to apply somebody else's patch to your local repository. You can test the patch by using the --dry-run toggle switch like this:
 +
<syntaxhighlight lang="bash">patch --dry-run < somepatch.diff</syntaxhighlight>
 +
The output of the patch program will be identical to the actual patching, only it does not alter the sourcecode files. Very handy for testing, without the possibility to screw up your source.
  
−
==Anwendung eines Patches==
+
===A patch made with "svn diff"===
−
Die Anwendung eines Patches ist einfach. Sie können den Patch testen unter Verwendung des --dry-run Wechselschalters so wie dieser:
+
To do the final patching, use the following commandline:
 +
<syntaxhighlight lang="bash">patch < somepatch.diff</syntaxhighlight>
 +
If that doesn't work because the path layout of your environment is different from the environment where the patch was created, you can tell ''patch'' to strip out all path information:
 +
<syntaxhighlight lang="bash">patch -p0 < somepatch.diff</syntaxhighlight>
  
 +
Any GUI tool for diffs on Windows can handle these patches, too.
  
−
  patch --dry-run < mypatch.diff
+
===A patch made with "git format-patch"===
 +
====Git====
 +
Git itself applies the patch like this :
 +
<syntaxhighlight lang="bash">git apply 0001-gitpatch.patch</syntaxhighlight>
  
 +
====patch====
 +
The "patch" command now supports git format patches with -p1. This is tested with patch v.2.6.1 on Linux, old versions may not support it.
  
−
Der Output des Patchprogramms wird identisch sein mit dem eigentlichen patching, nur das er nicht die Quelldateien ändert. Äußerst praktisch zum Testen, ohne daß sie ihre Quellen zerstören.
+
<syntaxhighlight lang="bash">patch -p1 < 0001-gitpatch.patch</syntaxhighlight>
  
−
Für das finale patching verwenden sie die folgende Befehlszeile:
+
"patch" is available for Windows, too, but there are also GUI tools for the job.
  
 +
====TortoiseMerge====
 +
TortoiseMerge supports the Git format patch without problems.
 +
It is installed together with Tortoise SVN but is not integrated in explorer. It must be opened from the Start menu.
  
−
  patch < mypatch.diff
+
ToDo: add more GUI tools that support Git format patches
 +
 
 +
===Troubleshooting===
 +
Finally, patches may have a Unix/Linux line ending (LF) while your local file has Windows (CR+LF) line endings or vice versa. You'll have to convert the patch file before applying on Windows at least, as the supplied patch.exe is picky about line endings.
 +
 
 +
On Windows, the patch.exe supplied with FPC/Lazarus is very picky; you may have better luck with the patch.exe supplied by Git:
 +
<syntaxhighlight lang="dos">"C:\Program Files (x86)\Git\bin\patch.exe" -p0 < mypatch.diff</syntaxhighlight>
 +
 
 +
==See also==
 +
* [[How do I create a bug report]] general information on bug reporting
 +
* [[Tips on writing bug reports]] detailed information on what should be covered in a bug report.
 +
* [[Database bug reporting]] Specific info and sample programs for database bugs
 +
 
 +
[[Category:Lazarus/de]][[Category:Tutorials/de]][[Category:Debugging/de]]

Latest revision as of 00:07, 14 January 2022

│ Deutsch (de) │ English (en) │ español (es) │ français (fr) │ 日本語 (ja) │ português (pt) │ русский (ru) │ slovenčina (sk) │

Falls Sie Verbesserungen am Code von FPC oder Lazarus haben, sollten Sie uns diese als "Patch" zusenden, den die Entwickler leicht einbauen können.

Ausnahmen:

  1. .po Übersetzungsdateien sollten Sie als vollständige Dateien schicken.
  2. Neue Dateien sollten Sie ebenso als vollständige Dateien schicken, zusammen mit Instruktionen wo diese plaziert werden müssen.

Voraussetzungen

Sie können sich Lazarus mittels Git oder SVN besorgen. 

svn checkout --depth files https://github.com/fpc/Lazarus/branches all
cd all
svn update --set-depth infinity main

Plattformspezifische Unterschiede

Die folgenden Instruktionen setzen voraus, dass Sie eine Befehlszeile geöffnet haben und dass Sie mittels des Befehls cd in das Verzeichnis des Repositoriums gewechselt haben. Hier sind die Details:

Windows

Falls Sie ein Checkout von Lazarus in C:\lazarus haben:

  1. Öffnen Sie eine Befehlszeile, z.B. Start, geben Sie cmd.exe ein, {drücken Sie EINGABE} und gehen Sie ins Lazarus-Quelltext-Verzeichnis:
  2. c:

  3. cd \lazarus

Template:Anmerkung

Siehe auch TortoiseSvn#Troubleshooting, wenn es Probleme gibt.

*nix Systeme

Falls Sie ein Checkout von Lazarus in ~/lazarus haben:

  1. Öffnen Sie Ihr bevorzugtes Terminalprogramm
  2. cd ~/lazarus

Erzeugen eines Patchs mittels SVN

svn diff > mypatch.diff

Dies schließt sämtliche veränderten Dateien im gesamten SVN-Repositorium ein.

Sie können aber auch die einzelnen Dateien definieren, damit sicher kein überflüssiger Dateimüll enthalten ist, z.B.: 

svn diff ide/main.pp ideintf/objectinspector.pp > mypatch.diff

Erzeugen eines Patchs mittels Git

Als Erstes: Entwickeln Sie Ihren Code in einem separaten Zweig! Solange Ihr Entwicklungszweig aktiv ist, können Sie Patches all Ihrer lokalen Commits erzeugen über: 

git format-patch master

Dies erzeugt einen Satz von Patches mit Namen wie "0001-CommitMsg.patch", "0002-CommitMsg.patch" und so weiter.

Falls Sie all Ihre Änderungen in einem einzigen Patch wollen, kombinieren Sie entweder die Commits mittels "git rebase -i ..." oder benutzen Sie folgenden Befehl: 

git format-patch master --stdout > mypatch.patch

Übermitteln des Patchs

Jetzt haben Sie einen Patch. Ich empfehle Ihnen, sich diese Datei einmal anzusehen, ob alles gut aussieht (- keine unerwarteten Änderungen).

Der empfohlene Weg, einen Patch zu übermitteln, ist über den bug tracker, siehe How do I create a bug report für Details. Falls dort ein Bericht vorliegt über das Problem, das Ihr Patch beseitigt, dann benutzen Sie diesen. Andernfalls erzeugen Sie einen neuen Eintrag. Laden Sie die Datei als Anhang zu diesem Fehlerbericht hoch.

Using a forked Git repository directly

It is possible to use Git in a distributed manner also for Lazarus development. At least developers JuhaManninen and Alexander Klenin ("Ask") are ready to accept code in a Git repository.

In practice the repository must be forked from the Lazarus mirror in GitHub. The code must be in a separate branch and rebased against "upstream" branch. This is not tested yet, we can add more details here when somebody actually forks the repo and creates code.

The limitation of this model is that the code must belong to the area of expertise of the developers working with Git. If the code is outside that area, you can still use Git but you must create patches and send them to bug tracker.

Applying a patch

This explains how to apply somebody else's patch to your local repository. You can test the patch by using the --dry-run toggle switch like this: 

patch --dry-run < somepatch.diff

The output of the patch program will be identical to the actual patching, only it does not alter the sourcecode files. Very handy for testing, without the possibility to screw up your source.

A patch made with "svn diff"

To do the final patching, use the following commandline: 

patch < somepatch.diff

If that doesn't work because the path layout of your environment is different from the environment where the patch was created, you can tell patch to strip out all path information: 

patch -p0 < somepatch.diff

Any GUI tool for diffs on Windows can handle these patches, too.

A patch made with "git format-patch"

Git

Git itself applies the patch like this : 

git apply 0001-gitpatch.patch

patch

The "patch" command now supports git format patches with -p1. This is tested with patch v.2.6.1 on Linux, old versions may not support it. 

patch -p1 < 0001-gitpatch.patch

"patch" is available for Windows, too, but there are also GUI tools for the job.

TortoiseMerge

TortoiseMerge supports the Git format patch without problems. It is installed together with Tortoise SVN but is not integrated in explorer. It must be opened from the Start menu.

ToDo: add more GUI tools that support Git format patches

Troubleshooting

Finally, patches may have a Unix/Linux line ending (LF) while your local file has Windows (CR+LF) line endings or vice versa. You'll have to convert the patch file before applying on Windows at least, as the supplied patch.exe is picky about line endings.

On Windows, the patch.exe supplied with FPC/Lazarus is very picky; you may have better luck with the patch.exe supplied by Git: 

"C:\Program Files (x86)\Git\bin\patch.exe" -p0 < mypatch.diff

See also

Retrieved from "http://wiki.freepascal.org/index.php?title=Creating_A_Patch/de&oldid=149267"