1 |
commit: 91a841278220d7fc3012dd28faec32e1e40b46a1 |
2 |
Author: Michał Górny <mgorny <AT> gentoo <DOT> org> |
3 |
AuthorDate: Wed Jun 29 17:35:25 2011 +0000 |
4 |
Commit: Michał Górny <mgorny <AT> gentoo <DOT> org> |
5 |
CommitDate: Wed Jun 29 17:35:25 2011 +0000 |
6 |
URL: http://git.overlays.gentoo.org/gitweb/?p=proj/pms-test-suite.git;a=commit;h=91a84127 |
7 |
|
8 |
Update docs to mention supported_eapis. |
9 |
|
10 |
--- |
11 |
doc/ebuild-test-case.md | 8 ++++++-- |
12 |
1 files changed, 6 insertions(+), 2 deletions(-) |
13 |
|
14 |
diff --git a/doc/ebuild-test-case.md b/doc/ebuild-test-case.md |
15 |
index 458dcd4..4078cf1 100644 |
16 |
--- a/doc/ebuild-test-case.md |
17 |
+++ b/doc/ebuild-test-case.md |
18 |
@@ -24,7 +24,8 @@ An example use case would be like: |
19 |
class RandomExampleTest(EbuildTestCase): |
20 |
""" An absolutely random test. """ |
21 |
|
22 |
- relevant_eapis = (0, 1, 2, 4) |
23 |
+ supported_eapis = (2, 3, 4) |
24 |
+ relevant_eapis = (3, 4) |
25 |
expect_failure = True |
26 |
|
27 |
ebuild_vars = { |
28 |
@@ -43,8 +44,11 @@ Where: |
29 |
here), |
30 |
- the docstring is used to form the ebuild `DESCRIPTION` (it can be overrode |
31 |
using `ebuild_vars['DESCRIPTION']`, |
32 |
+- `supported_eapis` (_iterable of strings_) specifies for which EAPIs the test |
33 |
+ gives predictible (useful) results. It defaults to all supported EAPIs, |
34 |
- `relevant_eapis` (_iterable of strings_) specifies for which EAPIs the test |
35 |
- will be performed, |
36 |
+ will be performed by default (i.e. for which the results are expected |
37 |
+ to change). It defaults to a random EAPI from `supported_eapis`, |
38 |
- `expect_failure` (_bool_, default: _False_) specifies whether the ebuild is |
39 |
supposed to fail merge, |
40 |
- `ebuild_vars` (_dict of str -> str_) specifies additional global ebuild |