Patches

Aktuelle Version vom 15. Juni 2015, 20:08 Uhr

[Bearbeiten] Beschreibung

Nach dem Einspielen eines Patches ist der Quelltext neu zu übersetzen. Für VDR existieren diverse Patches z. B. um die Optik des OSD zu verbessern.

Siehe auch

• Plugins

[Bearbeiten] Liste

[Bearbeiten] Anleitung

Was ist ein Patch? Ein Patch (oder auch diff-Datei genannt) ist nichts anderes als eine Differenzmenge zwischen 2 Dateien. Im vdr-Bereich sind diese Dateien zu 99,99% Textdateien wie z.B. Scripte oder Quellcodes. Da man bei Unterschieden ja auch dokumentieren muß, was wo unterschiedlich ist, enthält die Datei ein paar Steuerinformationen, so reicht es nicht zu sagen "Zeile 10 wurde gelöscht", wenn man gar nicht dazu sagt, ob in der alten oder in der neuen Datei. A propos Datei, der Patch enthält außerdem Informationen, um welche Dateien es überhaupt geht.

[Bearbeiten] Wie ist ein Patch aufgebaut?

Nehmen wir an, wir haben eine fiktive Datei D1:

1.Zeile 1
2.Zeile 2
3.Zeile 3
4.Zeile 4
5.Zeile 5

Und fiktive Datei D2:

1. Zeile 1
2. Zeile 2
3. Zeile 3 neu
4. Zeile 4
5. Zeile 5

Dann ergäbe das eine Patchdatei mit dem Inhalt:

1. --- D1  2005-02-21 18:44:01.000000000 +0100
2. +++ D2  2005-02-21 18:44:40.000000000 +0100
3. @@ -1,5 +1,5 @@
4. Zeile 1
5. Zeile 2
6.-Zeile 3
7.+Zeile 3 neu
8. Zeile 4
9. Zeile 5

Als erstes gibt es Informationen über die Dateien, die betroffen sind: Die Ausgangsdatei (--- Zeile) und die Zieldatei (+++ Zeile). Außerdem gibt es die Angabe "@@ -1,5 +1,5 @@". Dies heißt soviel wie: "Es folgt ein Unterschied zwischen Zeile 1 und 5, und der gehört in der Zieldatei zwischen Zeile 1 und 5." Das Patchprogramm weiß dann später, in welche Zeile es springen muss. Weiterhin gibt es nun Zeilen mit "+" und mit "-". Das ist -- genau -- das, was verändert werden soll. Es wird nach einer Zeile mit dem Inhalt von "Zeile 3" gesucht und anschließend gelöscht. Danach wird eine Zeile mit dem Inhalt von "Zeile 3 neu" eingefügt.

Das Patchprogramm bekommt die Informationen, wo was wodurch ersetzt werden soll.

[Bearbeiten] Wie liegt ein Patch vor?

Ein Patch kann auf mehrere Arten vorliegen.

• als gepackte Datei, z.B. patch.gz, patch.diff.gz, patch.diff.bz2
• als ungepackte Datei, z.B. patch.diff, patch.patch
• als Archiv mit mehreren gepackten Dateien, z.B. patch.tgz, patch.tar.bz2, patch.zip

Die Namen sind frei wählbar, man erkennt aber meist sehr schnell worum es sich handelt, mehr Informationen dazu gibt es gleich noch.

Bitte was? "mehrere gepackte Dateien"? Was soll das? Die Erklärung ist ganz einfach. Stellt euch vor, ihr wollt ein Programm mit 100 Dateien patchen und jeder Patch wäre eine einzelne Datei. Beim Erstellen des Patches würdet ihr irre werden und derjenige der die Patches einspielen muß ebenfalls. Daher kommen Patches öfters in der Variante c) vor, da sind dann intern mehrere Patch-Dateien enthalten, aber für das Einspielen ändert das gar nix, man merkt davon nicht einmal etwas.

