diff

Материал из Википедии — свободной энциклопедии
Перейти к: навигация, поиск

В вычислительной технике diff — утилита сравнения файлов, выводящая разницу между двумя файлами. Эта программа выводит построчно изменения, сделанные в файле (для текстовых файлов). Современные реализации поддерживают также двоичные файлы. Вывод утилиты называется «diff», или, что более распространено, патч, так как он может быть применён с программой patch. Вывод других утилит сравнения файлов также часто называется «diff».

История[править | править вики-текст]

Утилита diff была разработана в начале 1970-х годов для операционной системы Unix, которая была плодом работы AT&T Bell Labs, в Мюррей Хилл (Нью-Джерси). Финальная версия, распространяемая с 5-й версией Unix в 1974, была полностью написана Дугласом Макилроем.

Алгоритм[править | править вики-текст]

Работа diff основана на нахождении наибольшей общей подпоследовательности (англ. longest common subsequence, проблема LCS). Например, имеются две последовательности элементов:

       a b c d f g h j q z
       a b c d e f g i j k r x y z

и надо найти наиболее длинную последовательность элементов, которая представлена в обеих последовательностях в одинаковом порядке. Это означает, что необходимо найти новую последовательность, которая может быть получена из первой последовательности удалением некоторых элементов или из второй последовательности удалением других элементов. В данном случае такой последовательностью будет являться

       a b c d f g j z

После получения наибольшей общей последовательности остаётся только небольшой шаг до получения похожего на diff вывода:

       e   h i   k   q r x y 
       +   - +   +   - + + +

Использование[править | править вики-текст]

diff вызывается из командной строки с именами двух файлов в качестве аргументов: diff original new. Вывод команды представляет собой изменения, которые нужно произвести в исходном файле original, чтобы получить новый файл new. Если original и new — директории, то diff автоматически будет применён к каждому файлу, который существует в обеих директориях. Все примеры в этой статье используют следующие два файла, original и new:

original:

 1 Эта часть документа
 2 оставалась неизменной
 3 от версии к версии. Если
 4 в ней нет изменений, она
 5 не должна отображаться.
 6 Иначе это не способствует
 7 выводу оптимального 
 8 объёма произведённых
 9 изменений.
10 
11 Этот абзац содержит
12 устаревший текст.
13 Он будет удалён
14 в ближайшем будущем.
15 
16 В этом документе
17 необходима провести
18 проверку правописания.
19 С другой стороны, ошибка
20 в слове - не конец света.
21 Остальная часть абзаца
22 не требует изменений.
23 Новый текст можно
24 добавлять в конец документа.

new:

 1 Это важное замечание!
 2 Поэтому оно должно
 3 быть расположено
 4 в начале этого
 5 документа!
 6 
 7 Эта часть документа
 8 оставалась неизменной
 9 от версии к версии. Если
10 в ней нет изменений, она
11 не должна отображаться.
12 Иначе это не способствует
13 выводу оптимального 
14 объёма информации.
15  
16 В этом документе
17 необходимо провести
18 проверку правописания.
19 С другой стороны, ошибка
20 в слове - не конец света.
21 Остальная часть абзаца
22 не требует изменений.
23 Новый текст можно
24 добавлять в конец документа.
25 
26 Этот абзац содержит
27 важные дополнения
28 для данного документа.

Команда diff original new производит следующий нормальный дифф-вывод:

 0a1,6
 > Это важное замечание!
 > Поэтому оно должно
 > быть расположено
 > в начале этого
 > документа!
 > 
 8,14c14
 < объёма произведённых
 < изменений.
 < 
 < Этот абзац содержит
 < устаревший текст.
 < Он будет удалён
 < в ближайшем будущем.
 ---
 > объёма информации.
 17c17
 < необходима провести
 ---
 > необходимо провести
 24a25,28
 > 
 > Этот абзац содержит
 > важные дополнения
 > для данного документа.

В этом традиционном формате вывода a означает добавлено (от англ. add), dудалено, сизменено. Перед буквами a, d или c стоят номера строк исходного файла, после них — номера строк конечного файла. Каждая строка, которая была добавлена, удалена или изменена, предваряется угловыми скобками.

По умолчанию, общие для исходного и конечного файлов номера строк не указываются. Строки, которые перемещены, показываются как добавленные на своём новом месте и удалённые из своего прошлого расположения.[1]

Варианты[править | править вики-текст]

