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

[Vedant Kumar via llvm-commits]

vsk added a subscriber: vsk.
vsk added a comment.

Thanks for your work on this! Comments inline.


================
Comment at: docs/CMake.rst:34
@@ -33,3 +33,3 @@
 
-#. Create a directory for containing the build. It is not supported to build
-   LLVM on the source directory. cd to this directory:
+#. Create a directory to contain the build. Building LLVM in the source
+   directory is not supported. cd to this directory:
----------------
"Create a build directory", perhaps?

================
Comment at: docs/CMake.rst:106
@@ +105,3 @@
+CMake requires that you specify for which build tool it shall generate
+files (e.g., GNU make, Visual Studio, or Xcode). If not specified on
+the command line, CMake tries to guess which build tool to use, based on
----------------
Maybe just: "CMake requires that you specify a build tool (e.g ..."

================
Comment at: docs/CMake.rst:113
@@ -110,2 +112,3 @@
+see a list of the available generators on your system, execute
 
 .. code-block:: console
----------------
The text-wrapping changes here for some reason. Could you maintain the original width?

================
Comment at: docs/CMake.rst:118
@@ -114,3 +117,3 @@
 
-This will list the generator's names at the end of the help text. Generator's
-names are case-sensitive. Example:
+This will list the generators' names at the end of the help text.
+
----------------
I suggest dropping the plural possessive and just going for "This will list the generator names".

================
Comment at: docs/CMake.rst:144
@@ -136,3 +143,3 @@
 
-Variables customize how the build will be generated. Options are boolean
+Variables customize how the build will be generated. Options are Boolean
 variables, with possible values ON/OFF. Options and variables are defined on the
----------------
Does this need to be capitalized?

================
Comment at: docs/CMake.rst:171
@@ -161,1 +170,3 @@
 
+But this is not typically necessary.
+
----------------
Please omit this.

================
Comment at: docs/CMake.rst:443
@@ -422,4 +442,3 @@
 Testing is performed when the *check* target is built. For instance, if you are
-using makefiles, execute this command while on the top level of your build
-directory:
+using Makefiles, execute this command while at the root of your build directory:
 
----------------
"while at" --> "in"


http://reviews.llvm.org/D11862