diff --git a/docs/CommandGuide/bugpoint.html b/docs/CommandGuide/bugpoint.html index 8d83863d9db..04f45b57243 100644 --- a/docs/CommandGuide/bugpoint.html +++ b/docs/CommandGuide/bugpoint.html @@ -105,6 +105,35 @@ being miscompiled. This module assumes that the selected code generator is working properly.

+ +

Advice for using bugpoint

+ +bugpoint can be a remarkably useful tool, but it sometimes works in +non-obvious ways. Here are some hints and tips:

+ +

    +
  1. In code generator and miscompilation debugging modes, bugpoint only + works with programs that have deterministic output. Thus, if the program + outputs the date, time, or any other "random" data, it should be masked out. + +
  2. In code generator and miscompilation debugging modes, debugging will go + faster if you manually modify the program or its inputs to reduce the + runtime, but still exhibit the problem. + +
  3. bugpoint is extremely useful when working on a new optimization: + it helps track down regressions quickly. To avoid having to relink + bugpoint every time you change your optization however, have + bugpoint dynamically load your optimization with the -load option. + +
  4. bugpoint can generate a lot of output and run for a long period of + time. It is often useful to capture the output of the program to file. For + example:
    + bugpoint ..... |& tee bugpoint.log

    + +

+ +

OPTIONS