diff options
author | Bill Wendling <isanbard@gmail.com> | 2010-09-07 23:32:02 +0000 |
---|---|---|
committer | Bill Wendling <isanbard@gmail.com> | 2010-09-07 23:32:02 +0000 |
commit | c9a2cd0ab785b487949ec61cec86b559b23ea2c6 (patch) | |
tree | d1246887c2b98505851ecb1b3e2f62772cc5c83c | |
parent | 75e5c50b37dbf24b251cd07940225b41e510ab58 (diff) | |
download | llvm-c9a2cd0ab785b487949ec61cec86b559b23ea2c6.zip llvm-c9a2cd0ab785b487949ec61cec86b559b23ea2c6.tar.gz llvm-c9a2cd0ab785b487949ec61cec86b559b23ea2c6.tar.bz2 |
$ svn merge -c 113303 https://llvm.org/svn/llvm-project/llvm/trunk
--- Merging r113303 into '.':
A docs/CommandGuide/llvm-diff.pod
U docs/CommandGuide/index.html
Log:
Add documentation for llvm-diff.
llvm-svn: 113310
-rw-r--r-- | llvm/docs/CommandGuide/index.html | 3 | ||||
-rw-r--r-- | llvm/docs/CommandGuide/llvm-diff.pod | 53 |
2 files changed, 56 insertions, 0 deletions
diff --git a/llvm/docs/CommandGuide/index.html b/llvm/docs/CommandGuide/index.html index 72cd2cf..8854fbb 100644 --- a/llvm/docs/CommandGuide/index.html +++ b/llvm/docs/CommandGuide/index.html @@ -72,6 +72,9 @@ options) arguments to the tool you are interested in.</p> <li><a href="/cmds/llvmc.html"><b>llvmc</b></a> - a generic customizable compiler driver</li> +<li><a href="/cmds/llvm-diff.html"><b>llvm-diff</b></a> - + structurally compare two modules</li> + </ul> </div> diff --git a/llvm/docs/CommandGuide/llvm-diff.pod b/llvm/docs/CommandGuide/llvm-diff.pod new file mode 100644 index 0000000..c8cfdb3 --- /dev/null +++ b/llvm/docs/CommandGuide/llvm-diff.pod @@ -0,0 +1,53 @@ +=pod + +=head1 NAME + +llvm-diff - LLVM structural 'diff' + +=head1 SYNOPSIS + +B<llvm-diff> [I<options>] I<module 1> I<module 2> [I<global name ...>] + +=head1 DESCRIPTION + +B<llvm-diff> compares the structure of two LLVM modules, primarily +focusing on differences in function definitions. Insignificant +differences, such as changes in the ordering of globals or in the +names of local values, are ignored. + +An input module will be interpreted as an assembly file if its name +ends in '.ll'; otherwise it will be read in as a bitcode file. + +If a list of global names is given, just the values with those names +are compared; otherwise, all global values are compared, and +diagnostics are produced for globals which only appear in one module +or the other. + +B<llvm-diff> compares two functions by comparing their basic blocks, +beginning with the entry blocks. If the terminators seem to match, +then the corresponding successors are compared; otherwise they are +ignored. This algorithm is very sensitive to changes in control flow, +which tend to stop any downstream changes from being detected. + +B<llvm-diff> is intended as a debugging tool for writers of LLVM +passes and frontends. It does not have a stable output format. + +=head1 EXIT STATUS + +If B<llvm-diff> finds no differences between the modules, it will exit +with 0 and produce no output. Otherwise it will exit with a non-zero +value. + +=head1 BUGS + +Many important differences, like changes in linkage or function +attributes, are not diagnosed. + +Changes in memory behavior (for example, coalescing loads) can cause +massive detected differences in blocks. + +=head1 AUTHORS + +Maintained by the LLVM Team (L<http://llvm.org>). + +=cut |