X-Git-Url: http://demsky.eecs.uci.edu/git/?a=blobdiff_plain;f=docs%2FBugpoint.rst;h=6bd7ff99564ffd3631606211c159f7517cd7d5ba;hb=3b50e969941556504036a65415d95d1b0ad45ee3;hp=9ccf0cc2d9d66f8eee1d01f969a8e822960a35c9;hpb=d372ee265da3a9975f89a3a95a51c9e3bd660edd;p=oota-llvm.git diff --git a/docs/Bugpoint.rst b/docs/Bugpoint.rst index 9ccf0cc2d9d..6bd7ff99564 100644 --- a/docs/Bugpoint.rst +++ b/docs/Bugpoint.rst @@ -1,5 +1,3 @@ -.. _bugpoint: - ==================================== LLVM bugpoint tool: design and usage ==================================== @@ -19,7 +17,7 @@ optimization (or combination of optimizations) that causes the crash, and reduce the file down to a small example which triggers the crash. For detailed case scenarios, such as debugging ``opt``, or one of the LLVM code -generators, see `How To Submit a Bug Report document `_. +generators, see :doc:`HowToSubmitABug`. Design Philosophy ================= @@ -136,9 +134,9 @@ non-obvious ways. Here are some hints and tips: It is often useful to capture the output of the program to file. For example, in the C shell, you can run: - .. code-block:: bash + .. code-block:: console - bugpoint ... |& tee bugpoint.log + $ bugpoint ... |& tee bugpoint.log to get a copy of ``bugpoint``'s output in the file ``bugpoint.log``, as well as on your terminal. @@ -210,7 +208,7 @@ point---a simple binary search may not be sufficient, as transformations that interact may require isolating more than one call. In TargetLowering, use ``return SDNode();`` instead of ``return false;``. -Now that that the number of transformations is down to a manageable number, try +Now that the number of transformations is down to a manageable number, try examining the output to see if you can figure out which transformations are being done. If that can be figured out, then do the usual debugging. If which code corresponds to the transformation being performed isn't obvious, set a