Update documentation to follow 2dc3b476aff28
authorEdward Z. Yang <ezyang@cs.stanford.edu>
Thu, 19 Jun 2014 16:25:59 +0000 (09:25 -0700)
committerEdward Z. Yang <ezyang@cs.stanford.edu>
Fri, 20 Jun 2014 16:21:09 +0000 (09:21 -0700)
Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
compiler/main/PackageConfig.hs

index acedd7e..514a2e0 100644 (file)
@@ -47,16 +47,11 @@ defaultPackageConfig = emptyInstalledPackageInfo
 
 -- $package_naming
 -- #package_naming#
--- Mostly the compiler deals in terms of 'PackageName's, which don't
--- have the version suffix. This is so that we don't need to know the
--- version for the @-package-name@ flag, or know the versions of
--- wired-in packages like @base@ & @rts@. Versions are confined to the
--- package sub-system.
---
--- This means that in theory you could have multiple base packages installed
--- (for example), and switch between them using @-package@\/@-hide-package@.
---
--- A 'PackageId' is a string of the form @<pkg>-<version>@.
+-- Mostly the compiler deals in terms of 'PackageId's, which have the
+-- form @<pkg>-<version>@. You're expected to pass in the version for
+-- the @-package-name@ flag. However, for wired-in packages like @base@
+-- & @rts@, we don't necessarily know what the version is, so these are
+-- handled specially; see #wired_in_packages#.
 
 -- | Turn a Cabal 'PackageIdentifier' into a GHC 'PackageId'
 mkPackageId :: PackageIdentifier -> PackageId