summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorBrad King <brad.king@kitware.com>2019-08-23 17:27:22 (GMT)
committerBrad King <brad.king@kitware.com>2019-08-23 17:31:54 (GMT)
commitbf832ccf01894bf605c17a89f2bc3babd24df108 (patch)
tree69a899b3ff72ea993291ae185eee09b14482584b
parentab153f17bf7c87a6ee14a94c19fc1dbd01849f05 (diff)
downloadCMake-bf832ccf01894bf605c17a89f2bc3babd24df108.zip
CMake-bf832ccf01894bf605c17a89f2bc3babd24df108.tar.gz
CMake-bf832ccf01894bf605c17a89f2bc3babd24df108.tar.bz2
Utilities/Release: Add README.rst describing directory content
-rw-r--r--Help/dev/source.rst2
-rw-r--r--Utilities/Release/README.rst27
2 files changed, 29 insertions, 0 deletions
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.