diff options
| author | Ben Gamari <ben@smart-cactus.org> | 2019-03-31 20:22:04 +0000 |
|---|---|---|
| committer | Ben Gamari <ben@well-typed.com> | 2019-04-19 10:26:17 -0400 |
| commit | f83acb7f1d2914ac5a1bdec3f0e5f8201f0260fb (patch) | |
| tree | f27b76e459b5d903bf2980237d9a6b527a305928 | |
| parent | d44f54aa8f0125f209637fa9e26a8968dbb31d8b (diff) | |
| download | haskell-cherry-pick-36d38047.tar.gz | |
users-guide: Document how to disable package environmentscherry-pick-36d38047
As noted in #16309 this somehow went undocumented.
(cherry picked from commit 36d380475d9056fdf93305985be3def00aaf6cf7)
| -rw-r--r-- | docs/users_guide/packages.rst | 10 |
1 files changed, 8 insertions, 2 deletions
diff --git a/docs/users_guide/packages.rst b/docs/users_guide/packages.rst index 632162f6c8..edb7f01ecf 100644 --- a/docs/users_guide/packages.rst +++ b/docs/users_guide/packages.rst @@ -579,6 +579,12 @@ must be relative to the location of the package environment file. Use the package environment in ⟨file⟩, or in ``$HOME/.ghc/arch-os-version/environments/⟨name⟩`` + If set to ``-`` no package environment is read. + +.. envvar:: GHC_ENVIRONMENT + + Specifies the path to the package environment file to be used by GHC. + Overridden by the :ghc-flag:`-package-env ⟨file⟩|⟨name⟩` flag if set. In order, ``ghc`` will look for the package environment in the following locations: @@ -588,11 +594,11 @@ locations: - File ``$HOME/.ghc/arch-os-version/environments/name`` if you pass the option ``-package-env ⟨name⟩``. -- File ⟨file⟩ if the environment variable ``GHC_ENVIRONMENT`` is set to +- File ⟨file⟩ if the environment variable :envvar:`GHC_ENVIRONMENT` is set to ⟨file⟩. - File ``$HOME/.ghc/arch-os-version/environments/name`` if the - environment variable ``GHC_ENVIRONMENT`` is set to ⟨name⟩. + environment variable :envvar:`GHC_ENVIRONMENT` is set to ⟨name⟩. Additionally, unless ``-hide-all-packages`` is specified ``ghc`` will also look for the package environment in the following locations: |