Clarify documentation around --project-root (digital-asset#5832)

--project-root is a bit confusing when using the assistant since it will choose the SDK version before going to the project directory. This is almost never what you intend to do so setting DAML_PROJECT seems like a better option in most cases. See digital-asset#5769 for details changelog_begin changelog_end
kgeonw · May 5, 2020 · 63a28b7 · 63a28b7
1 parent 0da6527
commit 63a28b7
Showing 1 changed file with 1 addition and 1 deletion.
diff --git a/compiler/damlc/lib/DA/Cli/Options.hs b/compiler/damlc/lib/DA/Cli/Options.hs
@@ -197,7 +197,7 @@ projectOpts name = ProjectOpts <$> projectRootOpt <*> projectCheckOpt name
             help
                 (mconcat
                      [ "Path to the root of a project containing daml.yaml. "
-                     , "If unspecified this will use the DAML_PROJECT environment variable set by the assistant."
+                     , "If you use the assistant, you should set the DAML_PROJECT environment variable instead."
                      ])
         projectCheckOpt cmdName = fmap (ProjectCheck cmdName) . switch $
                help "Check if running in DAML project."