From: Ian Lynagh Date: Tue, 23 Feb 2010 16:45:51 +0000 (+0000) Subject: Fix more library links in the user guide X-Git-Url: http://git.megacz.com/?p=ghc-hetmet.git;a=commitdiff_plain;h=cfdf2515dd5b491f8229d44b98fa33adeeac7e60 Fix more library links in the user guide --- diff --git a/aclocal.m4 b/aclocal.m4 index 275b2e4..816e1f5 100644 --- a/aclocal.m4 +++ b/aclocal.m4 @@ -1329,10 +1329,11 @@ case "$1" in # LIBRARY_VERSION(lib) # -------------------------------- -# Gets the version number of a library +# Gets the version number of a library. +# If $1 is ghc-prim, then we define LIBRARY_ghc_prim_VERSION as 1.2.3 AC_DEFUN([LIBRARY_VERSION],[ -LIBRARY_$1_VERSION=`grep -i "^version:" libraries/$1/$1.cabal | sed "s/.* //"` -AC_SUBST(LIBRARY_$1_VERSION) +LIBRARY_[]translit([$1], [-], [_])[]_VERSION=`grep -i "^version:" libraries/$1/$1.cabal | sed "s/.* //"` +AC_SUBST(LIBRARY_[]translit([$1], [-], [_])[]_VERSION) ]) # LocalWords: fi diff --git a/configure.ac b/configure.ac index 989a223..5415246 100644 --- a/configure.ac +++ b/configure.ac @@ -903,6 +903,8 @@ AC_SUBST(BUILD_DOCBOOK_PS) AC_SUBST(BUILD_DOCBOOK_PDF) LIBRARY_VERSION(base) +LIBRARY_VERSION(Cabal) +LIBRARY_VERSION(ghc-prim) if grep ' ' compiler/ghc.cabal.in 2>&1 >/dev/null; then AC_MSG_ERROR([compiler/ghc.cabal.in contains tab characters; please remove them]) diff --git a/docs/users_guide/glasgow_exts.xml b/docs/users_guide/glasgow_exts.xml index cacf97d..4668bbb 100644 --- a/docs/users_guide/glasgow_exts.xml +++ b/docs/users_guide/glasgow_exts.xml @@ -110,7 +110,7 @@ While you really can use this stuff to write fast code, All these primitive data types and operations are exported by the library GHC.Prim, for which there is -detailed online documentation. +detailed online documentation. (This documentation is generated from the file compiler/prelude/primops.txt.pp.) @@ -7489,7 +7489,7 @@ Assertion failures can be caught, see the documentation for the Any extension from the Extension type defined in Language.Haskell.Extension + url="&libraryCabalLocation;/Language-Haskell-Extension.html">Language.Haskell.Extension may be used. GHC will report an error if any of the requested extensions are not supported. @@ -8780,7 +8780,7 @@ r) -> Special built-in functions GHC has a few built-in functions with special behaviour. These are now described in the module GHC.Prim +url="&libraryGhcPrimLocation;/GHC-Prim.html">GHC.Prim in the library documentation. diff --git a/docs/users_guide/packages.xml b/docs/users_guide/packages.xml index 409d9d0..c973f47 100644 --- a/docs/users_guide/packages.xml +++ b/docs/users_guide/packages.xml @@ -24,7 +24,7 @@ Packages a package. All you need to do is write a simple configuration file, put a few files in the right places, and you have a package. See the Cabal documentation - for details, and also the Cabal libraries (Distribution.Simple, + for details, and also the Cabal libraries (Distribution.Simple, for example). @@ -1044,7 +1044,7 @@ ghc-pkg dot | tred | dot -Tpdf >pkgs.pdf A package specification is a Haskell record; in particular, it is the record InstalledPackageInfo in the module Distribution.InstalledPackageInfo, which is part of the Cabal package distributed with GHC. + url="&libraryCabalLocation;/Distribution-InstalledPackageInfo.html#%tInstalledPackageInfo">InstalledPackageInfo in the module Distribution.InstalledPackageInfo, which is part of the Cabal package distributed with GHC. An InstalledPackageInfo has a human readable/writable syntax. The functions @@ -1180,7 +1180,7 @@ haddock-html: /usr/share/doc/ghc/html/libraries/unix (string) The type of license under which this package is distributed. This field is a value of the License type. + url="&libraryCabalLocation;/Distribution-License.html#t:License">License type. diff --git a/docs/users_guide/parallel.xml b/docs/users_guide/parallel.xml index 4e864f3..2f008ed 100644 --- a/docs/users_guide/parallel.xml +++ b/docs/users_guide/parallel.xml @@ -61,9 +61,9 @@ the FFI with concurrency. papers are an excellent introduction to what STM is, and how to use it. - The main library you need to use STM is - Control.Concurrent.STM. The main features supported are these: + The main library you need to use is the + stm library. The main features supported are these: Atomic blocks. Transactional variables. @@ -109,8 +109,8 @@ All these features are described in the papers mentioned earlier. One way to do so is forking threads using Concurrent Haskell (), but the simplest mechanism for extracting parallelism from pure code is to use the par combinator, which is closely related to (and often used - with) seq. Both of these are available from Control.Parallel: + with) seq. Both of these are available from the parallel library: infixr 0 `par` @@ -177,8 +177,9 @@ nfib n | n <= 1 = 1 statistics; see . More sophisticated combinators for expressing parallelism are - available from the Control.Parallel.Strategies module. + available from the Control.Parallel.Strategies + module in the parallel package. This module builds functionality around par, expressing more elaborate patterns of parallel computation, such as parallel map. diff --git a/docs/users_guide/ug-ent.xml.in b/docs/users_guide/ug-ent.xml.in index a69b2a0..eb1dd0f 100644 --- a/docs/users_guide/ug-ent.xml.in +++ b/docs/users_guide/ug-ent.xml.in @@ -21,4 +21,6 @@ - + + +