Patched versions of CMake for ReactOS needs
Go to file
Bill Hoffman 044dcf9f8d execute_process: Add option to echo command lines
Add COMMAND_ECHO option to the execute_process command. This will allow
execute_process to show the command it will run. Also add a cmake variable
CMAKE_EXECUTE_PROCESS_COMMAND_ECHO. Both the option and the variable can
be set to one of the following: STDERR|STDOUT|NONE. The command will be
printed to stderr or stdout or not at all.

Fixes: #18933
2019-04-19 13:32:08 -04:00
.github Add GitHub PR template to point contributors at CONTRIBUTING.rst 2017-08-11 08:23:09 -04:00
Auxiliary Merge topic 'xcodescheme2' 2019-03-22 09:16:02 -04:00
Help execute_process: Add option to echo command lines 2019-04-19 13:32:08 -04:00
Licenses cmake-gui: Reference LGPLv3 when redistributing Qt 2016-06-17 15:02:54 -04:00
Modules Merge topic 'improve-formatting-of-help' 2019-04-09 08:30:15 -04:00
Packaging QtIFW: Improved packaging as part of the QtSDK 2017-04-08 07:13:50 +03:00
Source execute_process: Add option to echo command lines 2019-04-19 13:32:08 -04:00
Templates VS: Fix nowarn compiler option to accept warning numbers. 2019-02-07 06:39:45 -05:00
Tests execute_process: Add option to echo command lines 2019-04-19 13:32:08 -04:00
Utilities Merge topic 'argument-parser' 2019-04-09 08:27:31 -04:00
.clang-format clang-format.bash: update to clang-format-6.0 2018-06-01 09:52:02 -04:00
.clang-tidy Merge topic 'tidy-fixes' 2019-04-08 07:44:10 -04:00
.gitattributes CPack: Replace corrupted background png with original 2019-01-25 09:04:35 -05:00
.gitignore gitignore: Ignore a .vscode directory in the source tree 2018-07-03 11:48:14 -04:00
.hooks-config Convert local hook configuration to a Git config file format 2017-01-31 11:16:10 -05:00
bootstrap Retire cmCommandArgumentsHelper 2019-04-04 13:24:40 -04:00
cmake_uninstall.cmake.in Replace string(REGEX REPLACE) with string(REPLACE) where possible 2014-04-14 18:17:05 +02:00
CMakeCPack.cmake Xcode: Require at least Xcode 5 2019-02-16 15:20:39 +01:00
CMakeCPackOptions.cmake.in Xcode: Require at least Xcode 5 2019-02-16 15:20:39 +01:00
CMakeGraphVizOptions.cmake
CMakeLists.txt KWSys 2019-03-28 (e92bdbe8) 2019-03-28 11:06:33 -04:00
CMakeLogo.gif
CompileFlags.cmake ppc64: Work around TOC overflow with platform specific linker flags 2019-02-27 13:00:00 -06:00
configure
CONTRIBUTING.rst Help: Insert link from CONTRIBUTING to build instructions 2018-12-18 17:11:13 +01:00
Copyright.txt Copyright.txt: Update year range to end in 2019 2018-12-18 08:15:03 -05:00
CTestConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
CTestCustom.cmake.in Fix most clang -Wextra-semi-stmt warnings in C++ files 2019-01-15 14:09:46 -05:00
DartConfig.cmake Simplify CMake per-source license notices 2016-09-27 15:14:44 -04:00
doxygen.config
README.rst README: Suggest bootstrapping out-of-source for development 2019-02-20 08:00:03 -05:00

CMake
*****

Introduction
============

CMake is a cross-platform, open-source build system generator.
For full documentation visit the `CMake Home Page`_ and the
`CMake Documentation Page`_. The `CMake Community Wiki`_ also
references useful guides and recipes.

.. _`CMake Home Page`: https://cmake.org
.. _`CMake Documentation Page`: https://cmake.org/cmake/help/documentation.html
.. _`CMake Community Wiki`: https://gitlab.kitware.com/cmake/community/wikis/home

CMake is maintained and supported by `Kitware`_ and developed in
collaboration with a productive community of contributors.

.. _`Kitware`: http://www.kitware.com/cmake

License
=======

CMake is distributed under the OSI-approved BSD 3-clause License.
See `Copyright.txt`_ for details.

.. _`Copyright.txt`: Copyright.txt

Building CMake
==============

Supported Platforms
-------------------

* Microsoft Windows
* Apple macOS
* Linux
* FreeBSD
* OpenBSD
* Solaris
* AIX

Other UNIX-like operating systems may work too out of the box, if not
it should not be a major problem to port CMake to this platform.
Subscribe and post to the `CMake Users List`_ to ask if others have
had experience with the platform.

.. _`CMake Users List`: https://cmake.org/mailman/listinfo/cmake

Building CMake from Scratch
---------------------------

UNIX/Mac OSX/MinGW/MSYS/Cygwin
^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^

You need to have a C++ compiler (supporting C++11) and a ``make`` installed.
Run the ``bootstrap`` script you find in the source directory of CMake.
You can use the ``--help`` option to see the supported options.
You may use the ``--prefix=<install_prefix>`` option to specify a custom
installation directory for CMake.  Once this has finished successfully,
run ``make`` and ``make install``.

For example, if you simply want to build and install CMake from source,
you can build directly in the source tree::

  $ ./bootstrap && make && sudo make install

Or, if you plan to develop CMake or otherwise run the test suite, create
a separate build tree::

  $ mkdir cmake-build && cd cmake-build
  $ ../cmake-source/bootstrap && make

Windows
^^^^^^^

There are two ways for building CMake under Windows:

1. Compile with MSVC from VS 2015 or later.
   You need to download and install a binary release of CMake.  You can get
   these releases from the `CMake Download Page`_.  Then proceed with the
   instructions below for `Building CMake with CMake`_.

2. Bootstrap with MinGW under MSYS2.
   Download and install `MSYS2`_.  Then install the required build tools::

     $ pacman -S --needed git base-devel mingw-w64-x86_64-gcc

   and bootstrap as above.

.. _`CMake Download Page`: https://cmake.org/cmake/resources/software.html
.. _`MSYS2`: https://www.msys2.org/

Building CMake with CMake
-------------------------

You can build CMake as any other project with a CMake-based build system:
run the installed CMake on the sources of this CMake with your preferred
options and generators. Then build it and install it.
For instructions how to do this, see documentation on `Running CMake`_.

.. _`Running CMake`: https://cmake.org/cmake/help/runningcmake.html

To build the documentation, install `Sphinx`_ and configure CMake with
``-DSPHINX_HTML=ON`` and/or ``-DSPHINX_MAN=ON`` to enable the "html" or
"man" builder.  Add ``-DSPHINX_EXECUTABLE=/path/to/sphinx-build`` if the
tool is not found automatically.

.. _`Sphinx`: http://sphinx-doc.org

Reporting Bugs
==============

If you have found a bug:

1. If you have a patch, please read the `CONTRIBUTING.rst`_ document.

2. Otherwise, please join the `CMake Users List`_ and ask about
   the expected and observed behaviors to determine if it is really
   a bug.

3. Finally, if the issue is not resolved by the above steps, open
   an entry in the `CMake Issue Tracker`_.

.. _`CMake Issue Tracker`: https://gitlab.kitware.com/cmake/cmake/issues

Contributing
============

See `CONTRIBUTING.rst`_ for instructions to contribute.

.. _`CONTRIBUTING.rst`: CONTRIBUTING.rst