Sophie: ghc-doc-0:6.10.4-1mdv2010.0 i586

ghc-doc-6.10.4-1mdv2010.0.i586.rpm

<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!--Rendered using the Haskell Html Library v0.2-->
<HTML
><HEAD
><META HTTP-EQUIV="Content-Type" CONTENT="text/html; charset=UTF-8"
><TITLE
>Distribution.Simple.SrcDist</TITLE
><LINK HREF="haddock.css" REL="stylesheet" TYPE="text/css"
><SCRIPT SRC="haddock-util.js" TYPE="text/javascript"
></SCRIPT
><SCRIPT TYPE="text/javascript"
>window.onload = function () {setSynopsis("mini_Distribution-Simple-SrcDist.html")};</SCRIPT
></HEAD
><BODY
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="topbar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><IMG SRC="haskell_icon.gif" WIDTH="16" HEIGHT="16" ALT=" "
></TD
><TD CLASS="title"
>Cabal-1.6.0.3: A framework for packaging Haskell software</TD
><TD CLASS="topbut"
><A HREF="index.html"
>Contents</A
></TD
><TD CLASS="topbut"
><A HREF="doc-index.html"
>Index</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="modulebar"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD
><FONT SIZE="6"
>Distribution.Simple.SrcDist</FONT
></TD
><TD ALIGN="right"
><TABLE CLASS="narrow" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="infohead"
>Portability</TD
><TD CLASS="infoval"
>portable</TD
></TR
><TR
><TD CLASS="infohead"
>Maintainer</TD
><TD CLASS="infoval"
>cabal-devel@haskell.org</TD
></TR
></TABLE
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="section4"
><B
>Contents</B
></TD
></TR
><TR
><TD
><DL
><DT
><A HREF="#1"
>The top level action
</A
></DT
><DD
><DL
><DT
><A HREF="#2"
>Parts of <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3Asdist"
>sdist</A
></TT
>
</A
></DT
><DT
><A HREF="#3"
>Snaphots
</A
></DT
></DL
></DD
></DL
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Description</TD
></TR
><TR
><TD CLASS="doc"
><P
>This handles the <TT
>sdist</TT
> command. The module exports an <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3Asdist"
>sdist</A
></TT
> action but
 also some of the phases that make it up so that other tools can use just the
 bits they need. In particular the preparation of the tree of files to go
 into the source tarball is separated from actually building the source
 tarball.
</P
><P
>The <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3AcreateArchive"
>createArchive</A
></TT
> action uses the external <TT
>tar</TT
> program and assumes that
 it accepts the <TT
>-z</TT
> flag. Neither of these assumptions are valid on Windows.
 The <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3Asdist"
