diff --git a/reference/runners.rst b/reference/runners.rst index bf1a2001f69..27ec21b61e0 100644 --- a/reference/runners.rst +++ b/reference/runners.rst @@ -3,7 +3,7 @@ Runners ======= -Runners are the way to run Conan remotely and transparently just by modifying the host profile. There are three requirements to be able to use the feature: +Runners provide a seamless method to execute Conan on remote build environments like Docker ones, directly from your local setup by simply configuring your host profile. - Installing a version of Conan with runner dependencies ``pip install conan[runners]``. - Install the tools to run each of the runners (``docker``). diff --git a/reference/runners/docker.rst b/reference/runners/docker.rst index a427055447a..a7269263e9d 100644 --- a/reference/runners/docker.rst +++ b/reference/runners/docker.rst @@ -17,9 +17,13 @@ To run Conan inside a docker container you need to define a ``[runner]`` section - ``copy``: copy the host cache inside the container using the :ref:`conan cache save/restore` command. - ``shared``: mount the host's Conan cache as a shared volume. -- ``remove`` **(optional, default False)**: ``True`` or ``False``. Remove the container after running the Conan command. +- ``remove`` **(optional, default false)**: ``true`` or ``false``. Remove the container after running the Conan command. - ``configfile`` **(optional, default None)**: Absolute path to a configuration file with extra parameters (see **extra configuration** section for more info). +.. note:: + + The runner profile section doesn't affect the package id. + Extra configuration -------------------