[PATCH] D108513: [docs] Update Getting Started with Visual Studio guide

Christian Kühnel via Phabricator via llvm-commits llvm-commits at lists.llvm.org
Mon Aug 23 01:10:27 PDT 2021


kuhnel accepted this revision.
kuhnel added a comment.
This revision is now accepted and ready to land.

Thx for cleaning up the Windows instructions!

I only have a view minor remarks (see inline comments).

As a side note:
I'm also working on a tutorial for Visual Studio Code on Windows, however I didn't really have time to finish that yet. 
What's missing so far: Debugging with LLDB, installing the Visual Studio compiler (without UI) and use these.



================
Comment at: llvm/docs/GettingStartedVS.rst:48
 --------
-You will need Visual Studio 2017 or higher, with the latest Update installed.
+You will need `Visual Studio <https://visualstudio.microsoft.com/>`_ 2017 or
+higher, with the latest Update installed.
----------------
Nit: Maybe add a comment that the "Community Edition" is enough.


================
Comment at: llvm/docs/GettingStartedVS.rst:110
 
-   * With git access:
+11. Finally, configure LLVM using CMake:
 
----------------
Nit: Maybe call out, that you're only building clang here and users need to configure the other projects as needed, e.g. as explained in https://llvm.org/docs/CMake.html#frequently-used-llvm-related-variables


================
Comment at: llvm/docs/GettingStartedVS.rst:114
 
-      1. ``cd <where-you-want-llvm-to-live>``
-      2. ``git clone https://github.com/llvm/llvm-project.git llvm``
-      3. ``cd llvm``
+       cmake -S llvm\llvm -B build -DLLVM_ENABLE_PROJECTS=clang -DLLVM_TARGETS_TO_BUILD=X86 -Thost=x64
+       exit
----------------
I'm not familiar with using CMake with the Visual Studio build system, but don't you need to set the output build system with `cmake -G "Visual Studio 17 2022`? Or is that set automatically?


================
Comment at: llvm/docs/GettingStartedVS.rst:145
+   Studio configuration is **Debug** which is slow and generates a huge amount
+   of debug information on disk. For now, we recommend selecting **Release**
+   configuration for the LLVM project. It is possible to change compiler
----------------
Why not Release with Debug info? This gives you much more information when debugging problems?


================
Comment at: llvm/docs/GettingStartedVS.rst:177
 
-7. Build the LLVM Suite:
+   choco install -y ninja git cmake gnuwin python3
+   pip3 install psutil
----------------
I guess we should also update these instructions, based on your new tool recommendations. 


Repository:
  rG LLVM Github Monorepo

CHANGES SINCE LAST ACTION
  https://reviews.llvm.org/D108513/new/

https://reviews.llvm.org/D108513



More information about the llvm-commits mailing list