usr.bin/clang/llvm-diff/llvm-diff.1

   1 .\" $FreeBSD$
   2 .TH "LLVM-DIFF" "1" "2013-04-11" "3.3" "LLVM"
   3 .SH NAME
   4 llvm-diff \- LLVM structural 'diff'
   5 .
   6 .nr rst2man-indent-level 0
   7 .
   8 .de1 rstReportMargin
   9 \\$1 \\n[an-margin]
  10 level \\n[rst2man-indent-level]
  11 level margin: \\n[rst2man-indent\\n[rst2man-indent-level]]
  12 -
  13 \\n[rst2man-indent0]
  14 \\n[rst2man-indent1]
  15 \\n[rst2man-indent2]
  16 ..
  17 .de1 INDENT
  18 .\" .rstReportMargin pre:
  19 . RS \\$1
  20 . nr rst2man-indent\\n[rst2man-indent-level] \\n[an-margin]
  21 . nr rst2man-indent-level +1
  22 .\" .rstReportMargin post:
  23 ..
  24 .de UNINDENT
  25 . RE
  26 .\" indent \\n[an-margin]
  27 .\" old: \\n[rst2man-indent\\n[rst2man-indent-level]]
  28 .nr rst2man-indent-level -1
  29 .\" new: \\n[rst2man-indent\\n[rst2man-indent-level]]
  30 .in \\n[rst2man-indent\\n[rst2man-indent-level]]u
  31 ..
  32 .\" Man page generated from reStructuredText.
  33 .
  34 .SH SYNOPSIS
  35 .sp
  36 \fBllvm\-diff\fP [\fIoptions\fP] \fImodule 1\fP \fImodule 2\fP [\fIglobal name ...\fP]
  37 .SH DESCRIPTION
  38 .sp
  39 \fBllvm\-diff\fP compares the structure of two LLVM modules, primarily
  40 focusing on differences in function definitions.  Insignificant
  41 differences, such as changes in the ordering of globals or in the
  42 names of local values, are ignored.
  43 .sp
  44 An input module will be interpreted as an assembly file if its name
  45 ends in \(aq.ll\(aq;  otherwise it will be read in as a bitcode file.
  46 .sp
  47 If a list of global names is given, just the values with those names
  48 are compared; otherwise, all global values are compared, and
  49 diagnostics are produced for globals which only appear in one module
  50 or the other.
  51 .sp
  52 \fBllvm\-diff\fP compares two functions by comparing their basic blocks,
  53 beginning with the entry blocks.  If the terminators seem to match,
  54 then the corresponding successors are compared; otherwise they are
  55 ignored.  This algorithm is very sensitive to changes in control flow,
  56 which tend to stop any downstream changes from being detected.
  57 .sp
  58 \fBllvm\-diff\fP is intended as a debugging tool for writers of LLVM
  59 passes and frontends.  It does not have a stable output format.
  60 .SH EXIT STATUS
  61 .sp
  62 If \fBllvm\-diff\fP finds no differences between the modules, it will exit
  63 with 0 and produce no output.  Otherwise it will exit with a non\-zero
  64 value.
  65 .SH BUGS
  66 .sp
  67 Many important differences, like changes in linkage or function
  68 attributes, are not diagnosed.
  69 .sp
  70 Changes in memory behavior (for example, coalescing loads) can cause
  71 massive detected differences in blocks.
  72 .SH AUTHOR
  73 Maintained by The LLVM Team (http://llvm.org/).
  74 .SH COPYRIGHT
  75 2003-2013, LLVM Project
  76 .\" Generated by docutils manpage writer.
  77 .