Skip to content

Commit df6dce1

Browse files
[llvm] Proofread GettingStartedVS.rst (#159511)
1 parent d6b7ac8 commit df6dce1

File tree

1 file changed

+20
-20
lines changed

1 file changed

+20
-20
lines changed

llvm/docs/GettingStartedVS.rst

Lines changed: 20 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -13,9 +13,9 @@ Welcome to LLVM on Windows! This document only covers LLVM on Windows using
1313
Visual Studio, not WSL, mingw or cygwin. In order to get started, you first need
1414
to know some basic information.
1515

16-
There are many different projects that compose LLVM. The first piece is the
16+
LLVM is composed of many different projects. The first piece is the
1717
LLVM suite. This contains all of the tools, libraries, and header files needed
18-
to use LLVM. It contains an assembler, disassembler, bitcode analyzer and
18+
to use LLVM. It contains an assembler, disassembler, bitcode analyzer, and
1919
bitcode optimizer. It also contains basic regression tests that can be used to
2020
test the LLVM tools and the Clang front end.
2121

@@ -25,7 +25,7 @@ bitcode. Clang typically uses LLVM libraries to optimize the bitcode and emit
2525
machine code. LLVM fully supports the COFF object file format, which is
2626
compatible with all other existing Windows toolchains.
2727

28-
There are more LLVM projects which this document does not discuss.
28+
This document does not discuss other LLVM projects.
2929

3030

3131
Requirements
@@ -37,9 +37,9 @@ and software you will need.
3737
Hardware
3838
--------
3939
Any system that can adequately run Visual Studio 2019 is fine. The LLVM
40-
source tree including the git index consumes approximately 3GB.
41-
Object files, libraries and executables consume approximately 5GB in
42-
Release mode and much more in Debug mode. SSD drive and >16GB RAM are
40+
source tree, including the git index, consumes approximately 3GB.
41+
Object files, libraries, and executables consume approximately 5GB in
42+
Release mode and much more in Debug mode. An SSD drive and >16GB RAM are
4343
recommended.
4444

4545

@@ -51,7 +51,7 @@ suffices.
5151

5252
You will also need the `CMake <http://www.cmake.org/>`_ build system since it
5353
generates the project files you will use to build with. CMake is bundled with
54-
Visual Studio 2019 so separate installation is not required. If you do install
54+
Visual Studio 2019 so a separate installation is not required. If you do install
5555
CMake separately, Visual Studio 2022 will require CMake Version 3.21 or later.
5656

5757
If you would like to run the LLVM tests you will need `Python
@@ -67,7 +67,7 @@ Git for Windows is also bundled with Visual Studio 2019.
6767
Getting Started
6868
===============
6969
Here's the short story for getting up and running quickly with LLVM.
70-
These instruction were tested with Visual Studio 2019 and Python 3.9.6:
70+
These instructions were tested with Visual Studio 2019 and Python 3.9.6:
7171

7272
1. Download and install `Visual Studio <https://visualstudio.microsoft.com/>`_.
7373
2. In the Visual Studio installer, Workloads tab, select the
@@ -84,7 +84,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
8484
**Download debug binaries** is useful.
8585
7. Complete the Python installation.
8686
8. Run a "Developer Command Prompt for VS 2019" **as administrator**. This command
87-
prompt provides correct path and environment variables to Visual Studio and
87+
prompt provides the correct path and environment variables to Visual Studio and
8888
the installed tools.
8989
9. In the terminal window, type the commands:
9090

@@ -93,11 +93,11 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
9393
c:
9494
cd \
9595
96-
You may install the llvm sources in other location than ``c:\llvm`` but do not
97-
install into a path containing spaces (e.g. ``c:\Documents and Settings\...``)
96+
You may install the llvm sources in a location other than ``c:\llvm`` but do not
97+
install into a path containing spaces (e.g., ``c:\Documents and Settings\...``)
9898
as it will fail.
9999

100-
10. Register the Microsoft Debug Interface Access (DIA) DLLs
100+
10. Register the Microsoft Debug Interface Access (DIA) DLLs:
101101

102102
.. code-block:: bat
103103
@@ -107,7 +107,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
107107
The DIA library is required for LLVM PDB tests and
108108
`LLDB development <https://lldb.llvm.org/resources/build.html>`_.
109109

110-
11. Install psutil and obtain LLVM source code:
110+
11. Install psutil and obtain the LLVM source code:
111111

112112
.. code-block:: bat
113113
@@ -148,7 +148,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
148148
build.
149149
* CMake generates project files for all build types. To select a specific
150150
build type, use the Configuration manager from the VS IDE or the
151-
``/property:Configuration`` command line option when using MSBuild.
151+
``/property:Configuration`` command-line option when using MSBuild.
152152
* By default, the Visual Studio project files generated by CMake use the
153153
32-bit toolset. If you are developing on a 64-bit version of Windows and
154154
want to use the 64-bit toolset, pass the ``-Thost=x64`` flag when
@@ -172,7 +172,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6:
172172
results will be shown in the VS output window. Once the build succeeds, you
173173
have verified a working LLVM development environment!
174174

175-
You should not see any unexpected failures, but will see many unsupported
175+
You should not see any unexpected failures, but you will see many unsupported
176176
tests and expected failures:
177177

178178
::
@@ -198,8 +198,8 @@ run these commands in an admin shell to install the required tools:
198198
199199
There is also a Windows
200200
`Dockerfile <https://github.com/llvm/llvm-zorg/blob/main/buildbot/google/docker/windows-base-vscode2019/Dockerfile>`_
201-
with the entire build tool chain. This can be used to test the build with a
202-
tool chain different from your host installation or to create build servers.
201+
with the entire build toolchain. This can be used to test the build with a
202+
toolchain different from your host installation or to create build servers.
203203

204204
Next steps
205205
==========
@@ -216,10 +216,10 @@ directory and running:
216216
217217
c:\llvm> python ..\build\Release\bin\llvm-lit.py llvm\test
218218
219-
This example assumes that Python is in your PATH variable, which would be
219+
This example assumes that Python is in your ``PATH`` variable, which would be
220220
after **Add Python to the PATH** was selected during Python installation.
221221
If you had opened a command window prior to Python installation, you would
222-
have to close and reopen it to get the updated PATH.
222+
have to close and reopen it to get the updated ``PATH``.
223223

224224
A specific test or test directory can be run with:
225225

@@ -237,7 +237,7 @@ Build the LLVM Suite:
237237
headers, libs, and other useful things to the directory set by the
238238
``CMAKE_INSTALL_PREFIX`` setting when you first configured CMake.
239239
* The Fibonacci project is a sample program that uses the JIT. Modify the
240-
project's debugging properties to provide a numeric command line argument
240+
project's debugging properties to provide a numeric command-line argument
241241
or run it from the command line. The program will print the
242242
corresponding fibonacci value.
243243

0 commit comments

Comments
 (0)