mirror of
https://github.com/Kitware/CMake.git
synced 2025-12-31 10:50:16 -06:00
9890cfc4ec
Covers almost all blocks containing actual code, except: * Parsed-literal blocks can't be highlighted, including many command summaries and substitution-heavy docs like find_... commands. This is a Sphinx limitation. * Code with errors, like CMP0049, DEPLOYMENT_ADDITIONAL_FILES, DEPLOYMENT_REMOTE_DIRECTORY, @PACKAGE_INIT@ substitution in the tutorial, bracket arguments/comments in cmake-language.7 and cmake-developer.7. * FindQt4 module, which needs reformatting.
CMake Development ***************** This directory contains documentation about development of CMake itself. It is not part of the user documentation distributed with CMake. Contributor Instructions ======================== See `CONTRIBUTING.rst`_ for instructions to contribute changes. The process for contributing changes is the same whether or not one has been invited to participate directly in upstream development. .. _`CONTRIBUTING.rst`: ../../CONTRIBUTING.rst Upstream Development ==================== CMake uses `Kitware's GitLab Instance`_ to manage development, review, and integration of changes. The `CMake Repository`_ holds the integration branches and tags. Upstream development processes are covered by the following documents: * The `CMake Review Process`_ manages integration of changes. * The `CMake Integration Testing`_ infrastructure tests changes before and after merging. .. _`Kitware's GitLab Instance`: https://gitlab.kitware.com .. _`CMake Repository`: https://gitlab.kitware.com/cmake/cmake .. _`CMake Review Process`: review.rst .. _`CMake Integration Testing`: integration-testing.rst Developer Documentation ======================= CMake developer documentation is provided by the following documents: * The `CMake Source Code Guide`_. * The `CMake Documentation Guide`_. * The `CMake Testing Guide`_. * The `CMake Experimental Features Guide`_. .. _`CMake Source Code Guide`: source.rst .. _`CMake Documentation Guide`: documentation.rst .. _`CMake Testing Guide`: testing.rst .. _`CMake Experimental Features Guide`: experimental.rst Maintainer Documentation ======================== CMake maintainer documentation is provided by the following documents: * The `CMake Maintainer Guide`_. .. _`CMake Maintainer Guide`: maint.rst