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
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
|
#!/usr/bin/env python
#
# MIT License
#
# Copyright The SCons Foundation
#
# Permission is hereby granted, free of charge, to any person obtaining
# a copy of this software and associated documentation files (the
# "Software"), to deal in the Software without restriction, including
# without limitation the rights to use, copy, modify, merge, publish,
# distribute, sublicense, and/or sell copies of the Software, and to
# permit persons to whom the Software is furnished to do so, subject to
# the following conditions:
#
# The above copyright notice and this permission notice shall be included
# in all copies or substantial portions of the Software.
#
# THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
# KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
# WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
# NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
# LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
# OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
# WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
import TestSCons
test = TestSCons.TestSCons()
wpath = test.workpath()
test.write('SConstruct', r"""
Help("Help text\ngoes here.\n")
""")
expect = """scons: Reading SConscript files ...
scons: done reading SConscript files.
Help text
goes here.
Use scons -H for help about SCons built-in command-line options.
"""
test.run(arguments = '-h', stdout = expect)
test.write('SConstruct', r"""
env = Environment(MORE='more', HELP='help')
env.Help("\nEven $MORE\n$HELP text!\n")
""")
expect = """scons: Reading SConscript files ...
scons: done reading SConscript files.
Even more
help text!
Use scons -H for help about SCons built-in command-line options.
"""
test.run(arguments = '-h', stdout = expect)
test.write('SConstruct', r"""
Help('\nMulti')
Help('line\n')
Help('''\
help
text!
''')
""")
expect = """\
scons: Reading SConscript files ...
scons: done reading SConscript files.
Multiline
help
text!
Use scons -H for help about SCons built-in command-line options.
"""
test.run(arguments = '-h', stdout = expect)
# Bug #2831 - append flag to Help doesn't wipe out addoptions and variables used together
test.write('SConstruct', r"""
AddOption(
'--debugging',
dest='debugging',
action='store_true',
default=False,
metavar='BDEBUGGING',
help='Compile with debugging symbols',
)
vars = Variables()
vars.Add(ListVariable('buildmod', 'List of modules to build', 'none', ['python']))
DefaultEnvironment(tools=[])
env = Environment()
Help(vars.GenerateHelpText(env), append=True)
""")
expect = ".*--debugging.*Compile with debugging symbols.*buildmod: List of modules to build.*"
test.run(arguments = '-h', stdout = expect, match=TestSCons.match_re_dotall)
# Bug 2831
# This test checks to verify that append=False doesn't include anything
# but the expected help for the specified Variable()
test.write('SConstruct', r"""
AddOption(
'--debugging',
dest='debugging',
action='store_true',
default=False,
metavar='BDEBUGGING',
help='Compile with debugging symbols',
)
vars = Variables()
vars.Add(ListVariable('buildmod', 'List of modules to build', 'none', ['python']))
DefaultEnvironment(tools=[])
env = Environment()
Help(vars.GenerateHelpText(env), append=False)
""")
expect = """\
scons: Reading SConscript files ...
scons: done reading SConscript files.
buildmod: List of modules to build
(all|none|comma-separated list of names)
allowed names: python
default: none
actual: None
Use scons -H for help about SCons built-in command-line options.
"""
test.run(arguments='-h', stdout=expect)
# Enhancement: keep_local flag saves the AddOption help,
# but not SCons' own help.
test.write('SConstruct', r"""
AddOption(
'--debugging',
dest='debugging',
action='store_true',
default=False,
metavar='BDEBUGGING',
help='Compile with debugging symbols',
)
vars = Variables()
vars.Add(ListVariable('buildmod', 'List of modules to build', 'none', ['python']))
DefaultEnvironment(tools=[])
env = Environment()
Help(vars.GenerateHelpText(env), append=True, keep_local=True)
""")
expect = """\
scons: Reading SConscript files ...
scons: done reading SConscript files.
Local Options:
--debugging Compile with debugging symbols
buildmod: List of modules to build
(all|none|comma-separated list of names)
allowed names: python
default: none
actual: None
Use scons -H for help about SCons built-in command-line options.
"""
test.run(arguments='-h', stdout=expect)
test.pass_test()
# Local Variables:
# tab-width:4
# indent-tabs-mode:nil
# End:
# vim: set expandtab tabstop=4 shiftwidth=4:
|
