diff options
Diffstat (limited to 'docs/GettingStarted.html')
| -rw-r--r-- | docs/GettingStarted.html | 77 |
1 files changed, 38 insertions, 39 deletions
diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index 2bca7ae643..7360893520 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -75,7 +75,7 @@ </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Welcome to LLVM! In order to get started, you first need to know some basic information.</p> @@ -107,7 +107,7 @@ and performance. </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Here's the short story for getting up and running quickly with LLVM:</p> @@ -196,20 +196,18 @@ Layout</a> to learn about the layout of the source code tree.</p> </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>Before you begin to use the LLVM system, review the requirements given below. This may save you some trouble by knowing ahead of time what hardware and software you will need.</p> -</div> - <!-- ======================================================================= --> <h3> <a name="hardware">Hardware</a> </h3> -<div class="doc_text"> +<div> <p>LLVM is known to work on the following platforms:</p> @@ -373,7 +371,7 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> <h3> <a name="software">Software</a> </h3> -<div class="doc_text"> +<div> <p>Compiling LLVM requires that you have several software packages installed. The table below lists those required packages. The Package column is the usual name for the software package that LLVM depends on. The Version @@ -514,7 +512,7 @@ href="GCCFEBuildInstrs.html">try to compile it</a> on your platform.</p> <a name="brokengcc">Broken versions of GCC and other tools</a> </h3> -<div class="doc_text"> +<div> <p>LLVM is very demanding of the host C++ compiler, and as such tends to expose bugs in the compiler. In particular, several versions of GCC crash when trying @@ -607,7 +605,7 @@ upgrading to a newer version of Gold.</p> </div> - +</div> <!-- *********************************************************************** --> <h2> @@ -615,7 +613,7 @@ upgrading to a newer version of Gold.</p> </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>The remainder of this guide is meant to get you up and running with LLVM and to give you some basic information about the LLVM environment.</p> @@ -625,14 +623,13 @@ href="#layout">general layout</a> of the the LLVM source tree, a <a href="#tutorial">simple example</a> using the LLVM tool chain, and <a href="#links">links</a> to find more information about LLVM or to get help via e-mail.</p> -</div> <!-- ======================================================================= --> <h3> <a name="terminology">Terminology and Notation</a> </h3> -<div class="doc_text"> +<div> <p>Throughout this manual, the following names are used to denote paths specific to the local system and working environment. <i>These are not @@ -669,7 +666,7 @@ All these paths are absolute:</p> <a name="environment">Setting Up Your Environment</a> </h3> -<div class="doc_text"> +<div> <p> In order to compile and use LLVM, you may need to set some environment @@ -692,7 +689,7 @@ variables. <a name="unpack">Unpacking the LLVM Archives</a> </h3> -<div class="doc_text"> +<div> <p> If you have the LLVM distribution, you will need to unpack it before you @@ -726,7 +723,7 @@ compressed with the gzip program. <a name="checkout">Checkout LLVM from Subversion</a> </h3> -<div class="doc_text"> +<div> <p>If you have access to our Subversion repository, you can get a fresh copy of the entire source code. All you need to do is check it out from Subversion as @@ -797,7 +794,7 @@ instructions</a> to successfully get and build the LLVM GCC front-end.</p> <a name="git_mirror">GIT mirror</a> </h3> -<div class="doc_text"> +<div> <p>GIT mirrors are available for a number of LLVM subprojects. These mirrors sync automatically with each Subversion commit and contain all necessary @@ -816,7 +813,7 @@ instructions</a> to successfully get and build the LLVM GCC front-end.</p> <a name="installcf">Install the GCC Front End</a> </h3> -<div class="doc_text"> +<div> <p>Before configuring and compiling the LLVM suite (or if you want to use just the LLVM GCC front end) you can optionally extract the front end from the binary distribution. @@ -886,7 +883,7 @@ please let us know how you would like to see things improved by dropping us a no <a name="config">Local LLVM Configuration</a> </h3> -<div class="doc_text"> +<div> <p>Once checked out from the Subversion repository, the LLVM suite source code must be @@ -1008,7 +1005,7 @@ script to configure the build system:</p> <a name="compile">Compiling the LLVM Suite Source Code</a> </h3> -<div class="doc_text"> +<div> <p>Once you have configured LLVM, you can build it. There are three types of builds:</p> @@ -1142,7 +1139,7 @@ that directory that is out of date.</p> <a name="cross-compile">Cross-Compiling LLVM</a> </h3> -<div class="doc_text"> +<div> <p>It is possible to cross-compile LLVM itself. That is, you can create LLVM executables and libraries to be hosted on a platform different from the platform where they are build (a Canadian Cross build). To configure a @@ -1160,7 +1157,7 @@ that directory that is out of date.</p> <a name="objfiles">The Location of LLVM Object Files</a> </h3> -<div class="doc_text"> +<div> <p>The LLVM build system is capable of sharing a single LLVM source tree among several LLVM builds. Hence, it is possible to build LLVM for several different @@ -1220,7 +1217,7 @@ named after the build type:</p> <a name="optionalconfig">Optional Configuration Items</a> </h3> -<div class="doc_text"> +<div> <p> If you're running on a Linux system that supports the "<a @@ -1251,27 +1248,27 @@ $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC' </div> +</div> + <!-- *********************************************************************** --> <h2> <a name="layout">Program Layout</a> </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>One useful source of information about the LLVM source base is the LLVM <a href="http://www.doxygen.org/">doxygen</a> documentation available at <tt><a href="http://llvm.org/doxygen/">http://llvm.org/doxygen/</a></tt>. The following is a brief introduction to code layout:</p> -</div> - <!-- ======================================================================= --> <h3> <a name="examples"><tt>llvm/examples</tt></a> </h3> -<div class="doc_text"> +<div> <p>This directory contains some simple examples of how to use the LLVM IR and JIT.</p> </div> @@ -1281,7 +1278,7 @@ The following is a brief introduction to code layout:</p> <a name="include"><tt>llvm/include</tt></a> </h3> -<div class="doc_text"> +<div> <p>This directory contains public header files exported from the LLVM library. The three main subdirectories of this directory are:</p> @@ -1312,7 +1309,7 @@ library. The three main subdirectories of this directory are:</p> <a name="lib"><tt>llvm/lib</tt></a> </h3> -<div class="doc_text"> +<div> <p>This directory contains most of the source files of the LLVM system. In LLVM, almost all code exists in libraries, making it very easy to share code among the @@ -1381,7 +1378,7 @@ different <a href="#tools">tools</a>.</p> <a name="projects"><tt>llvm/projects</tt></a> </h3> -<div class="doc_text"> +<div> <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 LLVM-based projects. See <tt>llvm/projects/sample</tt> for an example of how @@ -1393,7 +1390,7 @@ different <a href="#tools">tools</a>.</p> <a name="runtime"><tt>llvm/runtime</tt></a> </h3> -<div class="doc_text"> +<div> <p>This directory contains libraries which are compiled into LLVM bitcode and used when linking programs with the GCC front end. Most of these libraries are @@ -1410,7 +1407,7 @@ end to compile.</p> <a name="test"><tt>llvm/test</tt></a> </h3> -<div class="doc_text"> +<div> <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 a lot of territory without being exhaustive.</p> @@ -1421,7 +1418,7 @@ end to compile.</p> <a name="test-suite"><tt>test-suite</tt></a> </h3> -<div class="doc_text"> +<div> <p>This is not a directory in the normal llvm module; it is a separate Subversion module that must be checked out (usually to <tt>projects/test-suite</tt>). @@ -1440,7 +1437,7 @@ end to compile.</p> <a name="tools"><tt>llvm/tools</tt></a> </h3> -<div class="doc_text"> +<div> <p>The <b>tools</b> directory contains the executables built out of the libraries above, which form the main part of the user interface. You can @@ -1528,7 +1525,7 @@ information is in the <a href="CommandGuide/index.html">Command Guide</a>.</p> <a name="utils"><tt>llvm/utils</tt></a> </h3> -<div class="doc_text"> +<div> <p>This directory contains utilities for working with LLVM source code, and some of the utilities are actually required as part of the build process because they @@ -1589,13 +1586,15 @@ are code generators for parts of LLVM infrastructure.</p> </div> +</div> + <!-- *********************************************************************** --> <h2> <a name="tutorial">An Example Using the LLVM Tool Chain</a> </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This section gives an example of using LLVM. llvm-gcc3 is now obsolete, so we only include instructions for llvm-gcc4. </p> @@ -1606,14 +1605,13 @@ create bitcode by default: <i>gcc4</i> produces native code. As the example belo the '--emit-llvm' flag is needed to produce LLVM bitcode output. For <i>makefiles</i> and <i>configure</i> scripts, the CFLAGS variable needs '--emit-llvm' to produce bitcode output.</p> -</div> <!-- ======================================================================= --> <h3> <a name="tutorial4">Example with llvm-gcc4</a> </h3> -<div class="doc_text"> +<div> <ol> <li><p>First, create a simple C file, name it 'hello.c':</p> @@ -1694,6 +1692,7 @@ int main() { </div> +</div> <!-- *********************************************************************** --> <h2> @@ -1701,7 +1700,7 @@ int main() { </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>If you are having problems building or using LLVM, or if you have any other general questions about LLVM, please consult the <a href="FAQ.html">Frequently @@ -1715,7 +1714,7 @@ Asked Questions</a> page.</p> </h2> <!-- *********************************************************************** --> -<div class="doc_text"> +<div> <p>This document is just an <b>introduction</b> on how to use LLVM to do some simple things... there are many more interesting and complicated things |