Commit f077f2c1 authored by Bodigrim's avatar Bodigrim
Browse files

Update build instruction, remove links to Mercurial repo

parent 3ef61934
^(?:dist|benchmarks/dist|tests/coverage|tests/dist)$
^benchmarks/.*\.txt$
^tests/text-testdata.tar.bz2$
^tests/(?:\.hpc|bm|qc|qc-hpc|stdio-hpc|text/test)$
\.(?:aux|eventlog|h[ip]|log|[oa]|orig|prof|ps|rej|swp|tix)$
~$
syntax: glob
.\#*
cabal-dev
cabal.sandbox.config
\.cabal-sandbox
scripts/CaseFolding.txt
scripts/SpecialCasing.txt
0edd5dc96024e6c0f56f175ffa673f9178cece8c 0.9.0.0
1de0da99d31ba212e179d88957cf5f3b9c4facd7 0.7.0.1
30575507578cf04b5b1501ee23b1faa83315eb88 0.1
321e61f17630dbd346c1c9991831572f964b7d5a 0.4
34cef27f87287cd3c17d78ac99e9de2d6c8a1200 0.6
3cbff6d9bca135a85e428a7f6c4e15739a562b8b 0.7.1.0
587c8661393f83cb2b9452f6cc1d6885e52fe544 0.8.1.0
61c322bd5b6446255870422f854266396169a7e5 0.5
9adb5edd9b6407335e8772ea86036b938471fc89 0.2
b4fdbef1c1027a70b95c1a81747d968890acc3f6 0.3
de7cb0cb2a72606126c357b860bb0dbf7f145ad2 0.9.0.1
f2c9b1c019e3277926378d7b5a604f1c995f0202 0.7
f3d625f2d0730cb6adf8506a1f37762178c9aea6 0.10.0.0
99ea36957b1d47145d70f2ee8b13f1ddfd09245c 0.10.0.1
1b7889216e78b00d69b32c48782111bcd935978d 0.10.0.2
75157eaec6eb38574ad5c347e75c48dcb7262dee 0.11.0.0
0d7bc7bd77ec5a8f6d064de59d459e5eaf906b0f 0.11.0.1
a9d582a75dea9a4417883019d5110a35e4c07265 0.11.0.2
36b2a3aa661892ea25101199220383ba6d579abb 0.11.0.3
06e407bcdc9a3905abf9551062ecc6f92abcdde5 0.11.0.4
94bcf16e812f6fb49b87598673e17270f48c2bf1 0.11.0.5
784a32ffbec0b77adb43e9a64328db0482007309 0.11.0.6
c808123a3d37f25004d2aad8f3a395acfcf9122f 0.11.0.7
679826e742b239c5dd0c1fa4ebe98aa4bfe02a00 0.11.0.8
b49eebfa5673da89a23939d523c9de9edbd410b0 0.11.1.0
9c820a2ecaea01bc614d8e6bccf90e57431bdcbb 0.11.1.1
ed3a60ec627af6ba8af321009aa00224b3296e47 0.11.1.2
b75d3041d275e8e76b26605b0d426a572ddf1249 0.11.1.3
53906ad0c7e64f6c9a5df569e7cc642579aab8fc 0.11.1.5
9d6d3a9690ade506897c072060eb92868e229d5c 0.11.1.6
5ac062eace36b333566d1676979a57039a188840 0.11.1.7
9f01361a73071936b6ab0bdb879f1a45cca6577a 0.11.1.8
5dce2a934be53e74310fedffb51d7bd3e61fa993 0.11.1.9
9f47a2cfc9e51fd622d7553f08ad2ac1faad0438 0.11.1.10
9f47a2cfc9e51fd622d7553f08ad2ac1faad0438 0.11.1.10
407937739e9e764f1ae0f1f9ca454c42dca38772 0.11.1.10
8b981edd27befa4c2dd334fcb7db22ac67e22b67 0.11.1.11
204da16b5098531bdf858c388e2620238ef2aa5e 0.11.1.12
6a3d847a56a69d0514a79cb212cb218271ad0917 0.11.1.13
1d2c6fa9092c6a4000b2abdd9d01f3efcd477be5 0.11.2.0
78219784cf3652cc662805bf2971bd62d80210a9 0.11.2.1
4297307ebc11ad677cfba6b40319e7e5e2c0cfee 0.11.2.3
7fa79662b66aade97fe49394977213fe6432942e 0.11.3.0
d99cd091cdf71ce807a4255f6cc509c3154f51ea 0.11.3.1
31f57612fd425d1bb56352ce6b79e41ce6699a45 1.0.0.0
7cba97c86467c1881dfced68613891f3c65561b0 1.0.0.1
62674a9bbc83145d1d7be28a05d456ab6bb5ff89 1.1.0.0
68a32d80c0829da164d1e6b3acedcc3efeda0957 1.1.0.1
6d863daafbf0e1289ec0a0eb9b4be2a0a9cb8d3d 1.1.1.0
fb7299f22449750c653ac64dee4bd63c13ea6e4c 1.1.1.1
eb170cb533b63534d166b5fd5344b36676adf140 1.1.1.2
e749e05f715d02445803f653cd3d97d5395d7c6f 1.1.1.3
b0dff8ca1142595bab489a768ca62e6a6805aac4 1.1.1.4
f8a60279237c1c28e094868740d9188dd94fcc9e 1.2.0.0
6231451979b2d33e28038b75f2dab19c9731f5c3 1.2.0.1
99a3503b4ad001fc1894e90286e96d7dea1e9195 1.2.0.2
47f138edf15576b9adaeed64784e30811099f202 1.2.0.3
0b064b0c69106bbcd13cb0099e72ae5fa2347bf0 1.2.0.4
8bbb3e222a0037035d893f731b0a23be449f7346 1.2.0.5
18c7f8e19872762b7e28ee1871e72f70ea54e3cd 1.2.0.6
42f751b87b4a187db93f595a8166d51746ff57d4 1.2.1.0
78227a84740b70dcd4cf7a65f3bcf603d87e48e2 1.2.1.1
40f268e6735749ef36f487e1d928eaa957bb431d 1.2.1.2
631fd055e27fa10983e17e9ad36d1b285b85c661 1.2.1.3
8221a68ed5ec37028357df9c6c25f52320e54ad9 1.2.2.0
ce1c5ac65eb9f5580114b4e380092b05a485e95d 1.2.2.1
d72c634a91ffe27ec5cd03921dd53efc8129d8f6 1.2.2.2
......@@ -14,12 +14,9 @@ Master [git repository](https://github.com/haskell/text):
* `git clone git://github.com/haskell/text.git`
There's also a [Mercurial mirror](https://bitbucket.org/bos/text):
* `hg clone https://bitbucket.org/bos/text`
(You can create and contribute changes using either Mercurial or git.)
To run benchmarks please clone and unpack
[test files](https://github.com/bos/text-test-data)
into `benchmarks/text-test-data`.
# Authors
......
Tests and benchmarks
====================
Prerequisites
-------------
To run the tests and benchmarks, you will need the test data, which
you can clone from one of the following locations:
* Mercurial master repository:
[bitbucket.org/bos/text-test-data](https://bitbucket.org/bos/text-test-data)
* Git mirror repository:
[github.com/bos/text-test-data](https://github.com/bos/text-test-data)
You can clone either repository into the `tests` subdirectory using
cd tests/
make text-test-data # to clone from mercurial, OR
make VCS=git text-test-data # to clone from git
Many tests and benchmarks will fail if the test files are missing.
Functional tests
----------------
The functional tests are located in the `tests` subdirectory. An overview of
what's in that directory:
Makefile Has targets for common tasks
Tests Source files of the testing code
scripts Various utility scripts
text-tests.cabal Cabal file that compiles all benchmarks
The `text-tests.cabal` builds:
- A copy of the text library, sharing the source code, but exposing all internal
modules, for testing purposes
- The different test suites
To compile, run all tests, and generate a coverage report, simply use `make`.
Benchmarks
----------
The benchmarks are located in the `benchmarks` subdirectory. An overview of
what's in that directory:
Makefile Has targets for common tasks
haskell Source files of the haskell benchmarks
python Python implementations of some benchmarks
ruby Ruby implementations of some benchmarks
text-benchmarks.cabal Cabal file which compiles all benchmarks
To compile the benchmarks, navigate to the `benchmarks` subdirectory and run
`cabal configure && cabal build`. Then, you can run the benchmarks using:
./dist/build/text-benchmarks/text-benchmarks
Or if you have a recent enough `cabal`, you can build and run the
benchmarks via
cabal new-run exe:text-benchmarks -- --help
However, since there's quite a lot of benchmarks, you usually don't want to
run them all. Instead, use the `-l` flag to get a list of benchmarks
and run the ones you want to inspect. If you want to configure the benchmarks
further, the exact parameters can be changed in `Benchmarks.hs`.
......@@ -67,7 +67,6 @@ extra-source-files:
changelog.md
include/*.h
scripts/*.hs
tests-and-benchmarks.markdown
tests/literal-rule-test.sh
tests/LiteralRuleTest.hs
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment