diff options
| author | Brad King <brad.king@kitware.com> | 2020-05-05 14:49:24 -0400 |
|---|---|---|
| committer | Brad King <brad.king@kitware.com> | 2020-05-05 14:50:26 -0400 |
| commit | 5f4f7e637a515d7fb9c6f5344169c37dc9d78a7f (patch) | |
| tree | cc668cc5e88bcad36d93e9bf84b62877fd1645a6 /Utilities/Release/README.rst | |
| parent | 13467f1dbdd049957d4a7ffbb8ef35ab991e50be (diff) | |
| download | cmake-5f4f7e637a515d7fb9c6f5344169c37dc9d78a7f.tar.gz | |
Utilities/Release: Generalize OS in README docker instructions
Replace the hard-coded OS name `linux` with an `<os>` placeholder.
Mention `linux` in an explicit list of supported `<os>/<arch>` pairs.
Diffstat (limited to 'Utilities/Release/README.rst')
| -rw-r--r-- | Utilities/Release/README.rst | 22 |
1 files changed, 13 insertions, 9 deletions
diff --git a/Utilities/Release/README.rst b/Utilities/Release/README.rst index eb4d6e2958..2a723c9b19 100644 --- a/Utilities/Release/README.rst +++ b/Utilities/Release/README.rst @@ -9,21 +9,25 @@ on ``cmake.org``. See also the `CMake Source Code Guide`_. Docker ------ -The ``linux/<arch>/`` directories contain Docker specifications that anyone -may use to produce Linux binaries for CMake: +The ``<os>/<arch>/`` directories contain Docker specifications that anyone +may use to produce binaries for CMake on the following platforms: -* ``linux/<arch>/base/Dockerfile``: +* ``linux/x86_64/``: Linux on ``x86_64`` architectures. + +Each ``<os>/<arch>/`` directory contains the following: + +* ``<os>/<arch>/base/Dockerfile``: Produces a base image with a build environment for portable CMake binaries. This image is published in the `kitware/cmake Docker Hub Repository`_ - with tag ``build-linux-<arch>-base-<date>``. + with tag ``build-<os>-<arch>-base-<date>``. -* ``linux/<arch>/deps/Dockerfile``: +* ``<os>/<arch>/deps/Dockerfile``: Produces an image with custom-built dependencies for portable CMake binaries. This image is published in the `kitware/cmake Docker Hub Repository`_ - with tag ``build-linux-<arch>-deps-<date>``. + with tag ``build-<os>-<arch>-deps-<date>``. -* ``linux/<arch>/Dockerfile``: - Produce an image containing a portable CMake binary package for Linux. +* ``<os>/<arch>/Dockerfile``: + Produce an image containing a portable CMake binary package. Build this image using the CMake source directory as the build context. The resulting image will have an ``/out`` directory containing the package. For example, on Linux ``x86_64``: @@ -36,7 +40,7 @@ may use to produce Linux binaries for CMake: $ docker cp cmake-build:/out . $ ls out/cmake-*-Linux-x86_64.* -* ``linux/<arch>/test/Dockerfile``: +* ``<os>/<arch>/test/Dockerfile``: Produces a base image with a test environment for packaged CMake binaries. For example, on Linux ``x86_64``, one may build the test base image: |