summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2014-12-22 14:59:11 (GMT)
committerCMake Topic Stage <kwrobot@kitware.com>2014-12-22 14:59:11 (GMT)
commit594db49e567d705bd66501a5444a279b5b3eb0bd (patch)
tree90e85d05e9068ab48314e6b669292205f1ee12ec
parentd760c3cbe8ad5c63cef309ee7a182acdef79def7 (diff)
parent844f98c1fd1c9c61f1d73310ee1eb712528cd00f (diff)
downloadCMake-594db49e567d705bd66501a5444a279b5b3eb0bd.zip
CMake-594db49e567d705bd66501a5444a279b5b3eb0bd.tar.gz
CMake-594db49e567d705bd66501a5444a279b5b3eb0bd.tar.bz2
Merge topic 'doc-mingw-makefiles'
844f98c1 Help: Clarify MinGW v. MSYS Makefiles generators (#15319)
-rw-r--r--Help/generator/MSYS Makefiles.rst10
-rw-r--r--Help/generator/MinGW Makefiles.rst11
2 files changed, 15 insertions, 6 deletions
diff --git a/Help/generator/MSYS Makefiles.rst b/Help/generator/MSYS Makefiles.rst
index 0b89126..f7cfa44 100644
--- a/Help/generator/MSYS Makefiles.rst
+++ b/Help/generator/MSYS Makefiles.rst
@@ -1,7 +1,11 @@
MSYS Makefiles
--------------
-Generates MSYS makefiles.
+Generates makefiles for use with MSYS ``make`` under the MSYS shell.
-The makefiles use /bin/sh as the shell. They require msys to be
-installed on the machine.
+Use this generator in a MSYS shell prompt and using ``make`` as the build
+tool. The generated makefiles use ``/bin/sh`` as the shell to launch build
+rules. They are not compatible with a Windows command prompt.
+
+To build under a Windows command prompt, use the
+:generator:`MinGW Makefiles` generator.
diff --git a/Help/generator/MinGW Makefiles.rst b/Help/generator/MinGW Makefiles.rst
index ed4ccdd..9fe5fe3 100644
--- a/Help/generator/MinGW Makefiles.rst
+++ b/Help/generator/MinGW Makefiles.rst
@@ -1,7 +1,12 @@
MinGW Makefiles
---------------
-Generates a make file for use with mingw32-make.
+Generates makefiles for use with ``mingw32-make`` under a Windows command
+prompt.
-The makefiles generated use cmd.exe as the shell. They do not require
-msys or a unix shell.
+Use this generator under a Windows command prompt with MinGW in the ``PATH``
+and using ``mingw32-make`` as the build tool. The generated makefiles use
+``cmd.exe`` as the shell to launch build rules. They are not compatible with
+MSYS or a unix shell.
+
+To build under the MSYS shell, use the :generator:`MSYS Makefiles` generator.