[PATCH] D11862: Edits to CMake.rst for clarity's sake

[Brian R. Gaeke via llvm-commits]

gaeke marked an inline comment as done.
gaeke added a comment.

Thanks for your comments. I will submit another patch soon.


================
Comment at: docs/CMake.rst:199-201
@@ -190,4 +198,5 @@
   Flag indicating if shared libraries will be built. Its default value is
-  OFF. Shared libraries are not supported on Windows and not recommended on the
-  other OSes.
+  OFF. Shared libraries are supported on Windows when using MinGW, including
+  mingw-w64. They are not supported on Windows when using the Microsoft
+  toolchain. Shared libraries are not recommended on other operating systems.
 
----------------
chapuni wrote:
> I wonder it might misunderstand like
> "BUILD_SHARED_LIBS is recommended on mingw."
> 
> IMO, BUILD_SHARED_LIBS is an option for developers.
OK, I revised this to warn people that it is not for general use.

================
Comment at: docs/CMake.rst:443
@@ -427,3 +442,3 @@
 
-  $ make check
+  $ make check-all
 
----------------
chapuni wrote:
> Yes. in trunk, "check" is an alias of "check-llvm".
> For consistency in CMake scripts, "check-*" is the primary target and "check" is compatible stuff for autoconf Make.
> 
> You may also mention "check-*" to run tests for individual subproject, here.
OK, I changed the third occurrence to "check-all" as well. I don't think it makes a lot of sense to go too deeply into testing procedures here. It seems like people should consult the TestingGuide for that. 

================
Comment at: docs/CMake.rst:445
@@ -429,3 +444,3 @@
 
-On Visual Studio, you may run tests to build the project "check".
+On Visual Studio, you may run tests by building the project "check".
 
----------------
chapuni wrote:
> Although I am not a user of Xcode, I guess it might be generic for IDE Generators.
I'm not a user of Xcode either. If other people want to edit this to explain what the situation is for Xcode, or for other IDEs, I will leave that up to them.


http://reviews.llvm.org/D11862