diff options
author | Edward Z. Yang <ezyang@cs.stanford.edu> | 2014-07-28 15:26:07 +0100 |
---|---|---|
committer | Edward Z. Yang <ezyang@cs.stanford.edu> | 2014-07-28 15:26:07 +0100 |
commit | a62c3454e29fc3a90077d56749b4d9d9b8b5db9c (patch) | |
tree | dc49a739c59369834c9d84ec96522830778fad7f /docs/users_guide/packages.xml | |
parent | 546029e4da13592b2f503805c16b7fdfc6c89725 (diff) | |
download | haskell-a62c3454e29fc3a90077d56749b4d9d9b8b5db9c.tar.gz |
Don't call installed package IDs 'package IDs'; they're different.
Signed-off-by: Edward Z. Yang <ezyang@cs.stanford.edu>
Diffstat (limited to 'docs/users_guide/packages.xml')
-rw-r--r-- | docs/users_guide/packages.xml | 25 |
1 files changed, 12 insertions, 13 deletions
diff --git a/docs/users_guide/packages.xml b/docs/users_guide/packages.xml index 3aaacea147..7a2543d3f5 100644 --- a/docs/users_guide/packages.xml +++ b/docs/users_guide/packages.xml @@ -183,7 +183,7 @@ exposed-modules: Network.BSD, <listitem> <para> Exposes a package like <option>-package</option>, but the - package is named by its ID rather than by name. This is a + package is named by its installed package ID rather than by name. This is a more robust way to name packages, and can be used to select packages that would otherwise be shadowed. Cabal passes <option>-package-id</option> flags to GHC. @@ -528,12 +528,11 @@ _ZCMain_main_closure </sect2> <sect2 id="package-ids"> - <title>Package IDs, dependencies, and broken packages</title> + <title>Installed package IDs, dependencies, and broken packages</title> <para>Each installed package has a unique identifier (the - “installed package ID”, or just “package - ID” for short) , which distinguishes it from all other - installed packages on the system. To see the package IDs + “installed package ID”), which distinguishes it from all other + installed packages on the system. To see the installed package IDs associated with each installed package, use <literal>ghc-pkg list -v</literal>:</para> @@ -549,10 +548,10 @@ using cache: /usr/lib/ghc-6.12.1/package.conf.d/package.cache </screen> <para> - The string in parentheses after the package name is the package + The string in parentheses after the package name is the installed package ID: it normally begins with the package name and version, and ends in a hash string derived from the compiled package. - Dependencies between packages are expressed in terms of package + Dependencies between packages are expressed in terms of installed package IDs, rather than just packages and versions. For example, take a look at the dependencies of the <literal>haskell98</literal> package: @@ -570,14 +569,14 @@ depends: array-0.2.0.1-9cbf76a576b6ee9c1f880cf171a0928d </screen> <para> - The purpose of the package ID is to detect problems caused by + The purpose of the installed package ID is to detect problems caused by re-installing a package without also recompiling the packages that depend on it. Recompiling dependencies is necessary, because the newly compiled package may have a different ABI (Application Binary Interface) than the previous version, even if both packages were built from the same source code using the - same compiler. With package IDs, a recompiled - package will have a different package ID from the previous + same compiler. With installed package IDs, a recompiled + package will have a different installed package ID from the previous version, so packages that depended on the previous version are now orphaned - one of their dependencies is not satisfied. Packages that are broken in this way are shown in @@ -692,7 +691,7 @@ haskell98-1.0.1.0 packages. A package specifier that matches all version of the package can also be written <replaceable>pkg</replaceable><literal>-*</literal>, to make it clearer that multiple packages are being matched. To match - against the package ID instead of just package name and version, + against the installed package ID instead of just package name and version, pass the <option>--ipid</option> flag.</para> <variablelist> @@ -1060,7 +1059,7 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf </term> <listitem> <para>Causes <literal>ghc-pkg</literal> to interpret arguments - as package IDs (e.g., an identifier like + as installed package IDs (e.g., an identifier like <literal>unix-2.3.1.0-de7803f1a8cd88d2161b29b083c94240 </literal>). This is useful if providing just the package name and version are ambiguous (in old versions of GHC, this @@ -1308,7 +1307,7 @@ haddock-html: /usr/share/doc/ghc/html/libraries/unix <indexterm><primary><literal>id</literal></primary><secondary>package specification</secondary></indexterm> </term> <listitem> - <para>The package ID. It is up to you to choose a suitable + <para>The installed package ID. It is up to you to choose a suitable one.</para> </listitem> </varlistentry> |