[PATCH] D58286: [docs] Document LLVM_ENABLE_IDE

[Shoaib Meenai via Phabricator via llvm-commits]

smeenai created this revision.
smeenai added reviewers: beanz, phosek, lebedev.ri.
Herald added a subscriber: mgorny.
Herald added a project: LLVM.

Use some of the wording and the motivating example from r344555. The
lack of documentation was pointed out by Roman Lebedev.


Repository:
  rG LLVM Github Monorepo

https://reviews.llvm.org/D58286

Files:
  llvm/docs/CMake.rst


Index: llvm/docs/CMake.rst
===================================================================
--- llvm/docs/CMake.rst
+++ llvm/docs/CMake.rst
@@ -281,6 +281,15 @@
 **LLVM_ENABLE_EXPENSIVE_CHECKS**:BOOL
   Enable additional time/memory expensive checking. Defaults to OFF.
 
+**LLVM_ENABLE_IDE**:BOOL
+  Tell the build system that an IDE is being used. This in turn disables the
+  creation of certain convenience build system targets, such as the various
+  ``install-*`` and ``check-llvm-*`` targets, since IDEs don't always deal well
+  with a large number of targets. This is usually autodetected, but it can be
+  configured manually to explicitly control the generation of those targets. One
+  scenario where a manual override may be desirable is when using Visual Studio
+  2017's CMake integration, which would not be detected as an IDE otherwise.
+
 **LLVM_ENABLE_PIC**:BOOL
   Add the ``-fPIC`` flag to the compiler command-line, if the compiler supports
   this flag. Some systems, like Windows, do not need this flag. Defaults to ON.


-------------- next part --------------
A non-text attachment was scrubbed...
Name: D58286.187022.patch
Type: text/x-patch
Size: 1047 bytes
Desc: not available
URL: <http://lists.llvm.org/pipermail/llvm-commits/attachments/20190215/de874483/attachment.bin>