Большинство реализаций diff остаются внешне неизменными с 1975 года. Модификации включают в себя улучшения основного алгоритма, добавление новых ключей команды, новые форматы вывода. Базовый алгоритм изложен в книгах An O(ND) Difference Algorithm and its Variations Юджина В. Майерса,[2] и в A File Comparison Program Вебба Миллера и Майерса.[3] Алгоритм был независимо открыт и описан в Algorithms for Approximate String Matching Е. Укконеном[4] Первые версии программы diff были разработаны для сравнения строк текстовых файлов, использующих символ новой строки как разделитель строк. В 1980-х поддержка двоичных файлов привела к изменениям в схеме работы и реализации программы.

Edit script[править | править вики-текст]

Edit script можно сгенерировать современными версиями diff с помощью опции -e. Результат для нашего примера будет выглядеть так:

24a

Этот абзац содержит
важные дополнения
для данного документа.
.
17c
необходимо провести
.
8,14c
объёма информации.
.
0a
Это важное замечание!
Поэтому оно должно
быть расположено
в начале этого
документа!

.

Чтобы использовать полученный скрипт для преобразования файла original к состоянию файла new, нам нужно добавить в конец скрипта две строки: одна содержит команду w (write), другая - q (quit). Например так printf "w\nq\n" >> mydiff. Здесь мы дали diff файлу имя mydiff. Преобразование произойдёт когда мы дадим команду ed -s original < mydiff.


Контекстный формат[править | править вики-текст]

В BSD версии 2.8 (выпущенной в июле 1981 года) появился контекстный формат (-c) и возможность рекурсивного обхода дерева каталогов файловой системы (-r).

В контекстном формате изменённые строки показываются вместе с незатронутыми строками до и после изменённого фрагмента. Вставка любого количества незатронутых строк предоставляет контекст для патча. Контекст, состоящий из незатронутых строк, служит ссылкой для определения положения изменяемого фрагмента в целевом файле, даже если номера изменяемых строк в исходном и целевом файлах не совпадают. Контекстный формат представляет большую читабельность для людей и большую надежность при применении патча, а вывод принимается в качестве входа для программы patch.

Число незатронутых строк до и после изменённого фрагмента может задаваться пользователем и быть даже нулем, но обычно по умолчанию равно трем строкам. Если контекст незатронутых строк во фрагменте пересекается с соседним фрагментом, то diff избежит копирования незатронутых строк и объединит смежные фрагменты в один.

Вывод команды diff -c original new:

*** /path/to/original ''timestamp''
--- /path/to/new      ''timestamp''
***************
*** 1,3 ****
--- 1,9 ----
+ Это важное замечание!
+ Поэтому оно должно
+ быть расположено
+ в начале этого
+ документа!
+ 
  Эта часть документа
  оставалась неизменной
  от версии к версии. Если
***************
*** 5,20 ****
  не должна отображаться.
  Иначе это не способствует
  выводу оптимального 
! объёма произведённых
! изменений.
! 
! Этот абзац содержит
! устаревший текст.
! Он будет удалён
! в ближайшем будущем.
  
  В этом документе
! необходима провести
  проверку правописания.
  С другой стороны, ошибка
  в слове - не конец света.
--- 11,20 ----
  не должна отображаться.
  Иначе это не способствует
  выводу оптимального 
! объёма информации.
  
  В этом документе
! необходимо провести
  проверку правописания.
  С другой стороны, ошибка
  в слове - не конец света.
***************
*** 22,24 ****
--- 22,28 ----
  не требует изменений.
  Новый текст можно
  добавлять в конец документа.
+ 
+ Этот абзац содержит
+ важные дополнения
+ для данного документа.

Универсальный формат[править | править вики-текст]

Универсальный формат (или unidiff) включает в себя технические улучшения, сделанные в контекстном формате, но разницу между старым и новым текстом выдает в более компактом виде. Универсальный формат обычно вызывается использованием «-u» опции командной строки. Этот вывод часто используется как patch для программ. Многие проекты специально просят присылать им «diffs» в универсальном формате, делая, тем самым, универсальный формат самым распространенным для обмена между разработчиками программного обеспечения.

Универсальные контекстные diff’ы впервые были разработаны Wayne Davison в августе 1990 (unidiff появляется в главе 14 comp.sources.misc). Столлман добавил поддержку универсального формата в GNU Project's diff утилиту одним месяцем позже и эта функциональность дебютировала в GNU diff 1.15, выпущенная в январе 1991. GNU diff has since generalized the context format to allow arbitrary formatting of diffs.

Файл в универсальном формате начинается с тех же самых двух строк, что и контекстный формат, за исключением того, что оригинальный файл начинается с «---», а новый файл начинается с «+++». Следом за ними следует один или больше измененных фрагментов, которые содержат по-линейные изменения в файлах. Строки без изменений начинаются с пробела, добавленные строки начинаются со знака плюс, удаленные строки начинаются со знака минус.

