From 31225106fbc3734e5437d2eec96576fd6f2ec98a Mon Sep 17 00:00:00 2001 From: "Paolo G. Giarrusso" Date: Thu, 4 Aug 2016 10:32:16 +0200 Subject: [PATCH] setup output: "locally installed" -> "sandboxed" Fix #2314: Clarify output from stack setup, since it confused both a user and stack developers for a while in that issue. Also update references in other code and in the guide. --- doc/GUIDE.md | 10 +++++----- src/Stack/SetupCmd.hs | 2 +- src/Stack/Types/Config.hs | 2 +- 3 files changed, 7 insertions(+), 7 deletions(-) diff --git a/doc/GUIDE.md b/doc/GUIDE.md index 435efd09f3..fcc6770c72 100644 --- a/doc/GUIDE.md +++ b/doc/GUIDE.md @@ -142,7 +142,7 @@ Let's run stack setup: michael@d30748af6d3d:~/helloworld$ stack setup Downloaded ghc-7.10.2. Installed GHC. -stack will use a locally installed GHC +stack will use a sandboxed GHC it installed For more information on paths, see 'stack path' and 'stack exec env' To use this GHC and packages outside of a project, consider using: stack ghc, stack ghci, stack runghc, or stack exec @@ -325,15 +325,15 @@ let's run `setup` a second time: ``` michael@d30748af6d3d:~/helloworld$ stack setup -stack will use a locally installed GHC +stack will use a sandboxed GHC it installed For more information on paths, see 'stack path' and 'stack exec env' To use this GHC and packages outside of a project, consider using: stack ghc, stack ghci, stack runghc, or stack exec ``` Thankfully, the command is smart enough to know not to perform an installation -twice. `setup` will either use the first GHC it finds on your PATH, or a locally -installed version. As the command output above indicates, you can use `stack +twice. `setup` will either use the first GHC it finds on your PATH, or a sandboxed +version after installing it. As the command output above indicates, you can use `stack path` for quite a bit of path information (which we'll play with more later). For now, we'll just look at where GHC is installed: @@ -1515,7 +1515,7 @@ local-hpc-root: /home/michael/wai/.stack-work/install/x86_64-linux/lts-2.17/7.8. In addition, `stack path` accepts command line arguments to state which of these keys you're interested in, which can be convenient for scripting. As a -simple example, let's find out which versions of GHC are installed locally: +simple example, let's find out the sandboxed versions of GHC that stack installed: ``` michael@d30748af6d3d:~/wai$ ls $(stack path --programs)/*.installed diff --git a/src/Stack/SetupCmd.hs b/src/Stack/SetupCmd.hs index 615e4868f6..0fd1bc45d7 100644 --- a/src/Stack/SetupCmd.hs +++ b/src/Stack/SetupCmd.hs @@ -102,7 +102,7 @@ setup SetupCmdOpts{..} wantedCompiler compilerCheck mstack = do GhcjsVersion {} -> "GHCJS" case mpaths of Nothing -> $logInfo $ "stack will use the " <> compiler <> " on your PATH" - Just _ -> $logInfo $ "stack will use a locally installed " <> compiler + Just _ -> $logInfo $ "stack will use a sandboxed " <> compiler <> " it installed" $logInfo "For more information on paths, see 'stack path' and 'stack exec env'" $logInfo $ "To use this " <> compiler <> " and packages outside of a project, consider using:" $logInfo "stack ghc, stack ghci, stack runghc, or stack exec" diff --git a/src/Stack/Types/Config.hs b/src/Stack/Types/Config.hs index 483511236a..afa2824b67 100644 --- a/src/Stack/Types/Config.hs +++ b/src/Stack/Types/Config.hs @@ -277,7 +277,7 @@ data Config = ,configSkipGHCCheck :: !Bool -- ^ Don't bother checking the GHC version or architecture. ,configSkipMsys :: !Bool - -- ^ On Windows: don't use a locally installed MSYS + -- ^ On Windows: don't use a sandboxed MSYS ,configCompilerCheck :: !VersionCheck -- ^ Specifies which versions of the compiler are acceptable. ,configLocalBin :: !(Path Abs Dir)