Skip to content

Commit

Permalink
note about package id added
Browse files Browse the repository at this point in the history
  • Loading branch information
davidsanfal committed May 6, 2024
1 parent 7036998 commit 05235e0
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 2 deletions.
2 changes: 1 addition & 1 deletion reference/runners.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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``).
Expand Down
6 changes: 5 additions & 1 deletion reference/runners/docker.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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<reference_commands_cache>` 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
-------------------

Expand Down

0 comments on commit 05235e0

Please sign in to comment.