Фрагмент начинается с информации о диапазоне и сразу за ним следуют добавленные строки, удаленные строки и любое количество контекстных строк. Информация о диапазоне окружена двойными знаками @ и объединена в одну строку, в отличие от двух строк в (контекстном формате). Информация о диапазоне имеет следующий формат:

@@ -l,s +l,s @@ optional section heading

Информация о диапазоне состоит из двух частей. Часть для оригинального файла начинается с минуса, а часть для нового файла начинается с плюса. Каждая часть в формате l, s, где l — номер строки, с которой начинаем, а s — количество строк, которые были изменены в текущем фрагменте для каждого из файлов, соответственно (то есть, в первом случае, это сумма выведенных строк, начинающихся с пробела и с минуса, во втором — строк, начинающихся с пробела и с плюса). Во многих версиях GNU diff в каждом диапазоне запятая и замыкающая s могут быть опущены. В этом случае s по умолчанию равна 1. Обратите внимание, что единственное полезное значение только у l — номер строки первого диапазона, остальные значения могут быть вычислены из diff’а.

Фрагмент диапазона для оригинального файла должен быть суммой всех контекстных и удаленных (включая измененные) строк фрагмента. Фрагмент диапазона для нового файла должен включать в себя сумму все контекстных и добавленных (включая измененные) строк фрагмента.

Фрагмент диапазона может быть предварен заголовком секции или функции, частью которой является фрагмент. Это обычно полезно для чтения самого фрагмента. Когда создается diff с использованием GNU, diff заголовок определяется регулярным выражением[5]

Если линия была изменена, она показывается и как удаленная, и как добавленная. Так как удаленная и добавленная строки находятся в смежных фрагментах, то эти строки показываются рядом друг с другом[6]. Например:

-check this dokument. On
+check this document. On

Команда diff -u original new создаст следующий вывод:

--- /path/to/original	''timestamp''
+++ /path/to/new	''timestamp''
@@ -1,3 +1,9 @@
+Это важное замечание!
+Поэтому оно должно
+быть расположено
+в начале этого
+документа!
+
 Эта часть документа
 оставалась неизменной
 от версии к версии. Если
@@ -5,16 +11,10 @@
 не должна отображаться.
 Иначе это не способствует
 выводу оптимального 
-объёма произведённых
-изменений.
-
-Этот абзац содержит
-устаревший текст.
-Он будет удалён
-в ближайшем будущем.
+объёма информации.
 
 В этом документе
-необходима провести
+необходимо провести
 проверку правописания.
 С другой стороны, ошибка
 в слове - не конец света.
@@ -22,3 +22,7 @@
 не требует изменений.
 Новый текст можно
 добавлять в конец документа.
+
+Этот абзац содержит
+важные дополнения
+для данного документа.

Обратите внимание, чтобы нормально отделить имена файлов от временных меток используется табуляция. Это незаметно на экране и может быть утеряно при копировании/вставки из консоли.

Есть несколько изменений и расширений для diff форматов, которые используют и понимают различные программы. Например, некоторые cистемы управления версиями, такие как Subversion, указывают номер версии, «рабочую копию» или любой другой комментарий в дополнение к временной метке в заголовке diff’a.

Некоторые программы позволяют создавать diff’ы для нескольких разных файлов и сливают их в один, используя заголовок для каждого измененного файла, который может выглядеть примерно так:

Index: path/to/file.cpp

Специальный вид файлов, которые не заканчиваются новой линией, не поддерживается. Ни unidiff утилита, ни POSIX diff стандарт не определяют способ обработки таких файлов (более того, такой тип файлов не «текстовые» файлы в определении POSIX.[7])

Программа patch ничего не знает о реализации специального вывода команды diff.

См. также[править | править вики-текст]

Примечания[править | править вики-текст]

  1. David MacKenzie, Paul Eggert, and Richard Stallman. Comparing and Merging Files with GNU Diff and Patch. — 1997. — ISBN ISBN 0-9541617-5-0.
  2. E. Myers (1986). «An O(ND) Difference Algorithm and Its Variations». Algorithmica 1 (2): 251–266.
  3. Webb Miller and Eugene W. Myers (1985). «A File Comparison Program». Software — Practice and Experience 15 (11): 1025–1040.
  4. E. Ukkonen (1985). «Algorithms for Approximate String Matching». Information and Control 64: 100–118.
  5. 2.2.3 Showing Which Sections Differences Are in, GNU diffutils manual
  6. Unified Diff Format by Guido van Rossum, Июнь 14, 2006
  7. http://pubs.opengroup.org/onlinepubs/9699919799/basedefs/V1_chap03.html#tag_03_205 Section 3.205

Ссылки[править | править вики-текст]