>sdist</A
></TT
> action now also does some distribution QA checks.
</P
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
>Synopsis</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="decl"
><A HREF="#v%3Asdist"
>sdist</A
> :: <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
> -&gt; <A HREF="Distribution-Simple-Setup.html#t%3ASDistFlags"
>SDistFlags</A
> -&gt; (<A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
>) -&gt; [<A HREF="Distribution-Simple-PreProcess.html#t%3APPSuffixHandler"
>PPSuffixHandler</A
>] -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AprintPackageProblems"
>printPackageProblems</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AprepareTree"
>prepareTree</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; [<A HREF="Distribution-Simple-PreProcess.html#t%3APPSuffixHandler"
>PPSuffixHandler</A
>] -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AcreateArchive"
>createArchive</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AprepareSnapshotTree"
>prepareSnapshotTree</A
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; [<A HREF="Distribution-Simple-PreProcess.html#t%3APPSuffixHandler"
>PPSuffixHandler</A
>] -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsnapshotPackage"
>snapshotPackage</A
> :: <A HREF="../old-time/System-Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AsnapshotVersion"
>snapshotVersion</A
> :: <A HREF="../old-time/System-Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
> -&gt; <A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
></TD
></TR
><TR
><TD CLASS="s8"
></TD
></TR
><TR
><TD CLASS="decl"
><A HREF="#v%3AdateToSnapshotNumber"
>dateToSnapshotNumber</A
> :: <A HREF="../old-time/System-Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section1"
><A NAME="1"
><A NAME="1"
>The top level action
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:sdist"
><A NAME="v%3Asdist"
></A
></A
><B
>sdist</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TD
><TD CLASS="rdoc"
>information from the tarball
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
></TD
><TD CLASS="rdoc"
>Information from configure
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-Simple-Setup.html#t%3ASDistFlags"
>SDistFlags</A
></TD
><TD CLASS="rdoc"
>verbosity &amp; snapshot
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
> -&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>build prefix (temp dir)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; [<A HREF="Distribution-Simple-PreProcess.html#t%3APPSuffixHandler"
>PPSuffixHandler</A
>]</TD
><TD CLASS="rdoc"
>extra preprocessors (includes suffixes)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Create a source distribution.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="2"
><A NAME="2"
>Parts of <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3Asdist"
>sdist</A
></TT
>
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:printPackageProblems"
><A NAME="v%3AprintPackageProblems"
></A
></A
><B
>printPackageProblems</B
> :: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../ghc-prim/GHC-Unit.html#t%3A%28%29"
>()</A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:prepareTree"
><A NAME="v%3AprepareTree"
></A
></A
><B
>prepareTree</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
></TD
><TD CLASS="rdoc"
>verbosity
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TD
><TD CLASS="rdoc"
>info from the cabal file
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>dist dir
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>source tree to populate
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; [<A HREF="Distribution-Simple-PreProcess.html#t%3APPSuffixHandler"
>PPSuffixHandler</A
>]</TD
><TD CLASS="rdoc"
>extra preprocessors (includes suffixes)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>the name of the dir created and populated
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Prepare a directory tree of source files.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:createArchive"
><A NAME="v%3AcreateArchive"
></A
></A
><B
>createArchive</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
></TD
><TD CLASS="rdoc"
>verbosity
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TD
><TD CLASS="rdoc"
>info from cabal file
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
></TD
><TD CLASS="rdoc"
>info from configure
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>source tree to archive
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>name of archive to create
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Create an archive from a tree of source files, and clean up the tree.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="section2"
><A NAME="3"
><A NAME="3"
>Snaphots
</A
></A
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:prepareSnapshotTree"
><A NAME="v%3AprepareSnapshotTree"
></A
></A
><B
>prepareSnapshotTree</B
></TD
></TR
><TR
><TD CLASS="body"
><TABLE CLASS="vanilla" CELLSPACING="0" CELLPADDING="0"
><TR
><TD CLASS="arg"
>:: <A HREF="Distribution-Verbosity.html#t%3AVerbosity"
>Verbosity</A
></TD
><TD CLASS="rdoc"
>verbosity
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TD
><TD CLASS="rdoc"
>info from the cabal file
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/Data-Maybe.html#t%3AMaybe"
>Maybe</A
> <A HREF="Distribution-Simple-LocalBuildInfo.html#t%3ALocalBuildInfo"
>LocalBuildInfo</A
></TD
><TD CLASS="rdoc"
></TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>dist dir
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>source tree to populate
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; [<A HREF="Distribution-Simple-PreProcess.html#t%3APPSuffixHandler"
>PPSuffixHandler</A
>]</TD
><TD CLASS="rdoc"
>extra preprocessors (includes suffixes)
</TD
></TR
><TR
><TD CLASS="arg"
>-&gt; <A HREF="../base/System-IO.html#t%3AIO"
>IO</A
> <A HREF="../base/System-IO.html#t%3AFilePath"
>FilePath</A
></TD
><TD CLASS="rdoc"
>the resulting temp dir
</TD
></TR
><TR
><TD CLASS="ndoc" COLSPAN="2"
>Prepare a directory tree of source files for a snapshot version.
 It is expected that the appropriate snapshot version has already been set
 in the package description, eg using <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3AsnapshotPackage"
>snapshotPackage</A
></TT
> or <TT
><A HREF="Distribution-Simple-SrcDist.html#v%3AsnapshotVersion"
>snapshotVersion</A
></TT
>.
</TD
></TR
></TABLE
></TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:snapshotPackage"
><A NAME="v%3AsnapshotPackage"
></A
></A
><B
>snapshotPackage</B
> :: <A HREF="../old-time/System-Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
> -&gt; <A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TD
></TR
><TR
><TD CLASS="doc"
>Modifies a <TT
><A HREF="Distribution-PackageDescription.html#t%3APackageDescription"
>PackageDescription</A
></TT
> by appending a snapshot number
 corresponding to the given date.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:snapshotVersion"
><A NAME="v%3AsnapshotVersion"
></A
></A
><B
>snapshotVersion</B
> :: <A HREF="../old-time/System-Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
> -&gt; <A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
></TD
></TR
><TR
><TD CLASS="doc"
>Modifies a <TT
><A HREF="../base/Data-Version.html#t%3AVersion"
>Version</A
></TT
> by appending a snapshot number corresponding
 to the given date.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="decl"
><A NAME="v:dateToSnapshotNumber"
><A NAME="v%3AdateToSnapshotNumber"
></A
></A
><B
>dateToSnapshotNumber</B
> :: <A HREF="../old-time/System-Time.html#t%3ACalendarTime"
>CalendarTime</A
> -&gt; <A HREF="../ghc-prim/GHC-Types.html#t%3AInt"
>Int</A
></TD
></TR
><TR
><TD CLASS="doc"
>Given a date produce a corresponding integer representation.
 For example given a date <TT
>18<EM
>03</EM
>2008</TT
> produce the number <TT
>20080318</TT
>.
</TD
></TR
><TR
><TD CLASS="s15"
></TD
></TR
><TR
><TD CLASS="botbar"
>Produced by <A HREF="http://www.haskell.org/haddock/"
>Haddock</A
> version 2.4.2</TD
></TR
></TABLE
></BODY
></HTML
>