blob: 98eac24a2f5460549819b2071aef6a5a255c270b (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
|
#! /bin/sh
# $NetBSD: help.sh,v 1.1 2020/03/30 06:40:53 rillig Exp $
#
# Test cases for "bmake help", mainly implemented in mk/help/help.awk.
#
set -eu
. "./test.subr"
test_case_set_up() {
cd "$tmpdir"
}
if test_case_begin "help topic at the top of a file, with debugging"; then
# The first line of a file does not count since it usually contains
# the CVS Id. Therefore this topic is considered too small.
create_file_lines "test.help" \
"# topic" \
"#" \
"# Explanation of the topic."
HELP_DEBUG="yes" TOPIC=":all" awk -f "$pkgsrcdir/mk/help/help.awk" \
"test.help" >"out"
assert_that "out" --file-is-lines \
'test.help:1: Adding keyword "topic"' \
'test.help:1: Ignoring section because of too small comment.' \
'test.help:3: "Explanation" is no keyword because it is mixed case' \
'test.help:3: Ignoring section because of missing keywords.' \
'No help found for :all.'
test_case_end
fi
if test_case_begin "short help topic with debugging"; then
# The topic starts in the paragraph in line 3 and has only 3 lines.
# It still has enough explanation to be considered valuable.
# This form is often used in mk/help/undefined-reference.help.
create_file_lines "test.help" \
"# $""NetBSD: ...$" \
"" \
"# topic" \
"#" \
"# Explanation of the topic."
HELP_DEBUG="yes" TOPIC=":all" awk -f "$pkgsrcdir/mk/help/help.awk" \
"test.help" >"out"
assert_that "out" --file-is-lines \
'test.help:1: "$NetBSD:" is no keyword because it is mixed case' \
'test.help:1: Ignoring section because of missing keywords.' \
'test.help:2: Ignoring section because of missing keywords.' \
'test.help:3: Adding keyword "topic"' \
'test.help:5: "Explanation" is no keyword because it is mixed case' \
'===> test.help (keywords: topic):' \
'# topic' \
'#' \
'# Explanation of the topic.' \
test_case_end
fi
if test_case_begin "short help topic"; then
# The topic starts in the paragraph in line 3 and has only 3 lines.
# It still has enough explanation to be considered valuable.
# This form is often used in mk/help/undefined-reference.help.
create_file_lines "test.help" \
"# $""NetBSD: ...$" \
"" \
"# topic" \
"#" \
"# Explanation of the topic."
TOPIC="topic" awk -f "$pkgsrcdir/mk/help/help.awk" \
"test.help" >"out"
assert_that "out" --file-is-lines \
'===> test.help (keywords: topic):' \
'# topic' \
'#' \
'# Explanation of the topic.' \
test_case_end
fi
|
