summaryrefslogtreecommitdiff
path: root/HACKING.md
diff options
context:
space:
mode:
authorLuke Shumaker <lukeshu@sbcglobal.net>2014-10-01 03:04:58 -0400
committerLuke Shumaker <lukeshu@sbcglobal.net>2014-10-01 03:04:58 -0400
commita9672366b4606a73b780e78760f73d4571caf001 (patch)
tree161e3c3a0a91d3b724a2c8aa3f6f18018cd58d64 /HACKING.md
parentb15575430febd0ccfbfdb21ed60ebd633236e059 (diff)
add a section about testing to HACKING.md
Diffstat (limited to 'HACKING.md')
-rw-r--r--HACKING.md13
1 files changed, 13 insertions, 0 deletions
diff --git a/HACKING.md b/HACKING.md
index ebe595b..6682538 100644
--- a/HACKING.md
+++ b/HACKING.md
@@ -26,6 +26,19 @@ irc.freenode.net#parabola or in personal messages. My account may be
online even if I'm not; I will eventually see your it, I do a search
for mentions of "luke" on #parabola every time I get on.
+Testing
+=======
+
+Please write unit tests for new things. Tests can be run with `make
+check`, which just runs `./testenv roundup` in the `test/` directory.
+Relatedly, you need the `roundup` tool to run the tests. `./testenv`
+can be given `--no-network` and/or `--no-sudo` to dissable tests that
+require those things. Make can be made to pass those things in by
+setting `TESTENVFLAGS`. If you don't dissable either, I *strongly*
+recommend setting TMPDIR to somewhere on a btrfs partition before
+running the tests; otherwise the chroot tests will take forever. I
+mean, they already take long on btrfs, but without it... _dang_.
+
Code content
============