summary refs log tree commit diff
path: root/doc
diff options
context:
space:
mode:
authorTom McLaughlin <pyro777@gmail.com>2019-05-14 23:28:00 -0700
committerFrederik Rietdijk <fridh@fridh.nl>2019-05-15 08:27:59 +0200
commit7f3d805e1c3bf2fd517bf1121ad015171a054dd0 (patch)
tree8b6ab91f7592b12c5eae712a76561932b3354d7d /doc
parentd33ab9951cc58a160895856f09d47ef6d38ee2fb (diff)
downloadnixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.tar
nixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.tar.gz
nixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.tar.bz2
nixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.tar.lz
nixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.tar.xz
nixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.tar.zst
nixpkgs-7f3d805e1c3bf2fd517bf1121ad015171a054dd0.zip
Add documentation for recent permitUserSite change (#61502)
Diffstat (limited to 'doc')
-rw-r--r--doc/languages-frameworks/python.section.md2
1 files changed, 2 insertions, 0 deletions
diff --git a/doc/languages-frameworks/python.section.md b/doc/languages-frameworks/python.section.md
index b72616a7565..1dc111114bd 100644
--- a/doc/languages-frameworks/python.section.md
+++ b/doc/languages-frameworks/python.section.md
@@ -594,6 +594,7 @@ All parameters from `stdenv.mkDerivation` function are still supported. The foll
 * `catchConflicts ? true`: If `true`, abort package build if a package name appears more than once in dependency tree. Default is `true`.
 * `disabled` ? false: If `true`, package is not build for the particular Python interpreter version.
 * `dontWrapPythonPrograms ? false`: Skip wrapping of python programs.
+* `permitUserSite ? false`: Skip setting the `PYTHONNOUSERSITE` environment variable in wrapped programs.
 * `installFlags ? []`: A list of strings. Arguments to be passed to `pip install`. To pass options to `python setup.py install`, use `--install-option`. E.g., `installFlags=["--install-option='--cpp_implementation'"]`.
 * `format ? "setuptools"`: Format of the source. Valid options are `"setuptools"`, `"pyproject"`, `"flit"`, `"wheel"`, and `"other"`. `"setuptools"` is for when the source has a `setup.py` and `setuptools` is used to build a wheel, `flit`, in case `flit` should be used to build a wheel, and `wheel` in case a wheel is provided. Use `other` when a custom `buildPhase` and/or `installPhase` is needed.
 * `makeWrapperArgs ? []`: A list of strings. Arguments to be passed to `makeWrapper`, which wraps generated binaries. By default, the arguments to `makeWrapper` set `PATH` and `PYTHONPATH` environment variables before calling the binary. Additional arguments here can allow a developer to set environment variables which will be available when the binary is run. For example, `makeWrapperArgs = ["--set FOO BAR" "--set BAZ QUX"]`.
@@ -756,6 +757,7 @@ specified packages in its path.
 * `extraLibs`: List of packages installed inside the environment.
 * `postBuild`: Shell command executed after the build of environment.
 * `ignoreCollisions`: Ignore file collisions inside the environment (default is `false`).
+* `permitUserSite`: Skip setting the `PYTHONNOUSERSITE` environment variable in wrapped binaries in the environment.
 
 #### `python.withPackages` function