| 1 |
commit: a18c93feb60e6151044affec1663eb685529b16e |
| 2 |
Author: Michał Górny <mgorny <AT> gentoo <DOT> org> |
| 3 |
AuthorDate: Sun Jul 31 14:44:38 2011 +0000 |
| 4 |
Commit: Michał Górny <mgorny <AT> gentoo <DOT> org> |
| 5 |
CommitDate: Sun Jul 31 14:44:38 2011 +0000 |
| 6 |
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/pms-test-suite.git;a=commit;h=a18c93fe |
| 7 |
|
| 8 |
Update README on test execution. |
| 9 |
|
| 10 |
--- |
| 11 |
README | 31 +++++++++++++++++++++++-------- |
| 12 |
1 files changed, 23 insertions(+), 8 deletions(-) |
| 13 |
|
| 14 |
diff --git a/README b/README |
| 15 |
index a0bc0bb..c05f9b5 100644 |
| 16 |
--- a/README |
| 17 |
+++ b/README |
| 18 |
@@ -20,18 +20,33 @@ to determine whether the PM does comply to the PMS [1]. |
| 19 |
How to run it |
| 20 |
------------- |
| 21 |
|
| 22 |
-The code is currently in early stage of development, you can try out some |
| 23 |
-of the functions already implemented. |
| 24 |
+First, you need to have an overlay for the tests. If you intend to use portage, |
| 25 |
+`pms-tester` can create an temporary repository and use it automatically. To do |
| 26 |
+so, run: |
| 27 |
|
| 28 |
-First you need to clone the project's git repo: |
| 29 |
+ pms-tester -R /tmp/your-repo-location |
| 30 |
|
| 31 |
- git clone git://git.overlays.gentoo.org/proj/pms-test-suite.git |
| 32 |
+If you intend to test another PM, you need to either create the repository |
| 33 |
+yourself or use the above command to let `pms-tester` create it for you. Notice |
| 34 |
+you'll need to have portage installed for that. Afterwards, you need to add |
| 35 |
+the repository to your PM configuration. |
| 36 |
|
| 37 |
-Then run the `pms-tester` script, passing the path to a temporary overlay |
| 38 |
-location as its -R option: |
| 39 |
+For example, setting up a test repository for portage configs can be achieved |
| 40 |
+through: |
| 41 |
|
| 42 |
- cd pms-test-suite |
| 43 |
umask 022 |
| 44 |
- ./pms-tester -R /tmp/pms-test-suite-overlay |
| 45 |
+ mkdir -p /usr/local/portage/pms-tests/profiles |
| 46 |
+ echo 'pms-tests' > /usr/local/portage/pms-tests/profiles/repo_name |
| 47 |
+ echo 'PORTDIR_OVERLAY="${PORTDIR_OVERLAY} |
| 48 |
+ /usr/local/portage/pms-tests' >> /etc/make.conf |
| 49 |
+ |
| 50 |
+The newly-created repository can be then referenced by name: |
| 51 |
+ |
| 52 |
+ pms-tester -r pms-tests -p yourpm |
| 53 |
+ |
| 54 |
+`pms-tests` is the default name, and pms-tester will use it when no `-r` |
| 55 |
+nor `-R` is specified. Thus, the above could be simplified to: |
| 56 |
+ |
| 57 |
+ pms-tester -p yourpm |
| 58 |
|
| 59 |
<!-- vim:se syn=markdown :--> |
Archives