Debian Codegraph @

testing/tests/doc.test

raw
1 # %TEST-DOC: Test the --documentation option and @TEST-DOC.
2 # %TEST-EXEC: btest -R rst >rst
3 # %TEST-EXEC: btest-diff rst
4 # %TEST-EXEC: btest -R md >md
5 # %TEST-EXEC: btest-diff md
6
7 %TEST-START-FILE btest.cfg
8 [btest]
9 TestDirs = testdoc misc multipart emptydir alternatives
10 TmpDir = .tmp
11 BaselineDir = Baseline
12 %TEST-END-FILE
13
14 %TEST-START-FILE testdoc/singleline
15 @TEST-DOC: This is a single-line TEST-DOC comment.
16 @TEST-EXEC: exit 0
17 %TEST-END-FILE
18
19 %TEST-START-FILE testdoc/testdocmissing
20 # This test does not have a TEST-DOC keyword.
21 @TEST-EXEC: exit 0
22 %TEST-END-FILE
23
24 %TEST-START-FILE testdoc/multiline
25 @TEST-DOC: This is a multi-line TEST-DOC comment.
26 @TEST-DOC: This is the 2nd line.
27 @TEST-EXEC: exit 0
28 @TEST-DOC: This is the 3rd line.
29 %TEST-END-FILE
30
31 %TEST-START-FILE testdoc/badtestdoc
32 @TEST-DOC This comment will not appear in output (missing colon after TEST-DOC).
33 @TEST-EXEC: exit 0
34 %TEST-END-FILE
35
36 %TEST-START-FILE misc/requires.test
37 # This test will not run due to TEST-REQUIRES, but is always documented.
38 @TEST-REQUIRES: false
39 @TEST-DOC: This is a skipped test.
40 @TEST-EXEC: exit 0
41 %TEST-END-FILE
42
43 %TEST-START-FILE misc/subdir/subtest.test
44 @TEST-DOC: This test is in a subdirectory.
45 @TEST-EXEC: exit 0
46 %TEST-END-FILE
47
48 %TEST-START-FILE multipart/multi.test
49 # Test if TEST-DOC works for a multi-part test.
50 @TEST-DOC: 1st test part.
51 @TEST-EXEC: exit 0
52 %TEST-END-FILE
53
54 %TEST-START-FILE multipart/multi.test#2
55 @TEST-DOC: 2nd test part.
56 @TEST-EXEC: exit 0
57 %TEST-END-FILE
58
59 %TEST-START-FILE multipart/multi.test#3
60 @TEST-DOC: 3rd test part.
61 @TEST-EXEC: exit 0
62 %TEST-END-FILE
63
64 %TEST-START-FILE emptydir/ignoretest
65 @TEST-DOC: This file is ignored (and does not appear in documentation output).
66 @TEST-IGNORE
67 @TEST-EXEC: exit 0
68 %TEST-END-FILE
69
70 %TEST-START-FILE alternatives/myalternate
71 @TEST-DOC: This test runs only for the given alternative, but it will always
72 @TEST-DOC: appear in the documentation output.
73 @TEST-ALTERNATIVE: myalternative
74 @TEST-EXEC: exit 0
75 %TEST-END-FILE
76
77 %TEST-START-FILE alternatives/default
78 @TEST-DOC: This test runs if no alternative is given.
79 @TEST-ALTERNATIVE: default
80 @TEST-EXEC: exit 0
81 %TEST-END-FILE