coveragescannertcl reference

coveragescannertcl instruments the Tcl source code in one or more directories and their subdirectories and creates a .csmes file with the content of the instrumented files.

Instrumenting a source file means changing its content in place; coveragescannertcl therefore creates a backup copy of each Tcl file before it instruments it and there is a command line option to restore all instrumented files to their original content.

coveragescannertcl instruments all files with the suffixes .tcl, .itcl, .tk, .tclsh, .tcltest and .ttcl (unless excluded by a command line option). The backup files then have the suffixes .tclbak, .itclbak etc.

Syntax

coveragescannertcl <options> <directories>

instruments or restores the Tcl files in the given <directories>.

<options> stands for any of the following command line options:

• --cs-output=<filename>: Set the name of the generated .csmes file.

  If the <filename> does not end with .csmes, it is added automatically.

  If the option is not used, the file name is tclcoverage.csmes, and it is created in the work directory of coveragescannertcl.

• --cs-exclude-path=<path>: Exclude all Tcl files in the specified directory from instrumentation.
• --cs-include-path=<path>: Override the exclusion of all Tcl files in the specified directory.
• --cs-exclude-file-abs-regexp=<regexp>: Exclude all Tcl files with an absolute path that matches the regular expression from instrumentation.
• --cs-include-file-abs-regexp=<regexp>: Override the exclusion of all Tcl files with an absolute path that matches the regular expression.
• --cs-exclude-file-abs-wildcard=<pattern>: Exclude all Tcl files with an absolute path that matches the wildcard pattern.
• --cs-include-file-abs-wildcard=<pattern>: Override the exclusion of all Tcl files with an absolute path that matches the wildcard pattern.
• --cs-include-code-regexp=<regexp>: Include functions with a name that matches <regexp> in the instrumentation.
• --cs-exclude-code-regexp=<regexp>: Exclude functions with a name that matches <regexp> from instrumentation.
• --cs-include-code-wildcard=pattern>: Include functions with a name that matches <pattern> in the instrumentation.
• --cs-exclude-code-wildcard=<pattern>: Exclude functions with a name that matches <pattern> from instrumentation.