Unixové nástroje – 8 (diff a patch)

3. 2. 2010 | David Watzke | Návody | 15236×

Tentokrát se podíváme na vytváření a aplikaci patchů, neboli záplat. Představíme si totiž programy diff a patch.

Obsah

• diff
• patch

diff

diff je program sloužící k porovnání dvou textových souborů a vypsání rozdílů mezi nimi. Název vychází z anglického slova difference, což znamená rozdíl. Výstup programu se obvykle ukládá do souboru a těmto souborům se říká patche nebo česky záplaty. Tyto soubory mají obvykle příponu .patch nebo .diff.

Tento program často používají programátoři, a to nejen pro zdrojový kód, ale pro libovolný text v projektu. Když se totiž větší patch zkomprimuje, jde o dobrý způsob jak šířit změny v programu oproti předchozímu vydání. Představte si projekt, jehož balík se zdrojáky má 200 MiB. Vývojáři změní 2000 řádků v různých souborech. Místo toho, aby vydali (pouze) novou setinkovou verzi a nutili lidi, kteří si stáhli předchozí verzi, stahovat zbytečně znova celý balík, poskytnou navíc ještě záplatu, která může po zkomprimování zabírat klidně i méně než 1 KiB.

Základní použití je velice prosté. Mějme dva soubory obsahující třeba 2 stejné řádky, dále jeden řádek, který bude v každém souboru jiný a dva řádky, které jsou obsaženy pouze ve druhém souboru.

diff stary.txt novy.txt
3c3
< Python
---
> Perl
4a5,6
> Haskell
> Pascal

Možná se divíte co znamená „4a5,6“ (a „3c3“). Jsou to v podstatě souřadnice textu. První číslo (4) značí řádek, na kterém začíná změna. Znak za ním (a) značí, o jakou změnu jde. Pokud se změnil řádek, šlo o change (změnu). Pokud byl řádek přidán, šlo o add (přidání). Další číslo (5) značí řádek, na kterém změna začíná. Pokud změna není jednořádková (jako v případě „3c3“), za čárkou následuje ještě další číslo (6), které značí číslo řádku, na kterém změna končí.

Programátoři tento výchozí formát programu diff nevyužívají nejspíš zejména proto, že by při aplikaci patche mohlo dojít k omylu. Často se totiž patch aplikuje s jistou tolerancí vůči tomu, když nesouhlasí čísla řádků. K tomu dojde, třeba když na program verze 1.0.1 aplikujeme patch, který byl vytvořen pro verzi 1.0.0. Aby se omylu předešlo a bylo bezpečné této tolerance využívat, existuje další formát. Tím se dostáváme k přepínačům -u a -U. Tento formát kolem samotných rozdílů obsahuje sjednocený (unified) kontext. Tedy neobsahuje pouze změněné řádky, ale i pár řádků okolo. Přepínač -U umožňuje nastavit velikost kontextu, přičemž -u nastavuje napevno 3 řádky. Přepínač -u je tedy ekvivalentem -U3. Výstup může vypadat takto:

diff -u pole.c.old pole.c
--- pole.c.old  2010-01-26 16:17:07.854861691 +0100
+++ pole.c      2010-01-26 16:17:13.320576007 +0100
@@ -10,4 +10,6 @@
                p[i] = i+1;
                printf("%d\n", p[i]);
        }
+       free(p);
+       return;
 }

Zde si můžete všimnout třířádkového kontextu kolem změny. Pod změnou již tři řádky nebyly, proto je tam pouze jeden. Když je více změn poblíž u sebe (v rámci kontextu), tak se vygeneruje rozdíl do jednoho bloku.

Přepínače -c a -C jsou podobné -u a -U, ovšem s tím rozdílem, že kontext kolem změn není sjednocený, ale identický s originálem.

S přepínačem -b diff ignoruje mezery před konci řádků.

Dále byly standardizovány přepínače -e a -f. První z nich zajistí generování výstupu, který je vhodným vstupem pro program ed. Druhý vyprodukuje podobný alternativní formát.

Jako poslední zmíním přepínač -r, který aktivuje rekurzivní režim. Lze pomocí něj vygenerovat rozdíl z více souborů najednou:

diff -ru program-1.0/ program-1.0.1/

patch

Nástroj patch slouží k aplikování patchů (záplat), které umí generovat výše zmíněný program diff.

Základní použití vypadá takto:

patch -i nejaky_patch.diff

Nejdříve si popíšeme nejzákladnější přepínače. Tím hlavním je -p. Vysvětlíme si jej rovnou na příkladu. Hlavička kontextového patche, který byl generován rekurzivně (viz výše), může vypadat třeba takto:

--- program-1.0/main.c 		2010-01-31 16:09:17.511327226 +0100
+++ program-1.0.1/main.c 	2010-01-31 16:09:36.300575801 +0100

Teď si představte situaci, kdy máte adresář se zdrojovými kódy nazvaný program-1.0 a záplatu s názvem program-1.0-1.0.1.patch, která obsahuje rozdíly mezi verzemi 1.0 a 1.0.1. Jak je aplikovat?

# zkopírujeme si zdrojáky do nového adresáře
cp -a program-1.0 program-1.0.1
# vstoupíme do nového adresáře
cd program-1.0.1/
# aplikujeme patch
patch -p1 -i ../program-1.0-1.0.1.patch

