Small docstring update for vars.Add
[scons.git] / test / Interactive / help.py
blob869876f13ea5fe6bcba3cc65f0a49760433f3df6
1 #!/usr/bin/env python
3 # __COPYRIGHT__
5 # Permission is hereby granted, free of charge, to any person obtaining
6 # a copy of this software and associated documentation files (the
7 # "Software"), to deal in the Software without restriction, including
8 # without limitation the rights to use, copy, modify, merge, publish,
9 # distribute, sublicense, and/or sell copies of the Software, and to
10 # permit persons to whom the Software is furnished to do so, subject to
11 # the following conditions:
13 # The above copyright notice and this permission notice shall be included
14 # in all copies or substantial portions of the Software.
16 # THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY
17 # KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE
18 # WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
19 # NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE
20 # LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION
21 # OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION
22 # WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.
24 __revision__ = "__FILE__ __REVISION__ __DATE__ __DEVELOPER__"
26 """
27 Verify the behavior of the "help" subcommand (and its "h" and "?" aliases).
28 """
30 import TestSCons
32 test = TestSCons.TestSCons()
34 test.write('SConstruct', """\
35 Command('foo.out', 'foo.in', Copy('$TARGET', '$SOURCE'))
36 Command('1', [], Touch('$TARGET'))
37 """)
39 test.write('foo.in', "foo.in 1\n")
43 scons = test.start(arguments = '-Q --interactive')
45 scons.send("build foo.out 1\n")
47 test.wait_for(test.workpath('1'))
49 test.must_match(test.workpath('foo.out'), "foo.in 1\n")
53 scons.send('help\n')
55 scons.send('h\n')
57 scons.send('?\n')
59 help_text = """\
61 build [TARGETS] Build the specified TARGETS and their dependencies. 'b' is a synonym.
62 clean [TARGETS] Clean (remove) the specified TARGETS and their dependencies. 'c' is a synonym.
63 exit Exit SCons interactive mode.
64 help [COMMAND] Prints help for the specified COMMAND. 'h' and '?' are synonyms.
65 shell [COMMANDLINE] Execute COMMANDLINE in a subshell. 'sh' and '!' are synonyms.
66 version Prints SCons version information.
67 """
69 expect_stdout = """\
70 scons>>> Copy("foo.out", "foo.in")
71 Touch("1")
72 scons>>> %(help_text)s
73 scons>>> %(help_text)s
74 scons>>> %(help_text)s
75 scons>>>
76 """ % locals()
78 test.finish(scons, stdout = expect_stdout)
82 test.pass_test()
84 # Local Variables:
85 # tab-width:4
86 # indent-tabs-mode:nil
87 # End:
88 # vim: set expandtab tabstop=4 shiftwidth=4: