Skip to content

Commit ba19d18

Browse files
committed
Update the VS getting started docs to reflect the current state of support
llvm-svn: 257381
1 parent f649862 commit ba19d18

File tree

1 file changed

+14
-20
lines changed

1 file changed

+14
-20
lines changed

llvm/docs/GettingStartedVS.rst

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

15-
There are many different projects that compose LLVM. The first is the LLVM
16-
suite. This contains all of the tools, libraries, and header files needed to
17-
use LLVM. It contains an assembler, disassembler,
18-
bitcode analyzer and bitcode optimizer. It also contains a test suite that can
19-
be used to test the LLVM tools.
20-
21-
Another useful project on Windows is `Clang <http://clang.llvm.org/>`_.
22-
Clang is a C family ([Objective]C/C++) compiler. Clang mostly works on
23-
Windows, but does not currently understand all of the Microsoft extensions
24-
to C and C++. Because of this, clang cannot parse the C++ standard library
25-
included with Visual Studio, nor parts of the Windows Platform SDK. However,
26-
most standard C programs do compile. Clang can be used to emit bitcode,
27-
directly emit object files or even linked executables using Visual Studio's
28-
``link.exe``.
29-
30-
The large LLVM test suite cannot be run on the Visual Studio port at this
31-
time.
32-
33-
Most of the tools build and work. ``bugpoint`` does build, but does
34-
not work.
15+
There are many different projects that compose LLVM. The first piece is the
16+
LLVM suite. This contains all of the tools, libraries, and header files needed
17+
to use LLVM. It contains an assembler, disassembler, bitcode analyzer and
18+
bitcode optimizer. It also contains basic regression tests that can be used to
19+
test the LLVM tools and the Clang front end.
20+
21+
The second piece is the `Clang <http://clang.llvm.org/>`_ front end. This
22+
component compiles C, C++, Objective C, and Objective C++ code into LLVM
23+
bitcode. Clang typically uses LLVM libraries to optimize the bitcode and emit
24+
machine code. LLVM fully supports the COFF object file format, which is
25+
compatible with all other existing Windows toolchains.
26+
27+
The last major part of LLVM, the execution Test Suite, does not run on Windows,
28+
and this document does not discuss it.
3529

3630
Additional information about the LLVM directory structure and tool chain
3731
can be found on the main :doc:`GettingStarted` page.

0 commit comments

Comments
 (0)