| Cabal-1.2.2.0: A framework for packaging Haskell software | Contents | Index

Distribution.Simple.SrcDist |

Portability | portable
Stability | alpha
Maintainer | Isaac Jones <ijones@syntaxpolice.org>

Description
Implements the "`./setup sdist`" command, which creates a source distribution for this package. That is, packs up the source code into a tarball.
Synopsis

sdist :: PackageDescription -> Maybe LocalBuildInfo -> SDistFlags -> FilePath -> FilePath -> [PPSuffixHandler] -> IO ()
createArchive :: PackageDescription -> Verbosity -> Maybe LocalBuildInfo -> FilePath -> FilePath -> IO FilePath
prepareTree :: PackageDescription -> Verbosity -> Maybe LocalBuildInfo -> Bool -> FilePath -> [PPSuffixHandler] -> Int -> IO FilePath
tarBallName :: PackageDescription -> FilePath
copyFileTo :: Verbosity -> FilePath -> FilePath -> IO ()

Documentation
sdist

:: PackageDescription | information from the tarball
-> Maybe LocalBuildInfo | Information from configure
-> SDistFlags | verbosity & snapshot
-> FilePath | build prefix (temp dir)
-> FilePath | TargetPrefix
-> [PPSuffixHandler] | extra preprocessors (includes suffixes)
-> IO () |
Create a source distribution.

createArchive

:: PackageDescription | info from cabal file
-> Verbosity | verbosity
-> Maybe LocalBuildInfo | info from configure
-> FilePath | source tree to archive
-> FilePath | name of archive to create
-> IO FilePath |
Create an archive from a tree of source files, and clean up the tree.

prepareTree

:: PackageDescription | info from the cabal file
-> Verbosity | verbosity
-> Maybe LocalBuildInfo |
-> Bool | snapshot
-> FilePath | source tree to populate
-> [PPSuffixHandler] | extra preprocessors (includes suffixes)
-> Int | date
-> IO FilePath |
Prepare a directory tree of source files.

tarBallName :: PackageDescription -> FilePath
The file name of the tarball
copyFileTo :: Verbosity -> FilePath -> FilePath -> IO ()
Produced by Haddock version 0.8