This is an archive of the discontinued LLVM Phabricator instance.

Differential D51079

Update the docs for using LLVM toolset in Visual Studio
ClosedPublic

Authored by steveire on Aug 21 2018, 5:46 PM.

Details

Reviewers
hans
Commits
rGcbd4a1745427: Merging r340376: --------------------------------------------------------------…
rG8a89bb61d22f: Update the docs for using LLVM toolset in Visual Studio
rL340730: Merging r340376:
rC340376: Update the docs for using LLVM toolset in Visual Studio
rL340376: Update the docs for using LLVM toolset in Visual Studio

Diff Detail

Event Timeline

steveire created this revision.Aug 21 2018, 5:46 PM
Herald added a subscriber: cfe-commits. · View Herald TranscriptAug 21 2018, 5:46 PM
Harbormaster completed remote builds in B21758: Diff 161863.Aug 21 2018, 5:47 PM
steveire added a comment.Aug 21 2018, 5:49 PM

@hans Consider backporting this.

hans accepted this revision.Aug 21 2018, 5:56 PM

Thanks!

This revision is now accepted and ready to land.Aug 21 2018, 5:56 PM
Closed by commit rL340376: Update the docs for using LLVM toolset in Visual Studio (authored by steveire). · Explain WhyAug 21 2018, 6:12 PM
This revision was automatically updated to reflect the committed changes.
Herald added a subscriber: llvm-commits. · View Herald TranscriptAug 21 2018, 6:12 PM

Revision Contents

PathSize
docs/
19 lines

Diff 161863

docs/UsersManual.rst

Show First 20 Lines • Show All 2,705 Lines • ▼ Show 20 Lines
compatibility with the Visual C++ compiler, cl.exe. compatibility with the Visual C++ compiler, cl.exe.
To enable clang-cl to find system headers, libraries, and the linker when run To enable clang-cl to find system headers, libraries, and the linker when run
from the command-line, it should be executed inside a Visual Studio Native Tools from the command-line, it should be executed inside a Visual Studio Native Tools
Command Prompt or a regular Command Prompt where the environment has been set Command Prompt or a regular Command Prompt where the environment has been set
up using e.g. `vcvarsall.bat <http://msdn.microsoft.com/en-us/library/f2ccy3wt.aspx>`_. up using e.g. `vcvarsall.bat <http://msdn.microsoft.com/en-us/library/f2ccy3wt.aspx>`_.
clang-cl can also be used from inside Visual Studio by selecting the LLVM clang-cl can also be used from inside Visual Studio by selecting the LLVM
Platform Toolset. The toolset is installed by the LLVM installer, which can be Platform Toolset. The toolset is not part of the installer, but may be installed
downloaded from the `LLVM release <http://releases.llvm.org/download.html>`_ or separately from the
`snapshot build <http://llvm.org/builds/>`_ web pages. To use the toolset, `Visual Studio Marketplace <https://marketplace.visualstudio.com/items?itemName=LLVMExtensions.llvm-toolchain>`_.
select a project in Solution Explorer, open its Property Page (Alt+F7), and in To use the toolset, select a project in Solution Explorer, open its Property
the "General" section of "Configuration Properties" change "Platform Toolset" Page (Alt+F7), and in the "General" section of "Configuration Properties"
to e.g. LLVM-vs2014. change "Platform Toolset" to LLVM. Doing so enables an additional Property
Page for selecting the clang-cl executable to use for builds.
To use the toolset with MSBuild directly, invoke it with e.g. To use the toolset with MSBuild directly, invoke it with e.g.
``/p:PlatformToolset=LLVM-vs2014``. This allows trying out the clang-cl ``/p:PlatformToolset=LLVM``. This allows trying out the clang-cl toolchain
toolchain without modifying your project files. without modifying your project files.
It's also possible to point MSBuild at clang-cl without changing toolset by It's also possible to point MSBuild at clang-cl without changing toolset by
passing ``/p:CLToolPath=c:\llvm\bin /p:CLToolExe=clang-cl.exe``. passing ``/p:CLToolPath=c:\llvm\bin /p:CLToolExe=clang-cl.exe``.
When using CMake and the Visual Studio generators, the toolset can be set with the ``-T`` flag: When using CMake and the Visual Studio generators, the toolset can be set with the ``-T`` flag:
:: ::
cmake -G"Visual Studio 15 2017" -T LLVM-vs2014 .. cmake -G"Visual Studio 15 2017" -T LLVM ..
When using CMake with the Ninja generator, set the ``CMAKE_C_COMPILER`` and When using CMake with the Ninja generator, set the ``CMAKE_C_COMPILER`` and
``CMAKE_CXX_COMPILER`` variables to clang-cl: ``CMAKE_CXX_COMPILER`` variables to clang-cl:
:: ::
cmake -GNinja -DCMAKE_C_COMPILER="c:/Program Files (x86)/LLVM/bin/clang-cl.exe" cmake -GNinja -DCMAKE_C_COMPILER="c:/Program Files (x86)/LLVM/bin/clang-cl.exe"
-DCMAKE_CXX_COMPILER="c:/Program Files (x86)/LLVM/bin/clang-cl.exe" .. -DCMAKE_CXX_COMPILER="c:/Program Files (x86)/LLVM/bin/clang-cl.exe" ..
▲ Show 20 Lines • Show All 284 Lines • Show Last 20 Lines