aboutsummaryrefslogtreecommitdiff
path: root/README
diff options
context:
space:
mode:
authorMichał Górny <mgorny@gentoo.org>2011-07-31 16:44:38 +0200
committerMichał Górny <mgorny@gentoo.org>2011-07-31 16:44:38 +0200
commita18c93feb60e6151044affec1663eb685529b16e (patch)
tree38e1287e0d5b55a5cddcd81679b5ff9e73278d0e /README
parentSwitch fetching ebuild tests to a sane URI. (diff)
downloadpms-test-suite-a18c93feb60e6151044affec1663eb685529b16e.tar.gz
pms-test-suite-a18c93feb60e6151044affec1663eb685529b16e.tar.bz2
pms-test-suite-a18c93feb60e6151044affec1663eb685529b16e.zip
Update README on test execution.
Diffstat (limited to 'README')
-rw-r--r--README31
1 files changed, 23 insertions, 8 deletions
diff --git a/README b/README
index a0bc0bb..c05f9b5 100644
--- a/README
+++ b/README
@@ -20,18 +20,33 @@ to determine whether the PM does comply to the PMS [1].
How to run it
-------------
-The code is currently in early stage of development, you can try out some
-of the functions already implemented.
+First, you need to have an overlay for the tests. If you intend to use portage,
+`pms-tester` can create an temporary repository and use it automatically. To do
+so, run:
-First you need to clone the project's git repo:
+ pms-tester -R /tmp/your-repo-location
- git clone git://git.overlays.gentoo.org/proj/pms-test-suite.git
+If you intend to test another PM, you need to either create the repository
+yourself or use the above command to let `pms-tester` create it for you. Notice
+you'll need to have portage installed for that. Afterwards, you need to add
+the repository to your PM configuration.
-Then run the `pms-tester` script, passing the path to a temporary overlay
-location as its -R option:
+For example, setting up a test repository for portage configs can be achieved
+through:
- cd pms-test-suite
umask 022
- ./pms-tester -R /tmp/pms-test-suite-overlay
+ mkdir -p /usr/local/portage/pms-tests/profiles
+ echo 'pms-tests' > /usr/local/portage/pms-tests/profiles/repo_name
+ echo 'PORTDIR_OVERLAY="${PORTDIR_OVERLAY}
+ /usr/local/portage/pms-tests' >> /etc/make.conf
+
+The newly-created repository can be then referenced by name:
+
+ pms-tester -r pms-tests -p yourpm
+
+`pms-tests` is the default name, and pms-tester will use it when no `-r`
+nor `-R` is specified. Thus, the above could be simplified to:
+
+ pms-tester -p yourpm
<!-- vim:se syn=markdown :-->