. H1 ... doc_title H2 ... doc_section H3 ... doc_subsection H4 ... doc_subsubsection git-svn-id: https://llvm.org/svn/llvm-project/llvm/trunk@129736 91177308-0d34-0410-b5e6-96231b3b80d8 --- docs/GettingStarted.html | 153 ++++++++++++++++++++++++++++------------------- 1 file changed, 92 insertions(+), 61 deletions(-) (limited to 'docs/GettingStarted.html') diff --git a/docs/GettingStarted.html b/docs/GettingStarted.html index d670611970..2bca7ae643 100644 --- a/docs/GettingStarted.html +++ b/docs/GettingStarted.html @@ -8,9 +8,9 @@ -

Getting Started with the LLVM System -

Overview @@ -70,9 +70,9 @@ -
- Overview -
+
+ Overview +

@@ -102,9 +102,9 @@ and performance.
-
- Getting Started Quickly (A Summary) -
+
+ Getting Started Quickly (A Summary) +

@@ -191,9 +191,9 @@ Layout to learn about the layout of the source code tree.

-
- Requirements -
+
+ Requirements +

@@ -205,9 +205,9 @@ software you will need.

-
- Hardware -
+
+ Hardware +

@@ -370,7 +370,9 @@ href="GCCFEBuildInstrs.html">try to compile it on your platform.

-
Software
+
+ Software +

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 on your platform.

-
+
Broken versions of GCC and other tools -
+
@@ -608,9 +610,9 @@ upgrading to a newer version of Gold.
-
- Getting Started with LLVM -
+
+ Getting Started with LLVM +

@@ -626,9 +628,9 @@ help via e-mail.

-
+
Terminology and Notation -
+
@@ -663,9 +665,9 @@ All these paths are absolute:

-
+
Setting Up Your Environment -
+
@@ -686,9 +688,9 @@ variables.
-
+
Unpacking the LLVM Archives -
+
@@ -720,9 +722,9 @@ compressed with the gzip program.
-
+
Checkout LLVM from Subversion -
+
@@ -791,9 +793,9 @@ instructions to successfully get and build the LLVM GCC front-end.

-
+
GIT mirror -
+
@@ -810,9 +812,9 @@ instructions to successfully get and build the LLVM GCC front-end.

-
+
Install the GCC Front End -
+
@@ -880,9 +882,9 @@ please let us know how you would like to see things improved by dropping us a no
-
+
Local LLVM Configuration -
+
@@ -1002,9 +1004,9 @@ script to configure the build system:

-
+
Compiling the LLVM Suite Source Code -
+
@@ -1136,9 +1138,9 @@ that directory that is out of date.

-
+
Cross-Compiling LLVM -
+

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.

-
+
The Location of LLVM Object Files -
+
@@ -1214,9 +1216,9 @@ named after the build type:

-
+
Optional Configuration Items -
+
@@ -1250,9 +1252,9 @@ $ sudo update-binfmts --install llvm /path/to/lli --magic 'BC'
-
- Program Layout -
+
+ Program Layout +

@@ -1265,14 +1267,20 @@ The following is a brief introduction to code layout:

-
llvm/examples
+
+ llvm/examples +
+

This directory contains some simple examples of how to use the LLVM IR and JIT.

-
llvm/include
+
+ llvm/include +
+

This directory contains public header files exported from the LLVM @@ -1300,7 +1308,10 @@ library. The three main subdirectories of this directory are:

-
llvm/lib
+
+ llvm/lib +
+

This directory contains most of the source files of the LLVM system. In LLVM, @@ -1366,7 +1377,10 @@ different tools.

-
llvm/projects
+
+ llvm/projects +
+

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 tools.

-
llvm/runtime
+
+ llvm/runtime +
+

This directory contains libraries which are compiled into LLVM bitcode and @@ -1389,7 +1406,10 @@ end to compile.

-
llvm/test
+
+ llvm/test +
+

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.

-
test-suite
+
+ test-suite +
+

This is not a directory in the normal llvm module; it is a separate Subversion @@ -1413,7 +1436,10 @@ end to compile.

-
llvm/tools
+
+ llvm/tools +
+

The tools directory contains the executables built out of the @@ -1498,7 +1524,10 @@ information is in the Command Guide.

-
llvm/utils
+
+ llvm/utils +
+

This directory contains utilities for working with LLVM source code, and some @@ -1561,9 +1590,9 @@ are code generators for parts of LLVM infrastructure.

-
+
An Example Using the LLVM Tool Chain -
+
@@ -1580,7 +1609,9 @@ output.

-
Example with llvm-gcc4
+
+ Example with llvm-gcc4 +

@@ -1665,9 +1696,9 @@ int main() { -
+
Common Problems -
+
@@ -1679,9 +1710,9 @@ Asked Questions page.

-
+
Links -
+
-- cgit v1.2.3-70-g09d2

Getting Started with the LLVM System -

+ Overview +

+ Getting Started Quickly (A Summary) +

+ Requirements +

+ Hardware +

+ Software +

Broken versions of GCC and other tools -

+ Getting Started with LLVM +

Terminology and Notation -

Setting Up Your Environment -

Unpacking the LLVM Archives -

Checkout LLVM from Subversion -

GIT mirror -

Install the GCC Front End -

Local LLVM Configuration -

Compiling the LLVM Suite Source Code -

Cross-Compiling LLVM -

The Location of LLVM Object Files -

Optional Configuration Items -

+ Program Layout +

+ `llvm/examples` +

+ `llvm/include` +

+ `llvm/lib` +

+ `llvm/projects` +

+ `llvm/runtime` +

+ `llvm/test` +

+ `test-suite` +

+ `llvm/tools` +

+ `llvm/utils` +

An Example Using the LLVM Tool Chain -

+ Example with llvm-gcc4 +

Common Problems -

Links -

Getting Started with the LLVM System -

+ Overview +

+ Getting Started Quickly (A Summary) +

+ Requirements +

+ Hardware +

+ Software +

Broken versions of GCC and other tools -

+ Getting Started with LLVM +

Terminology and Notation -

Setting Up Your Environment -

Unpacking the LLVM Archives -

Checkout LLVM from Subversion -

GIT mirror -

Install the GCC Front End -

Local LLVM Configuration -

Compiling the LLVM Suite Source Code -

Cross-Compiling LLVM -

The Location of LLVM Object Files -

Optional Configuration Items -

+ Program Layout +

+ llvm/examples +

+ llvm/include +

+ llvm/lib +

+ llvm/projects +

+ llvm/runtime +

+ llvm/test +

+ test-suite +

+ llvm/tools +

+ llvm/utils +

An Example Using the LLVM Tool Chain -

+ Example with llvm-gcc4 +

Common Problems -

Links -

+ `llvm/examples` +

+ `llvm/include` +

+ `llvm/lib` +

+ `llvm/projects` +

+ `llvm/runtime` +

+ `llvm/test` +

+ `test-suite` +

+ `llvm/tools` +

+ `llvm/utils` +