Cabal-2.2.0.1: A framework for packaging Haskell software

Distribution.Simple.SrcDist

Description

This handles the sdist command. The module exports an sdist 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.

The createArchive action uses the external tar program and assumes that it accepts the -z flag. Neither of these assumptions are valid on Windows. The sdist action now also does some distribution QA checks.

Synopsis

# The top level action

Arguments

 :: 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

Arguments

 :: Verbosity verbosity -> PackageDescription info from the cabal file -> Maybe LocalBuildInfo -> FilePath source tree to populate -> [PPSuffixHandler] extra preprocessors (includes suffixes) -> IO ()

Prepare a directory tree of source files.

createArchive :: CreateArchiveFun Source #

Create an archive from a tree of source files, and clean up the tree.

## Snapshots

Arguments

 :: Verbosity verbosity -> PackageDescription info from the cabal file -> Maybe LocalBuildInfo -> FilePath source tree to populate -> [PPSuffixHandler] extra preprocessors (includes suffixes) -> IO ()

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 snapshotPackage or snapshotVersion.

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

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

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

# Extracting the source files

Arguments

 :: Verbosity verbosity -> PackageDescription info from the cabal file -> [PPSuffixHandler] extra preprocessors (include suffixes) -> IO ([FilePath], [FilePath])

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.