Document meaning of order of --package-db flags, fixes #12485.
authorEdward Z. Yang <ezyang@cs.stanford.edu>
Mon, 5 Sep 2016 23:19:57 +0000 (19:19 -0400)
committerBen Gamari <ben@smart-cactus.org>
Thu, 8 Sep 2016 14:43:57 +0000 (10:43 -0400)
Test Plan: none

Reviewers: austin, niteria, bgamari

Reviewed By: niteria

Subscribers: thomie

Differential Revision: https://phabricator.haskell.org/D2514

GHC Trac Issues: #12485

docs/users_guide/packages.rst

index 15c97c7..d3da125 100644 (file)
@@ -384,6 +384,11 @@ stack. Several command line options described below can further manipulate this
 initial stack. You can see GHC's effective package database stack by running
 GHC with the :ghc-flag:`-v` flag.
 
+This stack structure means that the order of :ghc-flag:`-package-db` flags or
+:envvar:`GHC_PACKAGE_PATH` is important.  Each substack of the stack
+must be well formed (packages in databases on top of the stack can refer
+to packages below, but not vice versa).
+
 *Package shadowing:* When multiple package databases are in use it
 is possible, though rarely, that the same installed package id is present in
 more than one database. In that case, packages closer to the top of the stack