[Bearbeiten] Wie spielt man einen Patch ein?

Kurz: Man übergibt ihn an das Programm patch.

Ausführlich: Das Programm patch dient zum einspielen der Patches, dazu muß man dem Programm sagen wo der Patch zu finden ist, also z.B.:

user@pc:/tmp > patch < /irgendwo/in/dem/verzeichnisbaum/liegt/diese/datei.diff

schon legt er los. Er versucht nun im aktuellen Verzeichnis, in diesem Fall also "/tmp" eine Datei namens D1 zu finden um sie zu patchen (ich nehme die Beispiele von oben weiterhin). Bei mir geht das, denn ich habe die Datei dort angelegt. Würde ich mich jedoch im Verzeichnis "/freigabe" befinden, dann gäbe es einen Fehler:

1. user@pc:/freigabe > patch < /tmp/patch.diff
2. can't find file to patch at input line 3
3. Perhaps you should have used the -p or --strip option?
4. The text leading up to this was:
5. --------------------------
6. |--- D1 2005-02-21 18:44:01.000000000 +0100
7. |+++ D2 2005-02-21 18:44:40.000000000 +0100
8. -------------------------
9. File to patch:

Die entscheidenden Informationen stehen hier:

can't find file to patch at input line 3

er kann eine Datei aus dem Patch nicht finden. Dieses ist meist ein Zeichen dafür, dass man sich in einem falschen Verzeichnis befindet. Doch es kann auch etwas anderes sein, er deutet es schon an:

Perhaps you should have used the -p or --strip option?

Was soll das heißen? Die Erklärung ist auch hier sehr einfach wenn man es einmal verstanden hat :)

Nehmen wir an meine Dateien sind über viele Unterverzeichnisse verteilt, dann würde ich ja kirre werden, wenn ich in jedes Unterverzeichnis gehen müßte, um die zu analysieren. Daher versteht die Patchdatei auch Verzeichnisse, nun könnte meine Datei anfangen mit:

#|--- tmp/D1 2005-02-21 18:44:01.000000000 +0100
#|+++ tmp/D2 2005-02-21 18:44:40.000000000 +0100

Er würde also die Dateien IMMER im Unterverzeichnis "./tmp" suchen, aktuell also in /freigabe/tmp.

Ich kann also:

a) ein Verzeichnis tmp anlegen und die Datei reinkopieren
b) dem Patcher sagen: "Hey du Depp, ignoriere einfach mal dein erstes Verzeichnis"

Man wird a) nie machen, denn b) ist die Lösung der Wahl, genau das ist der "-p1" Parameter. -p1 schneidet ein Verzeichnis weg -p2 zwei Verzeichnisse etc.

Ich kann also in /freigabe bleiben und meinen Patch mit:

patch -p1 < /tmp/patch.diff

einspielen.

Nun ein paar Worte zu den Archiven, also den Patchvorkommen a) und c) von oben. Statt "patch < /tmp/patch" könnte ich auch schreiben: "cat /tmp/patch.diff | patch" also den Inhalt an patch "pipen", das ist technisch quasi dasselbe in diesem Fall. Das Programm "patch" kann nur ASCII-Dateien, also Entpackte, verstehen. Man kann nun

• die Archive auspacken und einzeln patchen
• ein Programm diese Arbeit machen lassen

Für die gängigen Formate wie "tgz/tar.gz" und "gz" und auch "bz2" gibt es cat-Ableger, diese heißen einfach: zcat, bzcat einfach das Entsprechende benutzen:

zcat /tmp/patch.diff.gz | patch

fertig.

[Bearbeiten] Was kann beim Patchen passieren?

Eigentlich "nur" 3 Dinge.

1. Das Patch wurde angewendet
2. Hunks
3. Rejects

Passiert nix, dann ist alles ok, der Patchvorgang schaut etwa so aus:

user@pc:/tmp > patch < patch.diff
patching file D1
user@pc:/tmp >

fertig.

Hunks sind kleine Mißstände, die Patch aber korrigieren kann, sie sehen so aus:

user@pc:/tmp > patch < patch.diff
patching file D1
Hunk #1 succeeded at 2 (offset 1 line).
user@pc:/tmp >

Das bedeutet, dass er einen Hunk hatte (#Nummer zählt er hoch) und zwar mußte er eine Patchzeile um 1 Zeile verschieben.

Was war passiert?

Meine D1 war nicht mehr so wie oben, sondern war nun so:

1. Zeile 0
2. Zeile 1
3. Zeile 2
4. Zeile 3
5. Zeile 4
6. Zeile 5

also eine Zeile mehr in der Gegend wo er patchen muß, er hat sich also gewundert und nochmal genauer hingeschaut, hat seine "Zeile 3" gefunden, die er ersetzen soll und munter weitergemacht. Hunks sind im Normalfall genauso wie "nix": solange alles läuft, einfach ignorieren. Sie treten sehr schnell auf, sobald mal irgendwo eine Dokumentarzeile eingefügt wurde oder Ähnliches.

Kommen wir zu den Rejects. Unsere neue Datei D1:

1. Zeile 1
2. Zeile 2
3. Zeile 4
4. Zeile 5

Unsere Zeile "Zeile 3" fehlt also, genau das, wo er patchen soll: das schaut so aus:

user@pc:/tmp > patch < patch.diff
patching file D1
Hunk #1 FAILED at 1.
1 out of 1 hunk FAILED -- saving rejects to file D1.rej

Igitt. Aber er sagt ja: "saving rejects to file D1.rej" Also schauen wir da mal rein:

1. **************
2. *** 1,5 ****
3.   Zeile 1
4.   Zeile 2
5.  -Zeile 3
6.   Zeile 4
7.   Zeile 5
8.--- 1,5 ----
9.   Zeile 1
10.  Zeile 2
11. +Zeile 3 neu
12.  Zeile 4
13.  Zeile 5

Nichts Neues, er sagt nur noch einmal, was er machen sollte, nämlich "Zeile 3" löschen und durch "Zeile 3 neu" ersetzen. Die gibts nur nicht mehr, also bringt er einen Fehler.

In diesem Fall muß man fachlich tätig werden. Man muß schauen, was hier geändert wurde, denn es könnte ja auch etwas Anderes sein, nämlich sowas:

Unsere neue Datei D1:

1. Zeile 1
2. Zeile 2
3. Zeile 3 alt
4. Zeile 4
5. Zeile 5

also statt "Zeile 3" der String "Zeile 3 alt", auch das findet er nicht. Die Fehlermeldung ist absolut dieselbe wie oben, man muß also im Detail schauen, was hier los ist. In den meisten Fällen wurden nur Leerzeichen eingefügt (er würde bei " Zeile 3" auch abbrechen) oder es wurden Parameter in den Methoden geändert, oder halt sogar der komplette Block neu geschrieben. Wie gesagt, pauschalisieren kann man hier nicht, da muß man dann genauer reinschauen, was da los ist. Man kann sich da aber mit ein wenig Zeit gut einlesen, denn man weiß ja nun, wo was wodurch ersetzt werden soll.

[Bearbeiten] ..und so macht man einen Patch:

Wir gehen ins Verzeichnis temp mit den Unterverzeichnissen D1 (alte Version) und D2 (neue Version) dann

user@pc > diff -NaurwB D1/ D2/ > unterschied-D1-D2.diff

• -N : fehlende Dateien als leer betrachten
• -a : alles Text Dateien
• -u : 3 Zeilen "drum herum" ausgeben
• -r : Unterverzeichnisse einbeziehen
• -w : Leerzeichen und Tabs ignorieren (ggf. weglassen)
• -B : Leerzeilen ignorieren