Creating A Patch/de: what changed

Revision 1 to 2. Removed lines have a minus sign; added lines have a plus sign.

Old	New		Line
1	1		Falls Sie Verbesserungen am Code von FPC oder Lazarus haben, sollten Sie uns diese als "Patch" zusenden, den die Entwickler leicht einbauen können.
2	2
3	3		Ausnahmen:
4	4
5	5		1. .po Übersetzungsdateien sollten Sie als vollständige Dateien schicken.
6	6		2. Neue Dateien sollten Sie ebenso als vollständige Dateien schicken, zusammen mit Instruktionen wo diese plaziert werden müssen.
7	7
8	8		## Voraussetzungen
9	9
10	10		Sie können sich Lazarus mittels Git oder SVN besorgen.
11	11
12	12		- Git: <https://gitlab.com/freepascal.org/lazarus/lazarus> Dies ist das originale Repositorium.
13	13		- SVN:
14	14
15		-	~~`svn checkout --depth files `[`https://github.com/fpc/Lazarus/branches`](https://github.com/fpc/Lazarus/branches)` all`\~~
16		-	~~`cd all`\~~
17		-	~~`svn update --set-depth infinity main`~~
	15	+	```text
	16	+	svn checkout --depth files https://github.com/fpc/Lazarus/branches all
	17	+	cd all
	18	+	svn update --set-depth infinity main
	19	+	```
18	20
19	21		## Plattformspezifische Unterschiede
20	22
21	23		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:
22	24
23	25		### Windows
24	26
25	27		Falls Sie ein Checkout von Lazarus in C:\lazarus haben:
26	28
27	29		1. Öffnen Sie eine Befehlszeile, z.B. Start, geben Sie cmd.exe ein, {drücken Sie EINGABE} und gehen Sie ins Lazarus-Quelltext-Verzeichnis:
28	30
29	31		2. ```dos
30	32		c:
31	33		```
32	34
33	35		3. ```dos
34	36		cd \lazarus
35	37		```
36	38
37	39		Siehe auch [[TortoiseSvn\|TortoiseSvn#Troubleshooting]], wenn es Probleme gibt.
38	40
39	41		### *nix Systeme
40	42
41	43		Falls Sie ein Checkout von Lazarus in ~/lazarus haben:
42	44
43	45		1. Öffnen Sie Ihr bevorzugtes Terminalprogramm
44	46
45	47		2. ``` bash
46	48		cd ~/lazarus
47	49		```
48	50
49	51		## Erzeugen eines Patchs mittels SVN
50	52
51	53		``` bash
52	54		svn diff > mypatch.diff
53	55		```
54	56
55	57		Dies schließt sämtliche veränderten Dateien im gesamten SVN-Repositorium ein.
56	58
57	59		Sie können aber auch die einzelnen Dateien definieren, damit sicher kein überflüssiger Dateimüll enthalten ist, z.B.:
58	60
59	61		``` bash
60	62		svn diff ide/main.pp ideintf/objectinspector.pp > mypatch.diff
61	63		```
62	64
63	65		## Erzeugen eines Patchs mittels Git
64	66
65	67		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:
66	68
67	69		``` bash
68	70		git format-patch master
69	71		```
70	72
71	73		Dies erzeugt einen Satz von Patches mit Namen wie "0001-CommitMsg.patch", "0002-CommitMsg.patch" und so weiter.
72	74
73	75		Falls Sie all Ihre Änderungen in einem einzigen Patch wollen, kombinieren Sie entweder die Commits mittels "git rebase -i ..." oder benutzen Sie folgenden Befehl:
74	76
75	77		``` bash
76	78		git format-patch master --stdout > mypatch.patch
77	79		```
78	80
79	81		## Übermitteln des Patchs
80	82
81	83		Jetzt haben Sie einen Patch. Ich empfehle Ihnen, sich diese Datei einmal anzusehen, ob alles gut aussieht (- keine unerwarteten Änderungen).
82	84
83	85		Der empfohlene Weg, einen Patch zu übermitteln, ist über den [bug tracker](http://bugs.freepascal.org), 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.
84	86
85	87		## Using a forked Git repository directly
86	88
87	89		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.
88	90
89	91		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.
90	92
91	93		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.
92	94
93	95		## Applying a patch
94	96
95	97		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:
96	98
97	99		``` bash
98	100		patch --dry-run < somepatch.diff
99	101		```
100	102
101	103		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.
102	104
103	105		### A patch made with "svn diff"
104	106
105	107		To do the final patching, use the following commandline:
106	108
107	109		``` bash
108	110		patch < somepatch.diff
109	111		```
110	112
111	113		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:
112	114
113	115		``` bash
114	116		patch -p0 < somepatch.diff
115	117		```
116	118
117	119		Any GUI tool for diffs on Windows can handle these patches, too.
118	120
119	121		### A patch made with "git format-patch"
120	122
121	123		#### Git
122	124
123	125		Git itself applies the patch like this :
124	126
125	127		``` bash
126	128		git apply 0001-gitpatch.patch
127	129		```
128	130
129	131		#### patch
130	132
131	133		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.
132	134
133	135		``` bash
134	136		patch -p1 < 0001-gitpatch.patch
135	137		```
136	138
137	139		"patch" is available for Windows, too, but there are also GUI tools for the job.
138	140
139	141		#### TortoiseMerge
140	142
141	143		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.
142	144
143	145		ToDo: add more GUI tools that support Git format patches
144	146
145	147		### Troubleshooting
146	148
147	149		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.
148	150
149	151		On Windows, the patch.exe supplied with FPC/Lazarus is very picky; you may have better luck with the patch.exe supplied by Git:
150	152
151	153		```dos
152	154		"C:\Program Files (x86)\Git\bin\patch.exe" -p0 < mypatch.diff
153	155		```
154	156
155	157		## See also
156	158
157	159		- [[How do I create a bug report]] general information on bug reporting
158	160		- [[Tips on writing bug reports]] detailed information on what should be covered in a bug report.
159	161		- [[Database bug reporting]] Specific info and sample programs for database bugs
160	162
161	163		---
162	164		From the Free Pascal wiki, page "Creating A Patch/de", as it stood on 2022-01-13 after a change by Trev, out of the wiki's dump of 2024-05-26. Copyright stays with the author who wrote it, according to the old wiki's [[Licensing]] page. If you have concerns about this material, [message the admin](/wiki-contact).
163	165		Category: Debugging/de
164	166		Category: Lazarus/de
165	167		Category: Tutorials/de

Back to history