[polly] r305464 - [Docs] Add a catch-all file to document workflow & tricks.

[Siddharth Bhat via llvm-commits]

Author: bollu
Date: Thu Jun 15 07:43:12 2017
New Revision: 305464

URL: http://llvm.org/viewvc/llvm-project?rev=305464&view=rev
Log:
[Docs] Add a catch-all file to document workflow & tricks.

- Write about `bugpoint` and `git-svn` for now.

Differential Revision: https://reviews.llvm.org/D34147

Added:
    polly/trunk/docs/TipsAndTricks.rst
Modified:
    polly/trunk/docs/index.rst

Added: polly/trunk/docs/TipsAndTricks.rst
URL: http://llvm.org/viewvc/llvm-project/polly/trunk/docs/TipsAndTricks.rst?rev=305464&view=auto
==============================================================================
--- polly/trunk/docs/TipsAndTricks.rst (added)
+++ polly/trunk/docs/TipsAndTricks.rst Thu Jun 15 07:43:12 2017
@@ -0,0 +1,39 @@
+==================================================
+Tips and Tricks on using and contributing to Polly
+==================================================
+
+Commiting to polly trunk
+------------------------
+    - `General reference to git-svn workflow <https://stackoverflow.com/questions/190431/is-git-svn-dcommit-after-merging-in-git-dangerous>`_
+
+
+Using bugpoint to track down errors in large files
+--------------------------------------------------
+
+    If you know the ``opt`` invocation and have a large ``.ll`` file that causes
+    an error, ``bugpoint`` allows one to reduce the size of test cases.
+
+    The general calling pattern is:
+
+    - ``$ bugpoint <file.ll> <pass that causes the crash> -opt-args <opt option flags>``
+
+    An example invocation is:
+
+    - ``$ bugpoint crash.ll -polly-codegen -opt-args  -polly-canonicalize -polly-process-unprofitable``
+
+    For more documentation on bugpoint, `Visit the LLVM manual <http://llvm.org/docs/Bugpoint.html>`_
+
+
+Understanding which pass makes a particular change
+--------------------------------------------------
+
+    If you know that something like `opt -O3 -polly` makes a change, but you wish to
+    isolate which pass makes a change, the steps are as follows:
+
+    - ``$ bugpoint -O3 file.ll -opt-args -polly``  will allow bugpoint to track down the pass which causes the crash.
+
+    To do this manually:
+
+    - ``$ opt -O3 -polly -debug-pass=Arguments`` to get all passes that are run by default. ``-debug-pass=Arguments`` will list all passes that have run.
+    - Bisect down to the pass that changes it.
+

Modified: polly/trunk/docs/index.rst
URL: http://llvm.org/viewvc/llvm-project/polly/trunk/docs/index.rst?rev=305464&r1=305463&r2=305464&view=diff
==============================================================================
--- polly/trunk/docs/index.rst (original)
+++ polly/trunk/docs/index.rst Thu Jun 15 07:43:12 2017
@@ -24,6 +24,7 @@ Using Polly
    Architecture
    UsingPollyWithClang
    HowToManuallyUseTheIndividualPiecesOfPolly
+   TipsAndTricks
 
 * `A list of Polly passes <http://polly.llvm.org/documentation/passes.html>`_