From 4553183f48f83447eb42cc4ebea896d980ab646a Mon Sep 17 00:00:00 2001 From: Kazu Hirata Date: Wed, 17 Sep 2025 12:47:31 -0700 Subject: [PATCH] [llvm] Proofread GettingStartedVS.rst --- llvm/docs/GettingStartedVS.rst | 40 +++++++++++++++++----------------- 1 file changed, 20 insertions(+), 20 deletions(-) diff --git a/llvm/docs/GettingStartedVS.rst b/llvm/docs/GettingStartedVS.rst index 4b15272635fbe..bc5746df66e20 100644 --- a/llvm/docs/GettingStartedVS.rst +++ b/llvm/docs/GettingStartedVS.rst @@ -13,9 +13,9 @@ Welcome to LLVM on Windows! This document only covers LLVM on Windows using Visual Studio, not WSL, mingw or cygwin. In order to get started, you first need to know some basic information. -There are many different projects that compose LLVM. The first piece is the +LLVM is composed of many different projects. The first piece is the LLVM suite. This contains all of the tools, libraries, and header files needed -to use LLVM. It contains an assembler, disassembler, bitcode analyzer and +to use LLVM. It contains an assembler, disassembler, bitcode analyzer, and bitcode optimizer. It also contains basic regression tests that can be used to test the LLVM tools and the Clang front end. @@ -25,7 +25,7 @@ bitcode. Clang typically uses LLVM libraries to optimize the bitcode and emit machine code. LLVM fully supports the COFF object file format, which is compatible with all other existing Windows toolchains. -There are more LLVM projects which this document does not discuss. +This document does not discuss other LLVM projects. Requirements @@ -37,9 +37,9 @@ and software you will need. Hardware -------- Any system that can adequately run Visual Studio 2019 is fine. The LLVM -source tree including the git index consumes approximately 3GB. -Object files, libraries and executables consume approximately 5GB in -Release mode and much more in Debug mode. SSD drive and >16GB RAM are +source tree, including the git index, consumes approximately 3GB. +Object files, libraries, and executables consume approximately 5GB in +Release mode and much more in Debug mode. An SSD drive and >16GB RAM are recommended. @@ -51,7 +51,7 @@ suffices. You will also need the `CMake `_ build system since it generates the project files you will use to build with. CMake is bundled with -Visual Studio 2019 so separate installation is not required. If you do install +Visual Studio 2019 so a separate installation is not required. If you do install CMake separately, Visual Studio 2022 will require CMake Version 3.21 or later. 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. Getting Started =============== Here's the short story for getting up and running quickly with LLVM. -These instruction were tested with Visual Studio 2019 and Python 3.9.6: +These instructions were tested with Visual Studio 2019 and Python 3.9.6: 1. Download and install `Visual Studio `_. 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: **Download debug binaries** is useful. 7. Complete the Python installation. 8. Run a "Developer Command Prompt for VS 2019" **as administrator**. This command - prompt provides correct path and environment variables to Visual Studio and + prompt provides the correct path and environment variables to Visual Studio and the installed tools. 9. In the terminal window, type the commands: @@ -93,11 +93,11 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6: c: cd \ - You may install the llvm sources in other location than ``c:\llvm`` but do not - install into a path containing spaces (e.g. ``c:\Documents and Settings\...``) + You may install the llvm sources in a location other than ``c:\llvm`` but do not + install into a path containing spaces (e.g., ``c:\Documents and Settings\...``) as it will fail. -10. Register the Microsoft Debug Interface Access (DIA) DLLs +10. Register the Microsoft Debug Interface Access (DIA) DLLs: .. code-block:: bat @@ -107,7 +107,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6: The DIA library is required for LLVM PDB tests and `LLDB development `_. -11. Install psutil and obtain LLVM source code: +11. Install psutil and obtain the LLVM source code: .. code-block:: bat @@ -148,7 +148,7 @@ These instruction were tested with Visual Studio 2019 and Python 3.9.6: build. * CMake generates project files for all build types. To select a specific build type, use the Configuration manager from the VS IDE or the - ``/property:Configuration`` command line option when using MSBuild. + ``/property:Configuration`` command-line option when using MSBuild. * By default, the Visual Studio project files generated by CMake use the 32-bit toolset. If you are developing on a 64-bit version of Windows and 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: results will be shown in the VS output window. Once the build succeeds, you have verified a working LLVM development environment! - You should not see any unexpected failures, but will see many unsupported + You should not see any unexpected failures, but you will see many unsupported tests and expected failures: :: @@ -198,8 +198,8 @@ run these commands in an admin shell to install the required tools: There is also a Windows `Dockerfile `_ -with the entire build tool chain. This can be used to test the build with a -tool chain different from your host installation or to create build servers. +with the entire build toolchain. This can be used to test the build with a +toolchain different from your host installation or to create build servers. Next steps ========== @@ -216,10 +216,10 @@ directory and running: c:\llvm> python ..\build\Release\bin\llvm-lit.py llvm\test -This example assumes that Python is in your PATH variable, which would be +This example assumes that Python is in your ``PATH`` variable, which would be after **Add Python to the PATH** was selected during Python installation. If you had opened a command window prior to Python installation, you would -have to close and reopen it to get the updated PATH. +have to close and reopen it to get the updated ``PATH``. A specific test or test directory can be run with: @@ -237,7 +237,7 @@ Build the LLVM Suite: headers, libs, and other useful things to the directory set by the ``CMAKE_INSTALL_PREFIX`` setting when you first configured CMake. * The Fibonacci project is a sample program that uses the JIT. Modify the - project's debugging properties to provide a numeric command line argument + project's debugging properties to provide a numeric command-line argument or run it from the command line. The program will print the corresponding fibonacci value.