diff options
| author | Masen Furer <m_github@0x26.net> | 2023-01-25 11:24:56 -0800 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2023-01-25 11:24:56 -0800 |
| commit | 8736549a48c8467045ea2a56edddc9d4b17a4546 (patch) | |
| tree | d073a977b0871a017a2899f64216bcfc1f5ebc1c /docs/config.rst | |
| parent | d291752f6fb45a70415e45d92e0ade3023fec392 (diff) | |
| download | tox-git-8736549a48c8467045ea2a56edddc9d4b17a4546.tar.gz | |
Enforce constraints during install_package_deps (#2888)
Fix https://github.com/tox-dev/tox/issues/2386
Diffstat (limited to 'docs/config.rst')
| -rw-r--r-- | docs/config.rst | 19 |
1 files changed, 19 insertions, 0 deletions
diff --git a/docs/config.rst b/docs/config.rst index e80da066..7b702f3f 100644 --- a/docs/config.rst +++ b/docs/config.rst @@ -755,6 +755,25 @@ Pip installer latest available pre-release of any dependencies without a specified version. If ``false``, pip will only install final releases of unpinned dependencies. +.. conf:: + :keys: constrain_package_deps + :default: true + :version_added: 4.4.0 + + If ``constrain_package_deps`` is true, then tox will create and use ``{env_dir}{/}constraints.txt`` when installing + package dependnecies during ``install_package_deps`` stage. When this value is set to false, any conflicting package + dependencies will override explicit dependencies and constraints passed to ``deps``. + +.. conf:: + :keys: use_frozen_constraints + :default: false + :version_added: 4.4.0 + + When ``use_frozen_constraints`` is true, then tox will use the ``list_dependencies_command`` to enumerate package + versions in order to create ``{env_dir}{/}constraints.txt``. Otherwise the package specifications explicitly listed under + ``deps`` (or in requirements / constraints files referenced in ``deps``) will be used as the constraints. If + ``constrain_package_deps`` is false, then this setting has no effect. + User configuration ------------------ |