git-annex/git-annex.cabal

178 lines
4.8 KiB
Text
Raw Normal View History

Name: git-annex
2013-09-20 14:35:18 +00:00
Version: 4.20130920
Cabal-Version: >= 1.8
2013-06-03 19:38:48 +00:00
License: GPL-3
Maintainer: Joey Hess <joey@kitenet.net>
Author: Joey Hess
Stability: Stable
2013-02-27 05:41:01 +00:00
Copyright: 2010-2013 Joey Hess
2012-09-24 19:20:28 +00:00
License-File: COPYRIGHT
Homepage: http://git-annex.branchable.com/
Build-type: Custom
Category: Utility
Synopsis: manage files with git, without checking their contents into git
Description:
git-annex allows managing files with git, without checking the file
contents into git. While that may seem paradoxical, it is useful when
dealing with files larger than git can currently easily handle, whether due
2012-02-15 23:43:15 +00:00
to limitations in memory, time, or disk space.
.
Even without file content tracking, being able to manage files with git,
move files around and delete files with versioned directory trees, and use
branches and distributed clones, are all very handy reasons to use git. And
annexed files can co-exist in the same git repository with regularly
versioned files, which is convenient for maintaining documents, Makefiles,
etc that are associated with annexed files but that benefit from full
revision control.
Flag S3
Description: Enable S3 support
Flag WebDAV
Description: Enable WebDAV support
2012-06-17 21:15:56 +00:00
Flag Inotify
Description: Enable inotify support
Flag Dbus
Description: Enable dbus support
Flag Assistant
Description: Enable git-annex assistant and watch command
Flag Webapp
Description: Enable git-annex webapp
2012-09-07 23:44:20 +00:00
Flag Pairing
Description: Enable pairing
2012-09-07 18:54:00 +00:00
Flag XMPP
Description: Enable notifications using XMPP
Flag DNS
Description: Enable the haskell DNS library for DNS lookup
2013-02-27 05:41:01 +00:00
Flag Production
Description: Enable production build (slower build; faster binary)
Flag Android
Description: Building for Android
Default: False
2013-02-27 05:41:01 +00:00
Flag TestSuite
Description: Embed the test suite into git-annex
Flag TDFA
Description: Use regex-tdfa for wildcards
Flag Feed
Description: Enable podcast feed support
2013-09-09 06:16:22 +00:00
Flag Quvi
Description: Enable use of quvi to download videos
Executable git-annex
Main-Is: git-annex.hs
Build-Depends: MissingH, hslogger, directory, filepath,
containers, utf8-string, network (>= 2.0), mtl (>= 2),
bytestring, old-locale, time, HTTP,
Use cryptohash rather than SHA for hashing. This is a massive win on OSX, which doesn't have a sha256sum normally. Only use external hash commands when the file is > 1 mb, since cryptohash is quite close to them in speed. SHA is still used to calculate HMACs. I don't quite understand cryptohash's API for those. Used the following benchmark to arrive at the 1 mb number. 1 mb file: benchmarking sha256/internal mean: 13.86696 ms, lb 13.83010 ms, ub 13.93453 ms, ci 0.950 std dev: 249.3235 us, lb 162.0448 us, ub 458.1744 us, ci 0.950 found 5 outliers among 100 samples (5.0%) 4 (4.0%) high mild 1 (1.0%) high severe variance introduced by outliers: 10.415% variance is moderately inflated by outliers benchmarking sha256/external mean: 14.20670 ms, lb 14.17237 ms, ub 14.27004 ms, ci 0.950 std dev: 230.5448 us, lb 150.7310 us, ub 427.6068 us, ci 0.950 found 3 outliers among 100 samples (3.0%) 2 (2.0%) high mild 1 (1.0%) high severe 2 mb file: benchmarking sha256/internal mean: 26.44270 ms, lb 26.23701 ms, ub 26.63414 ms, ci 0.950 std dev: 1.012303 ms, lb 925.8921 us, ub 1.122267 ms, ci 0.950 variance introduced by outliers: 35.540% variance is moderately inflated by outliers benchmarking sha256/external mean: 26.84521 ms, lb 26.77644 ms, ub 26.91433 ms, ci 0.950 std dev: 347.7867 us, lb 210.6283 us, ub 571.3351 us, ci 0.950 found 6 outliers among 100 samples (6.0%) import Crypto.Hash import Data.ByteString.Lazy as L import Criterion.Main import Common testfile :: FilePath testfile = "/run/shm/data" -- on ram disk main = defaultMain [ bgroup "sha256" [ bench "internal" $ whnfIO internal , bench "external" $ whnfIO external ] ] sha256 :: L.ByteString -> Digest SHA256 sha256 = hashlazy internal :: IO String internal = show . sha256 <$> L.readFile testfile external :: IO String external = do s <- readProcess "sha256sum" [testfile] return $ fst $ separate (== ' ') s
2013-09-22 23:45:08 +00:00
extensible-exceptions, dataenc, SHA, cryptohash, process, json,
Switch to MonadCatchIO-transformers for better handling of state while catching exceptions. As seen in this bug report, the lifted exception handling using the StateT monad throws away state changes when an action throws an exception. http://git-annex.branchable.com/bugs/git_annex_fork_bombs_on_gpg_file/ .. Which can result in cached values being redundantly calculated, or other possibly worse bugs when the annex state gets out of sync with reality. This switches from a StateT AnnexState to a ReaderT (MVar AnnexState). All changes to the state go via the MVar. So when an Annex action is running inside an exception handler, and it makes some changes, they immediately go into affect in the MVar. If it then throws an exception (or even crashes its thread!), the state changes are still in effect. The MonadCatchIO-transformers change is actually only incidental. I could have kept on using lifted-base for the exception handling. However, I'd have needed to write a new instance of MonadBaseControl for the new monad.. and I didn't write the old instance.. I begged Bas and he kindly sent it to me. Happily, MonadCatchIO-transformers is able to derive a MonadCatchIO instance for my monad. This is a deep level change. It passes the test suite! What could it break? Well.. The most likely breakage would be to code that runs an Annex action in an exception handler, and *wants* state changes to be thrown away. Perhaps the state changes leaves the state inconsistent, or wrong. Since there are relatively few places in git-annex that catch exceptions in the Annex monad, and the AnnexState is generally just used to cache calculated data, this is unlikely to be a problem. Oh yeah, this change also makes Assistant.Types.ThreadedMonad a bit redundant. It's now entirely possible to run concurrent Annex actions in different threads, all sharing access to the same state! The ThreadedMonad just adds some extra work on top of that, with its own MVar, and avoids such actions possibly stepping on one-another's toes. I have not gotten rid of it, but might try that later. Being able to run concurrent Annex actions would simplify parts of the Assistant code.
2013-05-19 18:16:36 +00:00
base (>= 4.5 && < 4.8), monad-control, MonadCatchIO-transformers,
IfElse, text, QuickCheck >= 2.1, bloomfilter, edit-distance, process,
2013-09-09 06:16:22 +00:00
SafeSemaphore, uuid, random, dlist, unix-compat
-- Need to list these because they're generated from .hsc files.
Other-Modules: Utility.Touch Utility.Mounts
2012-07-26 02:04:10 +00:00
Include-Dirs: Utility
C-Sources: Utility/libdiskfree.c Utility/libmounts.c
2013-02-27 05:41:01 +00:00
CC-Options: -Wall
GHC-Options: -Wall
CPP-Options: -DWITH_CLIBS
2013-04-14 16:49:09 +00:00
Extensions: PackageImports
-- Some things don't work with the non-threaded RTS.
GHC-Options: -threaded
2013-02-27 05:41:01 +00:00
if flag(Production)
GHC-Options: -O2
if os(windows)
CPP-Options: -D__WINDOWS__
else
Build-Depends: unix
if flag(TestSuite)
2013-02-28 03:21:43 +00:00
Build-Depends: HUnit
CPP-Options: -DWITH_TESTSUITE
if flag(TDFA)
Build-Depends: regex-tdfa
CPP-Options: -DWITH_TDFA
if flag(S3)
Build-Depends: hS3
CPP-Options: -DWITH_S3
if flag(WebDAV)
2012-12-06 22:04:38 +00:00
Build-Depends: DAV (>= 0.3), http-conduit, xml-conduit, http-types
2012-11-18 17:28:18 +00:00
CPP-Options: -DWITH_WEBDAV
if flag(Assistant) && ! os(windows) && ! os(solaris)
Build-Depends: async, stm (>= 2.3)
CPP-Options: -DWITH_ASSISTANT
if flag(Android)
Build-Depends: data-endian
CPP-Options: -D__ANDROID__
if flag(Assistant)
if os(linux) && flag(Inotify)
Build-Depends: hinotify
CPP-Options: -DWITH_INOTIFY
else
if os(darwin)
Build-Depends: hfsevents
CPP-Options: -DWITH_FSEVENTS
else
if (! os(windows) && ! os(solaris) && ! os(linux))
2013-09-22 18:13:31 +00:00
if flag(Android)
Build-Depends: hinotify
CPP-Options: -DWITH_INOTIFY
else
CPP-Options: -DWITH_KQUEUE
C-Sources: Utility/libkqueue.c
if os(linux) && flag(Dbus)
Build-Depends: dbus (>= 0.10.3)
CPP-Options: -DWITH_DBUS
if flag(Webapp)
Build-Depends:
yesod, yesod-default, yesod-static, yesod-form, yesod-core,
case-insensitive, http-types, transformers, wai, wai-logger, warp,
blaze-builder, crypto-api, hamlet, clientsession,
2013-09-09 06:16:22 +00:00
template-haskell, data-default, aeson
CPP-Options: -DWITH_WEBAPP
if flag(Pairing)
2012-09-07 23:44:20 +00:00
Build-Depends: network-multicast, network-info
CPP-Options: -DWITH_PAIRING
2012-09-07 18:54:00 +00:00
if flag(XMPP)
2012-10-31 15:50:43 +00:00
Build-Depends: network-protocol-xmpp, gnutls (>= 0.1.4), xml-types
CPP-Options: -DWITH_XMPP
if flag(DNS)
Build-Depends: dns
CPP-Options: -DWITH_DNS
if flag(Feed)
Build-Depends: feed
CPP-Options: -DWITH_FEED
2013-09-09 06:16:22 +00:00
if flag(Quvi)
Build-Depends: aeson
CPP-Options: -DWITH_QUVI
source-repository head
type: git
location: git://git-annex.branchable.com/