Development:Git Patch erstellen
Dieser Artikel befindet sich derzeit im Reviewprozess. Hilf mit, ihn zu verbessern!
Falls du bei weiteren Artikeln helfen willst, findest du hier eine Auswahl offener Artikel. Development
- Allgemein
- Neutrino-HD-Entwicklung
- dbox2 Entwicklung
Wer einen Patch bereitstellen möchte, kann mit Git speziell importierbare Patchfiles erstellen. Die nötigen Funktionen werden durch Git ohne Zusatzsoftware zur Verfügung gestellt. Zusätzliche Tools wie diff und patch werden nicht benötigt.
Durch diese Git Eigenheit wird das Arbeiten mit Git auch für die Entwickler deutlich vereinfacht und zudem unterscheidet Git, anders als CVS oder auch SVN zwischen Committer und Autor des Patches. Dies hat zur Folge, das ein mit Git formatierter Patch, sofern er korrekt erzeugt und angewendet wurde, dazu führt, dass der Autor in die Historie des Repostories aufgeführt wird.
Dazu kann man wie folgt vorgehen.
Inhaltsverzeichnis
Vorbereitung
Sicherstellen das ein gültiger Authorname und eine gültige Emailadresse hinterlegt ist. Wenn nicht, dies global für alle Git Repositories nachholen.
git config --global user.name "Firstname Lastname"
git config --global user.email "your_email@youremail.com"Oder nur für das lokale Git Repository.
cd /Pfad/zum/Repository
git config user.name "Firstname Lastname"
git config user.email "your_email@youremail.com"Quellcode verändern
Diese Schritt ist genauso wie bei anderen SCM-Systemen. Man verändert den Quellcode mit den eigenen gewünschten Veränderungen.
git pull
# adding some modificationsPatch erstellen
Dieser Schritt ist recht einfach. Dazu gibt es einen Git-Befehl. Zuvor müssen die Quellcodeveränderungen committet werden. Also zunächst einen Commit durchführen. Wenn Ihr wirklich nur die Dateien verändert habt, die zum Commit gehören, kann einfach dieses Kommando verwendet werden.
git commit -aWenn nicht per
git add <Datei1> <Datei2> ...die relevanten Dateien selktiv hinzufügen und abschließend
git commitaufrufen. Hier im Beispiel eine einfache Veränderung der neutrino.cpp.
user@pc~/gitprojects/buildsystem-cs/source/neutrino-hd [tuxbox-port]$ vi src/neutrino.cpp
user@pc~/gitprojects/buildsystem-cs/source/neutrino-hd [tuxbox-port]$ git commit -a
[tuxbox-port 5756abf] neutrino.cpp: changing debug output to use macro dprintf
1 files changed, 2 insertions(+), 2 deletions(-)Nun liegen die Veränderungen im lokalen Git Repo und können mit
git format-patch [BRANCH]als Patch ausgegeben werden. Im Beispiel wurde die neutrino.cpp vom Branch tuxbox-hd/tuxbox-port verändert. Daher dann auch der git-format-patch Befehl gegen diesen Branch. Würde man gegen origin/master in dem Falle den Befehl anwenden, dann würden auch alle Patches bzw. Änderungen aus weiteren Commits ausgegegeben werden, die sich zwischen tuxbox-hd/tuxbox-port und origin/master ergeben.
user@pc~/gitprojects/buildsystem-cs/source/neutrino-hd [tuxbox-port]$ git format-patch tuxbox-hd/tuxbox-port
0001-neutrino.cpp-changing-debug-output-to-use-macro-dpri.patchDas ist eigentlich schon alles. Diese Datei(en) können nun an einen Entwickler geschickt werden.
Patch von einem Einzel-Commit erstellen
zunächst das Log aufrufen, um den benötigten Commit zu finden. In diesem Beispiel liegt der betreffende Commit im lokalem Branch "commit" und sollte unter den letzten paar commits zu finden sein. Pauschal suchen wir nun die letzten Commits ab:
git log -3Dies gibt nun die letzten Commits aus:
commit ac7abd8db402724f9c195b2091c7a92997edce6e
Author: Thilo Graf <###@n###x.de>
Date: Mon Apr 16 10:51:07 2012 +0200
target ntp: add target for ntp
neutrino sectionsd missed ntpdate with error log
"getUTC: read: invalid argument
ntpdate not found"
ntpdate should also now can be intstalling with system-tools
Signed-off-by: Thilo Graf <###@n###x.de>>
commit 3caecd682aea585f101286ec7cb550813c7ac1df
Author: Stefan Seyfried <seife@tuxbox-git.#######.de>
Date: Sun Apr 15 19:52:05 2012 +0200
start_neutrino: prepare for deep standby
commit 874ba0c75afe65ebd0a2482000634ac0c75303f2
Author: Stefan Seyfried <seife@tuxbox-git.#######.de>
Date: Sun Apr 15 18:48:23 2012 +0200
spark: use aotom FP to switch the box into deep standby
For this to be really useful, we need support in neutrino.
lines 1-28/28 (END)Wenn der gewünschte Commit dieser ist: ac7abd8db402724f9c195b2091c7a92997edce6e erzeugt folgendes Kommando einen entsprechenden Patch
git format-patch -M -C ac7abd8db402724f9c195b2091c7a92997edce6e~1...ac7abd8db402724f9c195b2091c7a92997edce6e
0001-target-ntp-add-target-for-ntp.patchDer erzeugte Patch kann dann weitergegeben werden.
einen Patch von einer dritten Person erhalten
Es ist möglich, das Ihr von einer anderen Person einen Patch erhalten habt und diesen weitergeben wollt. Wenn diese Person nun wiederum den Patch nicht selbst weitergeben wollte, aber trotzdem einverstanden ist, das der Patch weitergegeben werden kann, dann könnt Ihr diesen Patch noch mit einem SignOff versehen. Dazu einfach die Option --signoff beim git-format-patch mit angeben.
user@pc~/gitprojects/buildsystem-cs/source/neutrino-hd [tuxbox-port]$ git format-patch tuxbox-hd/tuxbox-port --signoff
0001-neutrino.cpp-changing-debug-output-to-use-macro-dpri.patchDanach wie oben schon beschrieben den Patch an einen Developer weiter geben.
einen Patch einspielen
Das Einspielen eines solchen Patches ist sehr einfach.
Dazu wird der Befehl git apply /Pfad/zur/Patchdatei benutzt. Einzigste Bedingung ist das Ihr im entsprechenden Git Repository seid.
user@pc~/gitprojects/buildsystem-cs/source/neutrino-hd [tuxbox-port]$ git apply 0001-neutrino.cpp-changing-debug-output-to-use-macro-dpri.patch
