@@ -17,7 +17,7 @@ object files. Tools include an assembler, disassembler, bitcode analyzer, and
17
17
bitcode optimizer. It also contains basic regression tests.
18
18
19
19
C-like languages use the `Clang <https://clang.llvm.org/ >`_ front end. This
20
- component compiles C, C++, Objective C, and Objective C++ code into LLVM bitcode
20
+ component compiles C, C++, Objective- C, and Objective- C++ code into LLVM bitcode
21
21
-- and from there into object files, using LLVM.
22
22
23
23
Other components include:
@@ -43,7 +43,7 @@ Getting the Source Code and Building LLVM
43
43
``git clone --depth 1 https://github.com/llvm/llvm-project.git ``
44
44
45
45
* You are likely not interested in the user branches in the repo (used for
46
- stacked pull- requests and reverts), you can filter them from your
46
+ stacked pull requests and reverts), you can filter them from your
47
47
`git fetch ` (or `git pull `) with this configuration:
48
48
49
49
.. code-block :: console
@@ -416,7 +416,7 @@ The first step is to get a recent GCC toolchain installed. The most common
416
416
distribution on which users have struggled with the version requirements is
417
417
Ubuntu Precise, 12.04 LTS. For this distribution, one easy option is to install
418
418
the `toolchain testing PPA `_ and use it to install a modern GCC. There is
419
- a really nice discussions of this on the `ask ubuntu stack exchange `_ and a
419
+ a really nice discussion of this on the `ask ubuntu stack exchange `_ and a
420
420
`github gist `_ with updated commands. However, not all users can use PPAs and
421
421
there are many other distributions, so it may be necessary (or just useful, if
422
422
you're here you *are * doing compiler development after all) to build and install
@@ -471,19 +471,19 @@ binaries:
471
471
472
472
If you fail to set rpath, most LLVM binaries will fail on startup with a message
473
473
from the loader similar to ``libstdc++.so.6: version `GLIBCXX_3.4.20' not
474
- found ``. This means you need to tweak the -rpath linker flag.
474
+ found ``. This means you need to tweak the `` -rpath `` linker flag.
475
475
476
476
This method will add an absolute path to the rpath of all executables. That's
477
477
fine for local development. If you want to distribute the binaries you build
478
478
so that they can run on older systems, copy ``libstdc++.so.6 `` into the
479
479
``lib/ `` directory. All of LLVM's shipping binaries have an rpath pointing at
480
480
``$ORIGIN/../lib ``, so they will find ``libstdc++.so.6 `` there. Non-distributed
481
481
binaries don't have an rpath set and won't find ``libstdc++.so.6 ``. Pass
482
- ``-DLLVM_LOCAL_RPATH="$HOME/toolchains/lib64" `` to cmake to add an absolute
482
+ ``-DLLVM_LOCAL_RPATH="$HOME/toolchains/lib64" `` to CMake to add an absolute
483
483
path to ``libstdc++.so.6 `` as above. Since these binaries are not distributed,
484
484
having an absolute local path is fine for them.
485
485
486
- When you build Clang, you will need to give *it * access to modern C++
486
+ When you build Clang, you will need to give *it * access to a modern C++
487
487
standard library in order to use it as your new host in part of a bootstrap.
488
488
There are two easy ways to do this, either build (and install) libc++ along
489
489
with Clang and then use it with the ``-stdlib=libc++ `` compile and link flag,
@@ -502,7 +502,7 @@ The remainder of this guide is meant to get you up and running with LLVM and to
502
502
give you some basic information about the LLVM environment.
503
503
504
504
The later sections of this guide describe the `general layout `_ of the LLVM
505
- source tree, a `simple example `_ using the LLVM tool chain , and `links `_ to find
505
+ source tree, a `simple example `_ using the LLVM toolchain , and `links `_ to find
506
506
more information about LLVM or to get help via e-mail.
507
507
508
508
Terminology and Notation
@@ -592,7 +592,7 @@ Compiling the LLVM Suite Source Code
592
592
------------------------------------
593
593
594
594
Unlike with autotools, with CMake your build type is defined at configuration.
595
- If you want to change your build type, you can re-run cmake with the following
595
+ If you want to change your build type, you can re-run CMake with the following
596
596
invocation:
597
597
598
598
.. code-block :: console
@@ -782,7 +782,7 @@ Generates system build files.
782
782
783
783
- BuildingAJIT: Examples of the `BuildingAJIT tutorial
784
784
<https://llvm.org/docs/tutorial/BuildingAJIT1.html> `_ that shows how LLVM’s
785
- ORC JIT APIs interact with other parts of LLVM. It also, teaches how to
785
+ ORC JIT APIs interact with other parts of LLVM. It also teaches how to
786
786
recombine them to build a custom JIT that is suited to your use-case.
787
787
788
788
``llvm/include ``
@@ -869,7 +869,7 @@ share code among the `tools`_.
869
869
Contains bindings for the LLVM compiler infrastructure to allow
870
870
programs written in languages other than C or C++ to take advantage of the LLVM
871
871
infrastructure.
872
- LLVM project provides language bindings for OCaml and Python.
872
+ The LLVM project provides language bindings for OCaml and Python.
873
873
874
874
``llvm/projects ``
875
875
-----------------
@@ -1028,16 +1028,16 @@ Example with clang
1028
1028
1029
1029
.. note ::
1030
1030
1031
- Clang works just like GCC by default. The standard -S and -c arguments
1032
- work as usual (producing a native .s or .o file, respectively).
1031
+ Clang works just like GCC by default. The standard `` -S `` and `` -c `` arguments
1032
+ work as usual (producing a native `` .s `` or `` .o `` file, respectively).
1033
1033
1034
1034
#. Next, compile the C file into an LLVM bitcode file:
1035
1035
1036
1036
.. code-block :: console
1037
1037
1038
1038
% clang -O3 -emit-llvm hello.c -c -o hello.bc
1039
1039
1040
- The -emit-llvm option can be used with the -S or -c options to emit an LLVM
1040
+ The `` -emit-llvm `` option can be used with the `` -S `` or `` -c `` options to emit an LLVM
1041
1041
``.ll `` or ``.bc `` file (respectively) for the code. This allows you to use
1042
1042
the `standard LLVM tools <CommandGuide/index.html >`_ on the bitcode file.
1043
1043
@@ -1094,7 +1094,7 @@ Questions <FAQ.html>`_ page.
1094
1094
1095
1095
If you are having problems with limited memory and build time, please try
1096
1096
building with ``ninja `` instead of ``make ``. Please consider configuring the
1097
- following options with cmake :
1097
+ following options with CMake :
1098
1098
1099
1099
* ``-G Ninja ``
1100
1100
0 commit comments