Skip to content

Commit ef840d8

Browse files
[llvm] Proofread GettingStarted.rst (#159904)
1 parent b91de4c commit ef840d8

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

llvm/docs/GettingStarted.rst

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ object files. Tools include an assembler, disassembler, bitcode analyzer, and
1717
bitcode optimizer. It also contains basic regression tests.
1818

1919
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
2121
-- and from there into object files, using LLVM.
2222

2323
Other components include:
@@ -43,7 +43,7 @@ Getting the Source Code and Building LLVM
4343
``git clone --depth 1 https://github.com/llvm/llvm-project.git``
4444

4545
* 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
4747
`git fetch` (or `git pull`) with this configuration:
4848

4949
.. code-block:: console
@@ -416,7 +416,7 @@ The first step is to get a recent GCC toolchain installed. The most common
416416
distribution on which users have struggled with the version requirements is
417417
Ubuntu Precise, 12.04 LTS. For this distribution, one easy option is to install
418418
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
420420
`github gist`_ with updated commands. However, not all users can use PPAs and
421421
there are many other distributions, so it may be necessary (or just useful, if
422422
you're here you *are* doing compiler development after all) to build and install
@@ -471,19 +471,19 @@ binaries:
471471
472472
If you fail to set rpath, most LLVM binaries will fail on startup with a message
473473
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.
475475

476476
This method will add an absolute path to the rpath of all executables. That's
477477
fine for local development. If you want to distribute the binaries you build
478478
so that they can run on older systems, copy ``libstdc++.so.6`` into the
479479
``lib/`` directory. All of LLVM's shipping binaries have an rpath pointing at
480480
``$ORIGIN/../lib``, so they will find ``libstdc++.so.6`` there. Non-distributed
481481
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
483483
path to ``libstdc++.so.6`` as above. Since these binaries are not distributed,
484484
having an absolute local path is fine for them.
485485

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++
487487
standard library in order to use it as your new host in part of a bootstrap.
488488
There are two easy ways to do this, either build (and install) libc++ along
489489
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
502502
give you some basic information about the LLVM environment.
503503

504504
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
506506
more information about LLVM or to get help via e-mail.
507507

508508
Terminology and Notation
@@ -592,7 +592,7 @@ Compiling the LLVM Suite Source Code
592592
------------------------------------
593593

594594
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
596596
invocation:
597597

598598
.. code-block:: console
@@ -782,7 +782,7 @@ Generates system build files.
782782

783783
- BuildingAJIT: Examples of the `BuildingAJIT tutorial
784784
<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
786786
recombine them to build a custom JIT that is suited to your use-case.
787787

788788
``llvm/include``
@@ -869,7 +869,7 @@ share code among the `tools`_.
869869
Contains bindings for the LLVM compiler infrastructure to allow
870870
programs written in languages other than C or C++ to take advantage of the LLVM
871871
infrastructure.
872-
LLVM project provides language bindings for OCaml and Python.
872+
The LLVM project provides language bindings for OCaml and Python.
873873

874874
``llvm/projects``
875875
-----------------
@@ -1028,16 +1028,16 @@ Example with clang
10281028
10291029
.. note::
10301030

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).
10331033

10341034
#. Next, compile the C file into an LLVM bitcode file:
10351035

10361036
.. code-block:: console
10371037
10381038
% clang -O3 -emit-llvm hello.c -c -o hello.bc
10391039
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
10411041
``.ll`` or ``.bc`` file (respectively) for the code. This allows you to use
10421042
the `standard LLVM tools <CommandGuide/index.html>`_ on the bitcode file.
10431043

@@ -1094,7 +1094,7 @@ Questions <FAQ.html>`_ page.
10941094

10951095
If you are having problems with limited memory and build time, please try
10961096
building with ``ninja`` instead of ``make``. Please consider configuring the
1097-
following options with cmake:
1097+
following options with CMake:
10981098

10991099
* ``-G Ninja``
11001100

0 commit comments

Comments
 (0)