File: README.md

package info (click to toggle)
criterion 2.3.3git1-1
  • links: PTS, VCS
  • area: main
  • in suites: bullseye
  • size: 3,832 kB
  • sloc: ansic: 17,852; cpp: 795; python: 72; sh: 27; makefile: 23
file content (46 lines) | stat: -rw-r--r-- 1,566 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
# Autotools skeleton

This is a project skeleton that uses criterion tests with the TAP test driver.

## How this works

Be sure to do the following to get similar setups to work:

1. copy `tap-driver.sh` from your automake installation ([`autogen.sh:4-7`](autogen.sh#L4-L7)).
2. create a wrapper script that contains the following ([`autogen.sh:12-15`](autogen.sh#L12-L15)):

  ```bash
  #!/bin/sh
  $1 -Otap:- --always-succeed 2>&1 >/dev/null
  ```

3. Check for criterion ([`configure.ac:5-7`](configure.ac#L5-L7)).
4. Check for awk ([`configure.ac:9`](configure.ac#L9)).
5. Check for `tap-driver.sh` ([`configure.ac:14`](configure.ac#L14)).
6. Set `LOG_COMPILER` to the path of the wrapper script created at step 2 ([`Makefile.am:2`](Makefile.am#L2)).
7. Set `LOG_DRIVER` to a command running `tap-driver.sh` with our found awk ([`Makefile.am:5-6`](Makefile.am#L5-L6)).
8. Register your test programs ([`Makefile.am:8-14`](Makefile.am#L8-L14)).

## Running the tests

The default setup assumes that criterion is installed on your system.

```
$ ./autogen.sh
$ mkdir build && cd build
$ ../configure
$ make check
```

## License

The project skeleton is licensed under the [wtfpl](http://www.wtfpl.net). Do
whatever you want with it.

### License clause

This program is free software. It comes without any warranty, to  
the extent permitted by applicable law. You can redistribute it  
and/or modify it under the terms of the Do What The Fuck You Want  
To Public License, Version 2, as published by Sam Hocevar. See  
http://www.wtfpl.net/ for more details.