llvm/docs/*.html: Fix markups.

llvm-svn: 153508
This commit is contained in:
NAKAMURA Takumi 2012-03-27 11:25:16 +00:00
parent cd6d2689a0
commit eb0805cb93
13 changed files with 52 additions and 22 deletions

View File

@ -861,6 +861,8 @@ ret
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="mc">The "MC" Layer</a> <a name="mc">The "MC" Layer</a>

View File

@ -465,7 +465,7 @@ common use case of LLVM as a library linked into a larger application.</p>
<p>Consider the use of LLVM as a JIT linked into another application (perhaps <p>Consider the use of LLVM as a JIT linked into another application (perhaps
for <a href="http://llvm.org/Users.html">OpenGL, custom languages</a>, for <a href="http://llvm.org/Users.html">OpenGL, custom languages</a>,
<a href="http://llvm.org/devmtg/2010-11/Gritz-OpenShadingLang.pdf">shaders in <a href="http://llvm.org/devmtg/2010-11/Gritz-OpenShadingLang.pdf">shaders in
movies</a>, etc</a>). Due to the design of static constructors, they must be movies</a>, etc). Due to the design of static constructors, they must be
executed at startup time of the entire application, regardless of whether or executed at startup time of the entire application, regardless of whether or
how LLVM is used in that larger application. There are two problems with how LLVM is used in that larger application. There are two problems with
this:</p> this:</p>

View File

@ -501,6 +501,8 @@
</h2> </h2>
<!--=========================================================================--> <!--=========================================================================-->
<div>
<div class="doc_notes"> <div class="doc_notes">
<p style="text-align:center;font-weight:bold">NOTE: This section deals with <p style="text-align:center;font-weight:bold">NOTE: This section deals with
legal matters but does not provide legal advice. We are not lawyers &mdash; legal matters but does not provide legal advice. We are not lawyers &mdash;
@ -622,6 +624,8 @@
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<hr> <hr>
<address> <address>

View File

@ -497,6 +497,8 @@
</div> </div>
</div>
<!-- ======================================================================= --> <!-- ======================================================================= -->
<h2> <h2>
<a name="asm">Asm Table Formats</a> <a name="asm">Asm Table Formats</a>

View File

@ -140,6 +140,8 @@
</h2> </h2>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<div>
<div class="question"> <div class="question">
<p>Why are the LLVM source code and the front-end distributed under different <p>Why are the LLVM source code and the front-end distributed under different
licenses?</p> licenses?</p>
@ -185,12 +187,16 @@
GPL, as explained in the first question above.</p> GPL, as explained in the first question above.</p>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="source">Source Code</a> <a name="source">Source Code</a>
</h2> </h2>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<div>
<div class="question"> <div class="question">
<p>In what language is LLVM written?</p> <p>In what language is LLVM written?</p>
</div> </div>
@ -223,12 +229,16 @@ LLVM have been ported to a plethora of platforms.</p>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="build">Build Problems</a> <a name="build">Build Problems</a>
</h2> </h2>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<div>
<div class="question"> <div class="question">
<p>When I run configure, it finds the wrong C compiler.</p> <p>When I run configure, it finds the wrong C compiler.</p>
</div> </div>
@ -435,11 +445,15 @@ Stop.
<p>We regret the inconvenience.</p> <p>We regret the inconvenience.</p>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="felangs">Source Languages</a> <a name="felangs">Source Languages</a>
</h2> </h2>
<div>
<div class="question"> <div class="question">
<p><a name="langs">What source languages are supported?</a></p> <p><a name="langs">What source languages are supported?</a></p>
</div> </div>
@ -540,11 +554,15 @@ Stop.
Instruction</a>.</p> Instruction</a>.</p>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="cfe">Using the GCC Front End</a> <a name="cfe">Using the GCC Front End</a>
</h2> </h2>
<div>
<div class="question"> <div class="question">
<p>When I compile software that uses a configure script, the configure script <p>When I compile software that uses a configure script, the configure script
thinks my system has all of the header files and libraries it is testing for. thinks my system has all of the header files and libraries it is testing for.
@ -697,11 +715,15 @@ Stop.
order to have the result conform to the platform ABI.</p> order to have the result conform to the platform ABI.</p>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="cfe_code">Questions about code generated by the GCC front-end</a> <a name="cfe_code">Questions about code generated by the GCC front-end</a>
</h2> </h2>
<div>
<div class="question"> <div class="question">
<p><a name="iosinit">What is this <tt>llvm.global_ctors</tt> and <p><a name="iosinit">What is this <tt>llvm.global_ctors</tt> and
<tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I <tt>#include <tt>_GLOBAL__I__tmp_webcompile...</tt> stuff that happens when I <tt>#include
@ -907,6 +929,8 @@ F.i:
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<hr> <hr>

View File

@ -155,8 +155,8 @@ also be a good place to start.</p>
<li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li> <li><tt>cd <i>where-you-want-to-build-llvm</i></tt></li>
<li><tt>mkdir build</tt> (for building without polluting the source dir)</li> <li><tt>mkdir build</tt> (for building without polluting the source dir)</li>
<li><tt>cd build</tt></li> <li><tt>cd build</tt></li>
<li><tt>../llvm/configure [options]</tt></li> <li><tt>../llvm/configure [options]</tt>
Some common options: <br>Some common options:
<ul> <ul>
<li><tt>--prefix=<i>directory</i></tt> - <li><tt>--prefix=<i>directory</i></tt> -
@ -174,7 +174,7 @@ also be a good place to start.</p>
<li><tt>--enable-assertions</tt> - <li><tt>--enable-assertions</tt> -
Compile with assertion checks enabled (default is YES).</li> Compile with assertion checks enabled (default is YES).</li>
</ul> </ul>
</li>
<li><tt>make [-j]</tt> - The -j specifies the number of jobs (commands) to <li><tt>make [-j]</tt> - The -j specifies the number of jobs (commands) to
run simultaneously. This builds both LLVM and Clang for Debug+Asserts mode. run simultaneously. This builds both LLVM and Clang for Debug+Asserts mode.
The --enabled-optimized configure option is used to specify a Release build.</li> The --enabled-optimized configure option is used to specify a Release build.</li>
@ -192,7 +192,6 @@ also be a good place to start.</p>
</ul> </ul>
</li> </li>
</ol>
</ol> </ol>

View File

@ -171,7 +171,7 @@ name = Linker
parent = Libraries parent = Libraries
required_libraries = Archive BitReader Core Support TransformUtils required_libraries = Archive BitReader Core Support TransformUtils
</pre> </pre>
</div class="doc_code"> </div>
<p>A full description of the exact sections and properties which are allowed <p>A full description of the exact sections and properties which are allowed
follows.</p> follows.</p>

View File

@ -3029,6 +3029,8 @@ call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
</pre> </pre>
</div> </div>
</div>
<!-- _______________________________________________________________________ --> <!-- _______________________________________________________________________ -->
<h4> <h4>
<a name="range">'<tt>range</tt>' Metadata</a> <a name="range">'<tt>range</tt>' Metadata</a>
@ -3066,8 +3068,6 @@ call void @llvm.dbg.value(metadata !24, i64 0, metadata !25)
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<h2> <h2>
<a name="module_flags">Module Flags Metadata</a> <a name="module_flags">Module Flags Metadata</a>

View File

@ -2567,7 +2567,7 @@ block but not delete it, you can use the <tt>removeFromParent()</tt> method.</p>
<div> <div>
<p><i>Replacing individual instructions</i></p> <h5><i>Replacing individual instructions</i></h5>
<p>Including "<a href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h</a>" <p>Including "<a href="/doxygen/BasicBlockUtils_8h-source.html">llvm/Transforms/Utils/BasicBlockUtils.h</a>"
permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt> permits use of two very useful replace functions: <tt>ReplaceInstWithValue</tt>
@ -2575,6 +2575,7 @@ and <tt>ReplaceInstWithInst</tt>.</p>
<h5><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h5> <h5><a name="schanges_deleting">Deleting <tt>Instruction</tt>s</a></h5>
<div>
<ul> <ul>
<li><tt>ReplaceInstWithValue</tt> <li><tt>ReplaceInstWithValue</tt>
@ -2611,7 +2612,9 @@ ReplaceInstWithInst(instToReplace-&gt;getParent()-&gt;getInstList(), ii,
</pre></div></li> </pre></div></li>
</ul> </ul>
<p><i>Replacing multiple uses of <tt>User</tt>s and <tt>Value</tt>s</i></p> </div>
<h5><i>Replacing multiple uses of <tt>User</tt>s and <tt>Value</tt>s</i></h5>
<p>You can use <tt>Value::replaceAllUsesWith</tt> and <p>You can use <tt>Value::replaceAllUsesWith</tt> and
<tt>User::replaceUsesOfWith</tt> to change more than one use at a time. See the <tt>User::replaceUsesOfWith</tt> to change more than one use at a time. See the
@ -3305,13 +3308,12 @@ helpful member functions that try to make common operations easy.</p>
<div> <div>
<ul> <ul>
<li><tt>Module::Module(std::string name = "")</tt></li> <li><tt>Module::Module(std::string name = "")</tt>
</ul>
<p>Constructing a <a href="#Module">Module</a> is easy. You can optionally <p>Constructing a <a href="#Module">Module</a> is easy. You can optionally
provide a name for it (probably based on the name of the translation unit).</p> provide a name for it (probably based on the name of the translation unit).</p>
</li>
<ul>
<li><tt>Module::iterator</tt> - Typedef for function list iterator<br> <li><tt>Module::iterator</tt> - Typedef for function list iterator<br>
<tt>Module::const_iterator</tt> - Typedef for const_iterator.<br> <tt>Module::const_iterator</tt> - Typedef for const_iterator.<br>

View File

@ -403,7 +403,6 @@ Release Notes</a>.</h1>
<li>On Darwin, the ARM target now has a full-featured integrated assembler. <li>On Darwin, the ARM target now has a full-featured integrated assembler.
</li> </li>
</ul> </ul>
</div>
<h4> <h4>
<a name="armintegratedassembler">ARM Integrated Assembler</a> <a name="armintegratedassembler">ARM Integrated Assembler</a>
@ -420,6 +419,8 @@ subtarget and CPU specific extensions for VFP2, VFP3 and NEON.</p>
<p>The assembler is Unified Syntax only (see ARM Architecural Reference Manual <p>The assembler is Unified Syntax only (see ARM Architecural Reference Manual
for details). While there is some, and growing, support for pre-unfied (divided) for details). While there is some, and growing, support for pre-unfied (divided)
syntax, there are still significant gaps in that support.</p> syntax, there are still significant gaps in that support.</p>
</div>
</div> </div>
<!--=========================================================================--> <!--=========================================================================-->
<h3> <h3>
@ -521,8 +522,6 @@ syntax, there are still significant gaps in that support.</p>
</div> </div>
</div>
<!--=========================================================================--> <!--=========================================================================-->
<h3> <h3>
<a name="tools_changes">Tools Changes</a> <a name="tools_changes">Tools Changes</a>

View File

@ -2164,16 +2164,15 @@ The DWARF for this would be:
</tr> </tr>
</table> </table>
</div>
</div> </div>
</div> </div>
<div>
<!-- ======================================================================= --> <!-- ======================================================================= -->
<h3> <h3>
<a name="acceltable">Name Accelerator Tables</a> <a name="acceltable">Name Accelerator Tables</a>
</h3> </h3>
<!-- ======================================================================= --> <!-- ======================================================================= -->
<div>
<!-- ======================================================================= --> <!-- ======================================================================= -->
<h4> <h4>
<a name="acceltableintroduction">Introduction</a> <a name="acceltableintroduction">Introduction</a>
@ -2842,6 +2841,7 @@ int main ()
</ul> </ul>
</div> </div>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->

View File

@ -420,7 +420,7 @@ which case the user must specify it explicitly.</dd>
<dt><tt>str1#str2</tt></dt> <dt><tt>str1#str2</tt></dt>
<dd>"#" (paste) is a shorthand for !strconcat. It may concatenate <dd>"#" (paste) is a shorthand for !strconcat. It may concatenate
things that are not quoted strings, in which case an implicit things that are not quoted strings, in which case an implicit
!cast<string> is done on the operand of the paste.</dd> !cast&lt;string&gt; is done on the operand of the paste.</dd>
<dt><tt>!cast&lt;type&gt;(a)</tt></dt> <dt><tt>!cast&lt;type&gt;(a)</tt></dt>
<dd>A symbol of type <em>type</em> obtained by looking up the string 'a' in <dd>A symbol of type <em>type</em> obtained by looking up the string 'a' in
the symbol table. If the type of 'a' does not match <em>type</em>, TableGen the symbol table. If the type of 'a' does not match <em>type</em>, TableGen

View File

@ -889,8 +889,6 @@ understand the Makefile based setup.</p>
the <a href="TestSuiteMakefileGuide.html">Test Suite Makefile Guide.</a></p> the <a href="TestSuiteMakefileGuide.html">Test Suite Makefile Guide.</a></p>
</div> </div>
</div>
<!-- *********************************************************************** --> <!-- *********************************************************************** -->
<hr> <hr>