#1993 tests/README update suggestion

obsolete: 8.4b2
closed-fixed
Jeffrey Hobbs
5
2002-08-08
2002-07-26
Anonymous
No

in tcl/tests/README, The paragraph that reads:

You can run the tests in three ways:

(a) type "make test" in ../unix; this will run all
of the tests.

(b) type "tcltest <testFile> ?<option> <value>?

where the options and values are the
configuration options
of the tcltest package.

(c) start up tcltest in this directory, then
"source" the test
file (for example, type "source parse.test").
To run all
of the tests, type "source all.tcl". To use
the options in
interactive mode, you can set them with the
tcltest::configure
command. Set constraints with the
tcltest::testConstraints
command.

would be easier to understand to a first time reader if
it said:

You can run the tests in three ways:

(a) type "make test" in ../unix; this will create
tcltest and then run all of the tests.

(b) type "tcltest <testFile> ?<option> <value>?" in
../unix

where the options and values are the
configuration options
of the tcltest package.

(c) start up ../unix/tcltest in this directory,
then "source" the test
file (for example, type "source parse.test").
To run all
of the tests, type "source all.tcl". To use
the options in
interactive mode, you can set them with the
tcltest::configure
command. Set constraints with the
tcltest::testConstraints
command.

In other words, letting the user know what tcltest was.
Right now, if they don't run the make test, they won't
find tcltest <smile>.

Discussion

  • Logged In: YES
    user_id=79902

    Don't forget 'make runtest' - that's more reliable than
    relying on the existing presence of the tcltest binary.
    (And IIRC you don't need the tcltest binary to use the
    tcltest package.)

     
  • Don Porter
    Don Porter
    2002-07-26

    Logged In: YES
    user_id=80530

    any interpreter can use the tcltest
    package; it is pure script. Some of
    the tests in the tcltest suite use
    special testing commands embedded
    in the tcltest executable. If you run
    the tests suite files in a different
    executable, those tests will be skipped,
    but otherwise things should work.

    I leave it to the Release Notes maintainer
    to determine the best revision.

     
  • Don Porter
    Don Porter
    2002-07-26

    • labels: 104251 --> 51. Release Notes
    • assigned_to: dgp --> hobbs
     
  • Jeffrey Hobbs
    Jeffrey Hobbs
    2002-08-08

    Logged In: YES
    user_id=72656

    updated just to mention 'make tcltest' - I think only the
    executable is meant here.

     
  • Jeffrey Hobbs
    Jeffrey Hobbs
    2002-08-08

    • status: open --> closed-fixed