[llvm-commits] [polly] r144287 - /polly/trunk/www/example_load_Polly_into_clang.html

[Tobias Grosser]

Author: grosser
Date: Thu Nov 10 08:00:00 2011
New Revision: 144287

URL: http://llvm.org/viewvc/llvm-project?rev=144287&view=rev
Log:
www: Highlight command line flags

Modified:
    polly/trunk/www/example_load_Polly_into_clang.html

Modified: polly/trunk/www/example_load_Polly_into_clang.html
URL: http://llvm.org/viewvc/llvm-project/polly/trunk/www/example_load_Polly_into_clang.html?rev=144287&r1=144286&r2=144287&view=diff
==============================================================================
--- polly/trunk/www/example_load_Polly_into_clang.html (original)
+++ polly/trunk/www/example_load_Polly_into_clang.html Thu Nov 10 08:00:00 2011
@@ -22,8 +22,8 @@
 database</a> and consider reporting the bug.
 <h2>Compiling code with Polly</h2>
 
-To compile code with Polly you only need to add '-Xclang -load -Xclang
-${POLLY_BUILD_DIR}/lib/LLVMPolly.so' to your command line or your CFLAGS and
+To compile code with Polly you only need to add <b>-Xclang -load -Xclang
+${POLLY_BUILD_DIR}/lib/LLVMPolly.so</b> to your command line or your CFLAGS and
 Polly is automatically executed at -O3.
 
 <p>
@@ -36,14 +36,14 @@
 <h2>Automatic OpenMP code generation</h2>
 
 To automatically detect parallel loops and generate OpenMP code for them you
-also need to add '-mllvm -enable-polly-openmp -lgomp' to your CFLAGS.
+also need to add <b>-mllvm -enable-polly-openmp -lgomp</b> to your CFLAGS.
 
 <pre class="code">clang -Xclang -load -Xclang ${POLLY_BUILD_DIR}/lib/LLVMPolly.so -O3 -mllvm -enable-polly-openmp -lgomp file.c</pre>
 
 <h2>Automatic Vector code generation</h2>
 
-Automatic vector code generation can be enabled by adding '-mllvm
--enable-polly-vector' to your CFLAGS.
+Automatic vector code generation can be enabled by adding <b>-mllvm
+-enable-polly-vector</b> to your CFLAGS.
 
 <pre class="code">clang -Xclang -load -Xclang ${POLLY_BUILD_DIR}/lib/LLVMPolly.so -O3 -mllvm -enable-polly-vector file.c</pre>
 
@@ -51,24 +51,24 @@
 
 Polly supports further options that are mainly useful for the development or
 the
-analysis of Polly. The relevant options can be
-added to clang by appending '-mllvm -option-name' to the CFLAGS or the clang
+analysis of Polly. The relevant options can be added to clang by appending
+<b>-mllvm -option-name</b> to the CFLAGS or the clang
 command line.
 
 <h3>Limit Polly to a single function</h3>
 To limit the execution of Polly to a single function, use the option
-'-polly-detect-only=functionname'.
+<b>-polly-detect-only=functionname</b>.
 
 <h3>Disable LLVM-IR generation</h3>
 Polly normally regenerates LLVM-IR from the Polyhedral representation. To only
 see the effects of the preparing transformation, but to disable Polly code
-generation add the option 'polly-no-codegen'.
+generation add the option <b>polly-no-codegen</b>.
 
 <h3>Graphical view of the SCoPs</h3>
 
 Polly can use graphviz to show the SCoPs it detects in a program. The relevant
-options are '-polly-show', '-polly-show-only', '-polly-dot' and
-'-polly-dot-only'. The 'show' options automatically run dotty or another
+options are <b>-polly-show</b>, <b>-polly-show-only</b>, <b>-polly-dot</b> and
+<b>-polly-dot-only</b>. The 'show' options automatically run dotty or another
 graphviz viewer to show the scops graphically. The 'dot' options store for each
 function a dot file that highlights the detected SCoPs. If 'only' is appended at
 the end of the option, the basic blocks are shown without the statements the
@@ -76,8 +76,8 @@
 
 <h3>Disable the polyhedral optimizer</h3>
 
-Polly automatically runs a polyhedral optimizer to optimize the schedules. To
-disable it add the option '-polly-no-optimizer'.
+Polly automatically runs by default a polyhedral optimizer to optimize the
+schedules. <b>-polly-no-optimizer</b> disables this optimizer.
 
 <h3>Use the PoCC optimizer</h3>
 Polly uses by default the isl scheduling optimizer, a new implementation of the
@@ -85,20 +85,20 @@
 default is that it does not require any additional libraries or tools to be
 installed. As the new scheduler may still have some bugs and because being
 able to compare is good in general, it is possible to switch the used optimizer
-back to PoCC. For this add the option '-polly-use-pocc'.
+back to PoCC. For this add the option <b>-polly-use-pocc</b>.
 
 <h3>Disable tiling in the optimizer</h3>
 By default both optimizers perform tiling, if possible. In case this is not
-wanted the option '-polly-no-tiling' can be used to disable it. (This option
-works for both optimizers).
+wanted the option <b>-polly-no-tiling</b> can be used to disable it. (This
+option disables tiling for both optimizers).
 
 <h3>Ignore possible aliasing</h3>
 By default we only detect scops, if we can prove that the different array bases
-can not alias. This is the correct thing to do if optimizing automatically.
-However, this may yield to a low scop coverage as without special user
-annotations like 'restrict' the absence of aliasing can often not be proven.
-When optimizing code where we know no aliasing can happen, we may want to remove
-this restriction.
+can not alias. This is correct do if we optimize automatically.  However,
+without special user annotations like 'restrict' we can often not prove that
+no aliasing is possible. In case the user knows no aliasing can happen in the
+code the <b>-polly-ignore-aliasing</b> can be used to disable the check for
+possible aliasing.
 </div>
 </body>
 </html>