diff options
| author | Brad King <brad.king@kitware.com> | 2014-12-19 13:51:17 (GMT) |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2014-12-19 14:07:25 (GMT) |
| commit | 844f98c1fd1c9c61f1d73310ee1eb712528cd00f (patch) | |
| tree | 22963e471cd4d74b40915e16b45448eeccf3aa78 | |
| parent | c118816d44e178e4364a0c32aaece81a14511237 (diff) | |
| download | CMake-844f98c1fd1c9c61f1d73310ee1eb712528cd00f.zip CMake-844f98c1fd1c9c61f1d73310ee1eb712528cd00f.tar.gz CMake-844f98c1fd1c9c61f1d73310ee1eb712528cd00f.tar.bz2 | |
Help: Clarify MinGW v. MSYS Makefiles generators (#15319)
Explain the usage of each generator more clearly and reference each as
an alternative to the other.
Suggested-by: Craig Hicks <hicks111@hotmail.com>
| -rw-r--r-- | Help/generator/MSYS Makefiles.rst | 10 | ||||
| -rw-r--r-- | Help/generator/MinGW Makefiles.rst | 11 |
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. |