From bf832ccf01894bf605c17a89f2bc3babd24df108 Mon Sep 17 00:00:00 2001 From: Brad King Date: Fri, 23 Aug 2019 13:27:22 -0400 Subject: Utilities/Release: Add README.rst describing directory content --- Help/dev/source.rst | 2 ++ Utilities/Release/README.rst | 27 +++++++++++++++++++++++++++ 2 files changed, 29 insertions(+) create mode 100644 Utilities/Release/README.rst diff --git a/Help/dev/source.rst b/Help/dev/source.rst index 47baff4..0f7488b 100644 --- a/Help/dev/source.rst +++ b/Help/dev/source.rst @@ -74,6 +74,8 @@ The CMake source tree is organized as follows. * ``Utilities/Release/``: Scripts used to package CMake itself for distribution on ``cmake.org``. + See `Utilities/Release/README.rst`_. .. _`CMake Documentation Guide`: documentation.rst .. _`Tests/README.rst`: ../../Tests/README.rst +.. _`Utilities/Release/README.rst`: ../../Utilities/Release/README.rst diff --git a/Utilities/Release/README.rst b/Utilities/Release/README.rst new file mode 100644 index 0000000..3752e06 --- /dev/null +++ b/Utilities/Release/README.rst @@ -0,0 +1,27 @@ +CMake Release Utilities +*********************** + +This directory contains scripts used to package CMake itself for distribution +on ``cmake.org``. See also the `CMake Source Code Guide`_. + +.. _`CMake Source Code Guide`: ../../Help/dev/source.rst + +Scripts for Kitware +------------------- + +Kitware uses the following scripts to produce binaries for ``cmake.org``. +They work only on specific machines Kitware uses for such builds. + +* ``create-cmake-release.cmake``: + Run ``cmake -DCMAKE_CREATE_VERSION=$ver -P ../create-cmake-release.cmake`` + to generate ``create-$ver-*.sh`` release scripts. It also displays + instructions to run them. + +* ``*_release.cmake``: + Platform-specific settings used in corresponding scripts generated above. + +* ``release_cmake.cmake``: + Code shared by all ``*_release.cmake`` scripts. + +* ``release_cmake.sh.in``: + Template for script that runs on the actual build machines. -- cgit v0.12