aboutsummaryrefslogtreecommitdiffstats
path: root/docs/GettingStarted.html
diff options
context:
space:
mode:
Diffstat (limited to 'docs/GettingStarted.html')
-rw-r--r--docs/GettingStarted.html153
1 files changed, 92 insertions, 61 deletions
diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html
index d670611..2bca7ae 100644
--- a/docs/GettingStarted.html
+++ b/docs/GettingStarted.html
@@ -8,9 +8,9 @@
</head>
<body>
-<div class="doc_title">
+<h1>
Getting Started with the LLVM System
-</div>
+</h1>
<ul>
<li><a href="#overview">Overview</a>
@@ -70,9 +70,9 @@
<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="overview"><b>Overview</b></a>
-</div>
+<h2>
+ <a name="overview">Overview</a>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -102,9 +102,9 @@ and performance.
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="quickstart"><b>Getting Started Quickly (A Summary)</b></a>
-</div>
+<h2>
+ <a name="quickstart">Getting Started Quickly (A Summary)</a>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -191,9 +191,9 @@ Layout</a> to learn about the layout of the source code tree.</p>
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="requirements"><b>Requirements</b></a>
-</div>
+<h2>
+ <a name="requirements">Requirements</a>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -205,9 +205,9 @@ software you will need.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
- <a name="hardware"><b>Hardware</b></a>
-</div>
+<h3>
+ <a name="hardware">Hardware</a>
+</h3>
<div class="doc_text">
@@ -370,7 +370,9 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="software"><b>Software</b></a></div>
+<h3>
+ <a name="software">Software</a>
+</h3>
<div class="doc_text">
<p>Compiling LLVM requires that you have several software packages
installed. The table below lists those required packages. The Package column
@@ -508,9 +510,9 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="brokengcc">Broken versions of GCC and other tools</a>
-</div>
+</h3>
<div class="doc_text">
@@ -608,9 +610,9 @@ upgrading to a newer version of Gold.</p>
<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="starting"><b>Getting Started with LLVM</b></a>
-</div>
+<h2>
+ <a name="starting">Getting Started with LLVM</a>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -626,9 +628,9 @@ help via e-mail.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="terminology">Terminology and Notation</a>
-</div>
+</h3>
<div class="doc_text">
@@ -663,9 +665,9 @@ All these paths are absolute:</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="environment">Setting Up Your Environment</a>
-</div>
+</h3>
<div class="doc_text">
@@ -686,9 +688,9 @@ variables.
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="unpack">Unpacking the LLVM Archives</a>
-</div>
+</h3>
<div class="doc_text">
@@ -720,9 +722,9 @@ compressed with the gzip program.
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="checkout">Checkout LLVM from Subversion</a>
-</div>
+</h3>
<div class="doc_text">
@@ -791,9 +793,9 @@ instructions</a> to successfully get and build the LLVM GCC front-end.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="git_mirror">GIT mirror</a>
-</div>
+</h3>
<div class="doc_text">
@@ -810,9 +812,9 @@ instructions</a> to successfully get and build the LLVM GCC front-end.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="installcf">Install the GCC Front End</a>
-</div>
+</h3>
<div class="doc_text">
@@ -880,9 +882,9 @@ please let us know how you would like to see things improved by dropping us a no
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="config">Local LLVM Configuration</a>
-</div>
+</h3>
<div class="doc_text">
@@ -1002,9 +1004,9 @@ script to configure the build system:</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="compile">Compiling the LLVM Suite Source Code</a>
-</div>
+</h3>
<div class="doc_text">
@@ -1136,9 +1138,9 @@ that directory that is out of date.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="cross-compile">Cross-Compiling LLVM</a>
-</div>
+</h3>
<div class="doc_text">
<p>It is possible to cross-compile LLVM itself. That is, you can create LLVM
@@ -1154,9 +1156,9 @@ that directory that is out of date.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="objfiles">The Location of LLVM Object Files</a>
-</div>
+</h3>
<div class="doc_text">
@@ -1214,9 +1216,9 @@ named after the build type:</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection">
+<h3>
<a name="optionalconfig">Optional Configuration Items</a>
-</div>
+</h3>
<div class="doc_text">
@@ -1250,9 +1252,9 @@ $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
- <a name="layout"><b>Program Layout</b></a>
-</div>
+<h2>
+ <a name="layout">Program Layout</a>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -1265,14 +1267,20 @@ The following is a brief introduction to code layout:</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="examples"><tt>llvm/examples</tt></a></div>
+<h3>
+ <a name="examples"><tt>llvm/examples</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains some simple examples of how to use the LLVM IR and
JIT.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="include"><tt>llvm/include</tt></a></div>
+<h3>
+ <a name="include"><tt>llvm/include</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains public header files exported from the LLVM
@@ -1300,7 +1308,10 @@ library. The three main subdirectories of this directory are:</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="lib"><tt>llvm/lib</tt></a></div>
+<h3>
+ <a name="lib"><tt>llvm/lib</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains most of the source files of the LLVM system. In LLVM,
@@ -1366,7 +1377,10 @@ different <a href="#tools">tools</a>.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="projects"><tt>llvm/projects</tt></a></div>
+<h3>
+ <a name="projects"><tt>llvm/projects</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains projects that are not strictly part of LLVM but are
shipped with LLVM. This is also the directory where you should create your own
@@ -1375,7 +1389,10 @@ different <a href="#tools">tools</a>.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="runtime"><tt>llvm/runtime</tt></a></div>
+<h3>
+ <a name="runtime"><tt>llvm/runtime</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains libraries which are compiled into LLVM bitcode and
@@ -1389,7 +1406,10 @@ end to compile.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="test"><tt>llvm/test</tt></a></div>
+<h3>
+ <a name="test"><tt>llvm/test</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains feature and regression tests and other basic sanity
checks on the LLVM infrastructure. These are intended to run quickly and cover
@@ -1397,7 +1417,10 @@ end to compile.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="test-suite"><tt>test-suite</tt></a></div>
+<h3>
+ <a name="test-suite"><tt>test-suite</tt></a>
+</h3>
+
<div class="doc_text">
<p>This is not a directory in the normal llvm module; it is a separate
Subversion
@@ -1413,7 +1436,10 @@ end to compile.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="tools"><tt>llvm/tools</tt></a></div>
+<h3>
+ <a name="tools"><tt>llvm/tools</tt></a>
+</h3>
+
<div class="doc_text">
<p>The <b>tools</b> directory contains the executables built out of the
@@ -1498,7 +1524,10 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="utils"><tt>llvm/utils</tt></a></div>
+<h3>
+ <a name="utils"><tt>llvm/utils</tt></a>
+</h3>
+
<div class="doc_text">
<p>This directory contains utilities for working with LLVM source code, and some
@@ -1561,9 +1590,9 @@ are code generators for parts of LLVM infrastructure.</p>
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="tutorial">An Example Using the LLVM Tool Chain</a>
-</div>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -1580,7 +1609,9 @@ output.</p>
</div>
<!-- ======================================================================= -->
-<div class="doc_subsection"><a name="tutorial4">Example with llvm-gcc4</a></div>
+<h3>
+ <a name="tutorial4">Example with llvm-gcc4</a>
+</h3>
<div class="doc_text">
@@ -1665,9 +1696,9 @@ int main() {
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="problems">Common Problems</a>
-</div>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
@@ -1679,9 +1710,9 @@ Asked Questions</a> page.</p>
</div>
<!-- *********************************************************************** -->
-<div class="doc_section">
+<h2>
<a name="links">Links</a>
-</div>
+</h2>
<!-- *********************************************************************** -->
<div class="doc_text">
generated by cgit v1.1 at 2024-07-13 05:38:42 +0000