Skip to content

Commit

Permalink
we don't use RST any more
Browse files Browse the repository at this point in the history
  • Loading branch information
alandekok committed May 29, 2020
1 parent 24af87d commit eb7fc67
Showing 1 changed file with 8 additions and 6 deletions.
14 changes: 8 additions & 6 deletions src/tests/modules/README.rst → src/tests/modules/README.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,20 @@
Module Tests
------------
# Module Tests

To test module `foo`, create a directory `foo`, and put a file `all.mk` into it, e.g.

foo/all.mk
```
foo/all.mk
```

All of the tests for the module should go here. The tests will be run
*only* if the module is available, and has been built correctly on the system.

The file should contain a target "MODULE.test". This is the main
The file should contain a target `MODULE.test`. This is the main
target used to test the module. The framework automatically makes the
tests depend on the module (i.e. library). So if the module source
changes, you can just do `make MODULE.test`. The module will be
re-built, and the tests will be run.

Note: all SQL tests share the same tests definitions (see sql directory).
The modules themselves simply link to the actual tests files.
Note: all SQL tests share the same tests definitions (see the `sql`
directory). The modules themselves simply link to the actual tests
files.

0 comments on commit eb7fc67

Please sign in to comment.