Variations Edit script Context format Unified format Others
Free file comparison tools
See also
References
Further reading
External links
{{About|the file comparison utility|data comparisons in general|data comparison|diffs in Wikipedia|:help:diff|other uses|DIFF (disambiguation){{!}}DIFF}}{{lowercase|title=diff}}{{Infobox software | name = diff | title = diff | screenshot = | caption = | screenshot size = | screenshot alt = | collapsible = | author = Douglas McIlroy | developer = AT&T Bell Laboratories | released = {{Start date and age|1974|6}} | latest release version = | latest release date = | programming language = | platform = Unix and Unix-like | genre = Command | license = | website = | standard = | AsOf = }}
In computing, the {{Mono|diff}} utility is a data comparison tool that calculates and displays the differences between two files. Unlike edit distance notions used for other purposes, {{Mono|diff}} is line-oriented rather than character-oriented, but it is like Levenshtein distance in that it tries to determine the smallest set of deletions and insertions to create one file from the other. The {{Mono|diff}} command displays the changes made in a standard format, such that both humans and machines can understand the changes and apply them: given one file and the changes, the other file can be created.
Typically, {{Mono|diff}} is used to show the changes between two versions of the same file. Modern implementations also support binary files.[1] The output is called a "diff", or a patch, since the output can be applied with the Unix program {{Mono|patch}}. The output of similar file comparison utilities are also called a "diff"; like the use of the word "grep" for describing the act of searching, the word diff became a generic term for calculating data difference and the results thereof.[2] The POSIX standard specifies the behavior of the "diff" and "patch" utilities and their file formats.[3]
History
The {{Mono|diff}} utility was developed in the early 1970s on the Unix operating system which was emerging from Bell Labs in Murray Hill, New Jersey. The final version, first shipped with the 5th Edition of Unix in 1974, was entirely written by Douglas McIlroy. This research was published in a 1976 paper co-written with James W. Hunt who developed an initial prototype of {{Mono|diff}}.[4] The algorithm this paper described became known as the Hunt–McIlroy algorithm.
McIlroy's work was preceded and influenced by Steve Johnson's comparison program on GECOS and Mike Lesk's {{Mono|proof}} program. {{Mono|Proof}} also originated on Unix and, like {{Mono|diff}}, produced line-by-line changes and even used angle-brackets (">" and "<") for presenting line insertions and deletions in the program's output. The heuristics used in these early applications were, however, deemed unreliable. The potential usefulness of a diff tool provoked McIlroy into researching and designing a more robust tool that could be used in a variety of tasks but perform well in the processing and size limitations of the PDP-11's hardware. His approach to the problem resulted from collaboration also with individuals at Bell Labs including Alfred Aho, Elliot Pinson, Jeffrey Ullman, and Harold S. Stone.
In the context of Unix, the use of the {{Mono|ed}} line editor provided {{Mono|diff}} with the natural ability to create machine-usable "edit scripts". These edit scripts, when saved to a file, can, along with the original file, be reconstituted by {{Mono|ed}} into the modified file in its entirety. This greatly reduced the secondary storage necessary to maintain multiple versions of a file. McIlroy considered writing a post-processor for {{Mono|diff}} where a variety of output formats could be designed and implemented, but he found it more frugal and simpler to have {{Mono|diff}} be responsible for generating the syntax and reverse-order input accepted by the {{Mono|ed}} command.
Late in 1984 Larry Wall created a separate utility, patch,
releasing its source code on the mod.sources and net.sources newsgroups.[5][6][7]
This program generalized and extended the ability to modify files with output from {{Mono|diff}}.
Modes in Emacs also allow for converting the format of patches and even editing patches interactively.
In {{Mono|diff}}'s early years, common uses included comparing changes in the source of software code and markup for technical documents, verifying program debugging output, comparing filesystem listings and analyzing computer assembly code. The output targeted for {{Mono|ed}} was motivated to provide compression for a sequence of modifications made to a file. The Source Code Control System (SCCS) and its ability to archive revisions emerged in the late 1970s as a consequence of storing edit scripts from {{Mono|diff}}.
Algorithm
The operation of {{Mono|diff}} is based on solving the longest common subsequence problem.[4]
In this problem, given two sequences of items:
and we want to find a longest sequence of items that is present in both original sequences in the same order. That is, we want to find a new sequence which can be obtained from the first original sequence by deleting some items, and from the second original sequence by deleting other items. We also want this sequence to be as long as possible. In this case it is
From a longest common subsequence it is only a small step to get {{Mono|diff}}-like output: if an item is absent in the subsequence but present in the first original sequence, it must have been deleted (as indicated by the '-' marks, below). If it is absent in the subsequence but present in the second original sequence, it must have been inserted (as indicated by the '+' marks).
e h i q k r x y + - + - + + + +
Usage
The diff command is invoked from the command line, passing it the names of two files: diff originalnew. The output of the command represents the changes required to transform the original file into the new file.
If original and new are directories, then {{Mono|diff}} will be run on each file that exists in both directories. An option, -r, will recursively descend any matching subdirectories to compare files between directories.
Any of the examples in the article use the following two files, original and new:
{{Col-begin}}{{Col-break|width=33%}}
original:
{{col-break}}
new:
{{col-break|width=33%}}
The command diff original new produces the following normal diff output:
{{pre|
0a1,6
{{font color|darkgreen|> This is an important
> notice! It should
> therefore be located at
> the beginning of this
> document!
>}}
11,15d16
{{font color|darkred|< This paragraph contains
< text that is outdated.
< It will be deleted in the
< near future.
<}}
17c18
{{font color|darkred|< check this dokument. On}} {{font color|darkgreen|> check this document. On}}
24a26,29
{{font color|darkgreen|>
> This paragraph contains
> important new additions
> to this document.}}}}
{{Note2}} Here, the diff output is shown with colors to make it easier to read. The diff utility does not produce colored output; its output is plain text. However, many tools can show the output with colors by using syntax highlighting.{{col-end}}
In this traditional output format, a stands for added, d for deleted and c for changed. Line numbers of the original file appear before a/d/c and those of the new file appear after. The less-than and greater-than signs (at the beginning of lines that are added, deleted or changed) indicate which file the lines appear in. Addition lines are added to the original file to appear in the new file. Deletion lines are deleted from the original file to be missing in the new file.
By default, lines common to both files are not shown. Lines that have moved are shown as added at their new location and as deleted from their old location.[8] However, some diff tools highlight moved lines.
Variations
Changes since 1975 include improvements to the core algorithm, the addition of useful features to the command, and the design of new output formats. The basic algorithm is described in the papers An O(ND) Difference Algorithm and its Variations by Eugene W. Myers[9]
and in A File Comparison Program by Webb Miller and Myers.[10]
The algorithm was independently discovered and described in Algorithms for Approximate String Matching, by Esko Ukkonen.[11]
The first editions of the diff program were designed for line comparisons of text files expecting the newline character to delimit lines. By the 1980s, support for binary files resulted in a shift in the application's design and implementation.
Edit script
An edit script can still be generated by modern versions of diff with the -e option. The resulting edit script for this example is as follows:
24a This paragraph contains important new additions to this document. . 17c check this document. On . 11,15d 0a This is an important notice! It should therefore be located at the beginning of this document! .
In order to transform the content of file original into the content of file new using {{Mono|ed}}, we should append two lines to this diff file, one line containing a w (write) command, and one containing a q (quit) command (e.g. by {{code|lang=bash|printf "w\q\" >> mydiff}}). Here we gave the diff file the name mydiff and the transformation will then happen when we run {{code|lang=bash|ed -s original < mydiff}}.
Context format
The Berkeley distribution of Unix made a point of adding the context format ({{code|-c}}) and the ability to recurse on filesystem directory structures ({{code|-r}}), adding those features in 2.8 BSD, released in July 1981. The context format of diff introduced at Berkeley helped with distributing patches for source code that may have been changed minimally.
In the context format, any changed lines are shown alongside unchanged lines before and after. The inclusion of any number of unchanged lines provides a context to the patch. The context consists of lines that have not changed between the two files and serve as a reference to locate the lines' place in a modified file and find the intended location for a change to be applied regardless of whether the line numbers still correspond. The context format introduces greater readability for humans and reliability when applying the patch, and an output which is accepted as input to the patch program. This intelligent behavior isn't possible with the traditional diff output.
The number of unchanged lines shown above and below a change hunk can be defined by the user, even zero, but three lines is typically the default. If the context of unchanged lines in a hunk overlap with an adjacent hunk, then diff will avoid duplicating the unchanged lines and merge the hunks into a single hunk.
A "{{code|!}}" represents a change between lines that correspond in the two files. A "{{code|+}}" represents the addition of a line, while a blank space represents an unchanged line. At the beginning of the patch is the file information, including the full path and a time stamp delimited by a tab character. At the beginning of each hunk are the line numbers that apply for the corresponding change in the files. A number range appearing between sets of three asterisks applies to the original file, while sets of three dashes apply to the new file. The hunk ranges specify the starting and ending line numbers in the respective file.
The command {{code|diff -c original new}} produces the following output: