Cabal-1.4.0.2: A framework for packaging Haskell software Source code Contents Index

Distribution.Simple.SrcDist Portability portable Stability alpha Maintainer Isaac Jones <ijones@syntaxpolice.org>

Contents The top level action Parts of sdist Snaphots

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 () printPackageProblems :: Verbosity -> PackageDescription -> IO () prepareTree :: Verbosity -> PackageDescription -> Maybe LocalBuildInfo -> FilePath -> FilePath -> [PPSuffixHandler] -> IO FilePath createArchive :: Verbosity -> PackageDescription -> Maybe LocalBuildInfo -> FilePath -> FilePath -> IO FilePath prepareSnapshotTree :: Verbosity -> PackageDescription -> Maybe LocalBuildInfo -> FilePath -> FilePath -> [PPSuffixHandler] -> CalendarTime -> IO FilePath snapshotVersion :: CalendarTime -> Version -> Version dateToSnapshotNumber :: CalendarTime -> Int

The top level action

sdist Source

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

Parts of sdist

printPackageProblems :: Verbosity -> PackageDescription -> IO () Source

prepareTree Source

:: Verbosity verbosity -> PackageDescription info from the cabal file -> Maybe LocalBuildInfo -> FilePath dist dir -> FilePath source tree to populate -> [PPSuffixHandler] extra preprocessors (includes suffixes) -> IO FilePath the name of the dir created and populated Prepare a directory tree of source files.

createArchive Source

:: Verbosity verbosity -> PackageDescription info from cabal file -> 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.

Snaphots

prepareSnapshotTree Source

:: Verbosity verbosity -> PackageDescription info from the cabal file -> Maybe LocalBuildInfo -> FilePath dist dir -> FilePath source tree to populate -> [PPSuffixHandler] extra preprocessors (includes suffixes) -> CalendarTime snapshot date -> IO FilePath the resulting temp dir Prepare a directory tree of source files for a snapshot version with the given date.

snapshotVersion :: CalendarTime -> Version -> Version Source

Modifies a Version by appending a snapshot number corresponding to the given date.

dateToSnapshotNumber :: CalendarTime -> Int Source

Given a date produce a corresponding integer representation. For example given a date 18032008 produce the number 20080318.

Produced by Haddock version 2.3.0