Takže co dělá -p? Ovlivňuje cesty k souborům, které program vyčte z hlavičky záplaty. Program dostane cestu program-1.0.1/main.c, jenže tam – relativně k adresáři, ze kterého patch spouštíme – soubor není. Je totiž přímo tam, tedy správně by bylo main.c. Přepínač -p s argumentem 1 v tomto případě z cesty odstraní jeden adresář zleva, takže zbyde jen main.c přesně tak, jak potřebujeme. Vzhledem k tomu, že když -p nezadáme, tak se odstraní celá cesta a použije se pouze název souboru, by se v tomto případě patch aplikoval i bez -p. Ovšem s -p0 by to nešlo z výše zmiňovaného důvodu; program by hledal program-1.0.1/main.c a nic by nenašel.

Dalším důležitý přepínač je -i, kterému jako argument zadáváme cestu k záplatě. To ale není jediný způsob, jak programu předat záplatu. Když totiž nedostane žádný soubor, tak čeká na vstup. Můžeme použít klasické přesměrování shellu. Tato vlastnost se ovšem hodí především při aplikaci komprimovaného patche, protože můžeme využít unixové roury k tomu, abychom se vyhnuli jednomu dočasnému souboru.

# předání záplaty pomocí přesměrování
patch < x.diff
# rozbalenou záplatu rovnou pošleme programu
bzcat patch-2.6.33-rc6.bz2 | patch -p1

Přepínač -R slouží ke změně podstaty aplikování záplaty. Zkrátka, když už je záplata aplikovaná, pomocí stejného příkazu navíc s -R můžete změny zase vrátit.

Pomocí přepínače -d si můžete ušetřit použití příkazu cd před záplatováním, protože když mu jako argument zadáte platnou cestu, nejdříve se do ní přepne.

Normálně se program snaží zjistit typ záplaty sám, ale chcete-li to z nějakého důvodu obejít, lze si to vynutit pomocí přepínačů. Pro kontextovou záplatu použijte -c, pro ed -e, pro normální -n a pro sjednocenou -u.

Užitečný přepínač je -b, který zajistí zálohování každého změněného souboru – před jeho změnou je soubor zkopírován s příponou .orig.

       

Komentáře

[Prcek]

Diff jsem nikdy nechápal, a teď na to nejsem o moc líp .

[Ladislav Hagara]

Denně používám colordiff, lépe se mi dívá na obarvené rozdíly. Občas sáhnu po vimdiff. Do Thunderbirda doporučuji nainstalovat colorediffs rozšíření, ...

[fraxinus]

dobra vec je aj program meld

[Jaris]

alebo vimdiff

[Zomp]

A nebo v KDE grafický Kompare (nadstavba nad diff, či čímkoliv dle výběru; samozřejmostí je porovnávání "vzdálených" souborů přes KIO a podobně).

[Prcek]

Jo ta grafická verze už se mi líbí víc . Pěkně oba dokumenty vedle sebe a barevně označené úseky, kde se soubory liší, to už je pro mě víc stravitelné.

[Prcek]

Aha teď teprve jsem si všiml, že nemám Kompare ale KDiff3, ale asi to bude prašť jako uhoď.

[Fill]

Výstup obyčejného diffu lze též úspěšně obarvit pomocí obecného nástroje na barvení kdečeho - GNU source-highlight.

[Ash]

První číslo (4) značí řádek, na kterém začíná změna. ... Další číslo (5) značí řádek, na kterém změna začíná.

Tohle asi jen tak někdo neznalý diffu nepochopí, bude to chtít rozlišovat mezi jednotlivými soubory.

[kmarty]

Bez muceni se priznavam ze tenhle (vlastne vychozi) format diffu jsem poradne nikdy nepochopil a od chvile co jsem objevil unified format jsem se uz ani nesnazil.

[trekker.dk]

Což nic nemění na tom, že těch pár vět po sobě nedává moc smysl.

[Ash]

Bez mučení vězte že 4a5,6 znamená, že za řádek 4 se přidá (add) řádky pět a šest druhého souboru.

[kmarty]

Diky. Ale asi si to stejne mou oblibu neziska.

[Michal Kubeček]

Když už je řeč o diffu coby nástroji pro generování patchů, nemělo by se zapomenout na důležitý přepínač -N. Bez něj totiž diff v rekurzivním režimu, existuje-li soubor jen v jednom stromu, pouze napíše, že tomu tak je. Nově přidané soubory tedy nejsou v patchi obsaženy a patch nelze použít k vytvoření nové verze ze staré. S přepínačem -N se v takovém případě diff chová, jako by ve druhém stromu soubor existoval a byl prázdný.

[Michal Vyskočil]

Chtělo by to zmínit i kontextový formát (-c), i když jsem ho v praxi nikdy neviděl. Ale byl to právě ten, který kontext zavedl. Bez toho asi není příliš jasné, kde se vzal název unified. Ten vznikl pravděpodobně proto, že tento formát sjednocuje výhody obou starších formátů.

Z klasického si vzal dva stavy, tudíž lepší čitelnost. A z kontextového kontext a rovněž podporu pro tvorbu diffu z více souborů, což s klasickým formátem nejde. Gnu diff sice tuto informaci přidá, ale protože výsledek stejně patch nevezme, musel by se diff rozdělit a aplikovat postupně.

[petr_p]

Na řádkově orientovaný text (obvykle zdrojový kód nebo konfigurační soubory) je diff výborný. Ale na běžném textu (formátovaném do odstavců), kde se mění třeba jen pár slov uprostřed dlouhého řádku, dává přehlednější výstup nástroj wdiff(1). Používám na dokumentaci nebo korektury textu.

[Jiří Svoboda]

Z mnoha dalších přepínačů diffu se docela často hodí "-y" aneb "--side-by-side".

[pht]

A co diff3, bude?

[kralyk z abclinuxu]

Supr, díky za článek, přehledný souhrn práce s diff a patch mi dycky chyběl...