diff options
Diffstat (limited to 'lib/spack/docs/docker_for_developers.rst')
| -rw-r--r-- | lib/spack/docs/docker_for_developers.rst | 41 |
1 files changed, 41 insertions, 0 deletions
diff --git a/lib/spack/docs/docker_for_developers.rst b/lib/spack/docs/docker_for_developers.rst new file mode 100644 index 0000000000..2f1b5a949a --- /dev/null +++ b/lib/spack/docs/docker_for_developers.rst @@ -0,0 +1,41 @@ +.. Copyright 2013-2018 Lawrence Livermore National Security, LLC and other + Spack Project Developers. See the top-level COPYRIGHT file for details. + + SPDX-License-Identifier: (Apache-2.0 OR MIT) + +.. _docker_for_developers: + +===================== +Docker for Developers +===================== + +This guide is intended for people who want to use our prepared docker +environments to work on developing Spack or working on spack packages. It is +meant to serve as the companion documentation for the :ref:`packaging-guide`. + +-------- +Overview +-------- + +To get started, all you need is the latest version of ``docker``. + +.. code-block:: console + + $ cd share/spack/docker + $ source config/ubuntu.bash + $ ./run-image.sh + +This command should drop you into an interactive shell where you can run spack +within an isolated docker container running ubuntu. The copy of spack being +used should be tied to the working copy of your cloned git repo, so any changes +you make should be immediately reflected in the running docker container. Feel +free to add or modify any packages or to hack on spack, itself. Your contained +copy of spack should immediately reflect all changes. + +To work within a container running a different linux distro, source one of the +other environment files under ``config``. + +.. code-block:: console + + $ source config/fedora.bash + $ ./run-image.sh |