/usr/share/doc/libghc-cabal-doc/html/Distribution-Simple-SrcDist.html is in libghc-cabal-doc 1.22.5.0-2.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 | <!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Transitional//EN" "http://www.w3.org/TR/xhtml1/DTD/xhtml1-transitional.dtd"><html xmlns="http://www.w3.org/1999/xhtml"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8" /><title>Distribution.Simple.SrcDist</title><link href="ocean.css" rel="stylesheet" type="text/css" title="Ocean" /><script src="haddock-util.js" type="text/javascript"></script><script type="text/javascript">//<![CDATA[
window.onload = function () {pageLoad();setSynopsis("mini_Distribution-Simple-SrcDist.html");};
//]]>
</script></head><body><div id="package-header"><ul class="links" id="page-menu"><li><a href="src/Distribution-Simple-SrcDist.html">Source</a></li><li><a href="index.html">Contents</a></li><li><a href="doc-index.html">Index</a></li></ul><p class="caption">Cabal-1.22.5.0: A framework for packaging Haskell software</p></div><div id="content"><div id="module-header"><table class="info"><tr><th>Copyright</th><td>Simon Marlow 2004</td></tr><tr><th>License</th><td>BSD3</td></tr><tr><th>Maintainer</th><td>cabal-devel@haskell.org</td></tr><tr><th>Portability</th><td>portable</td></tr><tr><th>Safe Haskell</th><td>None</td></tr><tr><th>Language</th><td>Haskell98</td></tr></table><p class="caption">Distribution.Simple.SrcDist</p></div><div id="table-of-contents"><p class="caption">Contents</p><ul><li><a href="#g:1">The top level action</a><ul><li><a href="#g:2">Parts of <code>sdist</code></a></li><li><a href="#g:3">Snapshots</a></li></ul></li><li><a href="#g:4">Extracting the source files</a></li></ul></div><div id="description"><p class="caption">Description</p><div class="doc"><p>This handles the <code>sdist</code> command. The module exports an <code><a href="Distribution-Simple-SrcDist.html#v:sdist">sdist</a></code> 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 <code><a href="Distribution-Simple-SrcDist.html#v:createArchive">createArchive</a></code> action uses the external <code>tar</code> program and assumes that
it accepts the <code>-z</code> flag. Neither of these assumptions are valid on Windows.
The <code><a href="Distribution-Simple-SrcDist.html#v:sdist">sdist</a></code> action now also does some distribution QA checks.</p></div></div><div id="synopsis"><p id="control.syn" class="caption expander" onclick="toggleSection('syn')">Synopsis</p><ul id="section.syn" class="hide" onclick="toggleSection('syn')"><li class="src short"><a href="#v:sdist">sdist</a> :: <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a> -> <a href="Distribution-Simple-Setup.html#t:SDistFlags">SDistFlags</a> -> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a>) -> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:printPackageProblems">printPackageProblems</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:prepareTree">prepareTree</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a> -> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:createArchive">createArchive</a> :: CreateArchiveFun</li><li class="src short"><a href="#v:prepareSnapshotTree">prepareSnapshotTree</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a> -> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</li><li class="src short"><a href="#v:snapshotPackage">snapshotPackage</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.5.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></li><li class="src short"><a href="#v:snapshotVersion">snapshotVersion</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.5.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> -> <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:Version">Version</a></li><li class="src short"><a href="#v:dateToSnapshotNumber">dateToSnapshotNumber</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.5.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a></li><li class="src short"><a href="#v:listPackageSources">listPackageSources</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>] -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ([<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a>], [<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a>])</li></ul></div><div id="interface"><h1 id="g:1">The top level action</h1><div class="top"><p class="src"><a name="v:sdist" class="def">sdist</a> <a href="src/Distribution-Simple-SrcDist.html#sdist" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></td><td class="doc"><p>information from the tarball</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a></td><td class="doc"><p>Information from configure</p></td></tr><tr><td class="src">-> <a href="Distribution-Simple-Setup.html#t:SDistFlags">SDistFlags</a></td><td class="doc"><p>verbosity & snapshot</p></td></tr><tr><td class="src">-> (<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a>)</td><td class="doc"><p>build prefix (temp dir)</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>]</td><td class="doc"><p>extra preprocessors (includes suffixes)</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Create a source distribution.</p></div></div><h2 id="g:2">Parts of <code><a href="Distribution-Simple-SrcDist.html#v:sdist">sdist</a></code></h2><div class="top"><p class="src"><a name="v:printPackageProblems" class="def">printPackageProblems</a> :: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> () <a href="src/Distribution-Simple-SrcDist.html#printPackageProblems" class="link">Source</a></p></div><div class="top"><p class="src"><a name="v:prepareTree" class="def">prepareTree</a> <a href="src/Distribution-Simple-SrcDist.html#prepareTree" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>verbosity</p></td></tr><tr><td class="src">-> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></td><td class="doc"><p>info from the cabal file</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>source tree to populate</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>]</td><td class="doc"><p>extra preprocessors (includes suffixes)</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>Prepare a directory tree of source files.</p></div></div><div class="top"><p class="src"><a name="v:createArchive" class="def">createArchive</a> :: CreateArchiveFun <a href="src/Distribution-Simple-SrcDist.html#createArchive" class="link">Source</a></p><div class="doc"><p>Create an archive from a tree of source files, and clean up the tree.</p></div></div><h2 id="g:3">Snapshots</h2><div class="top"><p class="src"><a name="v:prepareSnapshotTree" class="def">prepareSnapshotTree</a> <a href="src/Distribution-Simple-SrcDist.html#prepareSnapshotTree" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>verbosity</p></td></tr><tr><td class="src">-> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></td><td class="doc"><p>info from the cabal file</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Maybe.html#t:Maybe">Maybe</a> <a href="Distribution-Simple-LocalBuildInfo.html#t:LocalBuildInfo">LocalBuildInfo</a></td><td class="doc empty"> </td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a></td><td class="doc"><p>source tree to populate</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>]</td><td class="doc"><p>extra preprocessors (includes
suffixes)</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ()</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>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 <code><a href="Distribution-Simple-SrcDist.html#v:snapshotPackage">snapshotPackage</a></code> or <code><a href="Distribution-Simple-SrcDist.html#v:snapshotVersion">snapshotVersion</a></code>.</p></div></div><div class="top"><p class="src"><a name="v:snapshotPackage" class="def">snapshotPackage</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.5.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> -> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a> <a href="src/Distribution-Simple-SrcDist.html#snapshotPackage" class="link">Source</a></p><div class="doc"><p>Modifies a <code><a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></code> by appending a snapshot number
corresponding to the given date.</p></div></div><div class="top"><p class="src"><a name="v:snapshotVersion" class="def">snapshotVersion</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.5.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> -> <a href="Distribution-Version.html#t:Version">Version</a> -> <a href="Distribution-Version.html#t:Version">Version</a> <a href="src/Distribution-Simple-SrcDist.html#snapshotVersion" class="link">Source</a></p><div class="doc"><p>Modifies a <code><a href="Distribution-Version.html#t:Version">Version</a></code> by appending a snapshot number corresponding
to the given date.</p></div></div><div class="top"><p class="src"><a name="v:dateToSnapshotNumber" class="def">dateToSnapshotNumber</a> :: <a href="file:///usr/share/doc/ghc-doc/html/libraries/time-1.5.0.1/Data-Time-Clock.html#t:UTCTime">UTCTime</a> -> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/Data-Int.html#t:Int">Int</a> <a href="src/Distribution-Simple-SrcDist.html#dateToSnapshotNumber" class="link">Source</a></p><div class="doc"><p>Given a date produce a corresponding integer representation.
For example given a date <code>18<em>03</em>2008</code> produce the number <code>20080318</code>.</p></div></div><h1 id="g:4">Extracting the source files</h1><div class="top"><p class="src"><a name="v:listPackageSources" class="def">listPackageSources</a> <a href="src/Distribution-Simple-SrcDist.html#listPackageSources" class="link">Source</a></p><div class="subs arguments"><p class="caption">Arguments</p><table><tr><td class="src">:: <a href="Distribution-Verbosity.html#t:Verbosity">Verbosity</a></td><td class="doc"><p>verbosity</p></td></tr><tr><td class="src">-> <a href="Distribution-PackageDescription.html#t:PackageDescription">PackageDescription</a></td><td class="doc"><p>info from the cabal file</p></td></tr><tr><td class="src">-> [<a href="Distribution-Simple-PreProcess.html#t:PPSuffixHandler">PPSuffixHandler</a>]</td><td class="doc"><p>extra preprocessors (include
suffixes)</p></td></tr><tr><td class="src">-> <a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:IO">IO</a> ([<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a>], [<a href="file:///usr/share/doc/ghc-doc/html/libraries/base-4.8.2.0/System-IO.html#t:FilePath">FilePath</a>])</td><td class="doc empty"> </td></tr></table></div><div class="doc"><p>List all source files of a package. Returns a tuple of lists: first
component is a list of ordinary files, second one is a list of those files
that may be executable.</p></div></div></div></div><div id="footer"><p>Produced by <a href="http://www.haskell.org/haddock/">Haddock</a> version 2.16.1</p></div></body></html>
|