summaryrefslogtreecommitdiff
path: root/doc/git-annex.mdwn
diff options
context:
space:
mode:
authorGravatar Joey Hess <joey@kitenet.net>2013-02-27 15:35:07 -0400
committerGravatar Joey Hess <joey@kitenet.net>2013-02-27 15:38:21 -0400
commit38f9605143c5fc80f0948ec4e579a6b4598e70dd (patch)
tree1f93e7d42edcafc08e8fbc928fe7f6bcf1deb092 /doc/git-annex.mdwn
parent52573c7b8cd253c43e92decce6cded80d8eca8f3 (diff)
embed test suite into git annex; available by running: git annex test
I have seen some other programs do this, and think it's pretty cool. Means you can test wherever it's deployed, as well as at build time. My other reason for doing it is less happy. Cabal's handling of test suites sucks, requiring duplicated info, and even when that's done, it fails to preprocess hsc files here. Building it in avoids that and avoids having to explicitly tell cabal to enable test suites, which would then make it link the test executable every time, which is unnecessarily slow. This also has the benefit that now "make fast test" does a max speed build and tests it.
Diffstat (limited to 'doc/git-annex.mdwn')
-rw-r--r--doc/git-annex.mdwn4
1 files changed, 4 insertions, 0 deletions
diff --git a/doc/git-annex.mdwn b/doc/git-annex.mdwn
index 3b2af9cb5..a05104fa8 100644
--- a/doc/git-annex.mdwn
+++ b/doc/git-annex.mdwn
@@ -506,6 +506,10 @@ subdirectories).
With --force, even files whose content is not currently available will
be rekeyed. Use with caution.
+* test
+
+ This runs git-annex's built-in test suite.
+
* xmppgit
This command is used internally to perform git pulls over XMPP.