Add -package-env to the flags reference
authorSimon Marlow <marlowsd@gmail.com>
Sun, 10 Jul 2016 10:00:06 +0000 (11:00 +0100)
committerSimon Marlow <marlowsd@gmail.com>
Mon, 11 Jul 2016 07:50:17 +0000 (08:50 +0100)
docs/users_guide/packages.rst
utils/mkUserGuidePart/Options/Packages.hs

index 77f23c5..0040afe 100644 (file)
@@ -1323,10 +1323,15 @@ environment specifies precisely which packages should be visible.
 Note that for the ``package-db`` directive, if a relative path is given it
 must be relative to the location of the package environment file.
 
+.. ghc-flag:: -package-env ⟨file⟩|⟨name⟩
+
+    Use the package environment in ⟨file⟩, or in
+    ``$HOME/.ghc/arch-os-version/environments/⟨name⟩``
+
 In order, ``ghc`` will look for the package environment in the following
 locations:
 
--  File ⟨file⟩ if you pass the option ``-package-env file``.
+-  File ⟨file⟩ if you pass the option :ghc-flag:`-package-env file`.
 
 -  File ``$HOME/.ghc/arch-os-version/environments/name`` if you pass the
    option ``-package-env name``.
index 36a7b48..373773c 100644 (file)
@@ -4,11 +4,11 @@ import Types
 
 packagesOptions :: [Flag]
 packagesOptions =
-  [ flag { flagName = "-this-unit-id⟨P⟩"
+  [ flag { flagName = "-this-unit-id ⟨P⟩"
          , flagDescription = "Compile to be part of unit (i.e. package) ⟨P⟩"
          , flagType = DynamicFlag
          }
-  , flag { flagName = "-package⟨P⟩"
+  , flag { flagName = "-package ⟨P⟩"
          , flagDescription = "Expose package ⟨P⟩"
          , flagType = DynamicSettableFlag
          }
@@ -16,15 +16,15 @@ packagesOptions =
          , flagDescription = "Hide all packages by default"
          , flagType = DynamicFlag
          }
-  , flag { flagName = "-hide-package⟨name⟩"
+  , flag { flagName = "-hide-package ⟨name⟩"
          , flagDescription = "Hide package ⟨P⟩"
          , flagType = DynamicSettableFlag
          }
-  , flag { flagName = "-ignore-package⟨name⟩"
+  , flag { flagName = "-ignore-package ⟨name⟩"
          , flagDescription = "Ignore package ⟨P⟩"
          , flagType = DynamicSettableFlag
          }
-  , flag { flagName = "-package-db⟨file⟩"
+  , flag { flagName = "-package-db ⟨file⟩"
          , flagDescription = "Add ⟨file⟩ to the package db stack."
          , flagType = DynamicFlag
          }
@@ -52,11 +52,11 @@ packagesOptions =
          , flagDescription = "Don't automatically link in the base and rts packages."
          , flagType = DynamicFlag
          }
-  , flag { flagName = "-trust⟨P⟩"
+  , flag { flagName = "-trust ⟨P⟩"
          , flagDescription = "Expose package ⟨P⟩ and set it to be trusted"
          , flagType = DynamicSettableFlag
          }
-  , flag { flagName = "-distrust⟨P⟩"
+  , flag { flagName = "-distrust ⟨P⟩"
          , flagDescription = "Expose package ⟨P⟩ and set it to be distrusted"
          , flagType = DynamicSettableFlag
          }
@@ -64,4 +64,8 @@ packagesOptions =
          , flagDescription = "Distrust all packages by default"
          , flagType = DynamicSettableFlag
          }
+  , flag { flagName = "-package-env ⟨file⟩|⟨name⟩"
+         , flagDescription = "Use the specified package environment."
+         , flagType = DynamicFlag
+         }
   ]