[namcap,3/5] README: Document how to run the test suite

Message ID 20200117131931.1746498-3-archlinux@thecybershadow.net
State New
Headers show
Series
  • [namcap,1/5] namcap-devel: Quote arguments
Related show

Commit Message

Vladimir Panteleev Jan. 17, 2020, 1:19 p.m. UTC
---
 README | 10 ++++++++++
 1 file changed, 10 insertions(+)

Patch

diff --git a/README b/README
index c90315e..83b406b 100644
--- a/README
+++ b/README
@@ -141,6 +141,16 @@  warnings we are expecting from the rules. The test suite
 is in Namcap/tests. The makepkg and pkgbuild_test submodules
 provide easy generic methods to test a rule.
 
+To run the test suite, run:
+
+env PARSE_PKGBUILD_PATH="$PWD" \
+    PATH="$PWD:$PATH" \
+    python setup.py test
+
+To run a single test, append e.g.
+"-s Namcap.tests.package.test_shebangdepends"
+to the command-line above.
+
 Here is an example testing the rule "pkgnameindesc"
 
 from Namcap.tests.pkgbuild_test import PkgbuildTest