TOOLS

The following scripts can be found in the Tools directory:

Git Hooks

These scripts can be copied to .git/hooks to support the development work flow.

Tools/post-commit

It simply extracts the commit message and automatically adds it to the
CHANGELOG.md. Place it in your .git/hooks with access 775 to activate it.

Automation Scripts

These scripts are used by the makefile.

Tools/ctest.sh

ctest.sh
Command line test harness
 
Syntax: ctest.sh [options]
Options:
  -2 ... level 2 - include checks against artifacts of documentation (man pages)
  -h ... this text
  -v ...  verbose output
 
Runs command line tests and
is also used for code coverage tests.
 
Exit codes:
  0 .... success
  5 .... command line issues, environment issues and test failures

Tools/dockerstart.sh

dockerstart.sh
Start script for the docker image "leonardus"
 
Syntax: dockerstart.sh [options]
Options:
  -h ......... this text
 
This script is for internal use only.

Tools/dolcov.sh

dolcov.sh
Code coverage run.
 
Syntax: dolcov.sh [options]
Options:
  -h ... this text
  -v ... verbose output
 
Runs
- e2e tests,
- utest BOOST unit tests and
- ctest command line tests
with coverage statistics to produce the public/lcov HTML report.
 
Exit codes:
  0 .... success
  1 .... error

Tools/mdcli.sh

mdcli.sh
Markdown CLI extraction
 
Syntax: mdcli.sh [options] tools1 [tools2 [tools3 ...]]
  toolsX ..... tools with -h option
Options:
  -f file .... adds file after generated header.
  -h ......... this text
  -T title ... title text
  -v ......... verbose output
 
Extracts a markdown documentation of the command line interfaces
from all the given tools to standard out.
It uses the '-h' option of all the given tools.
 
Exit codes:
  0 .... success
  1 .... error

Tools/mdextract.sh

mdextract.sh
Markdown extraction.
 
Syntax: mdextract.sh [options] file1 [file2 [file3 ...]]
  fileX ... LeoScript with embedded notes.
Options:
  -h ...... this text
  -v ...... verbose output
 
Extracts markdown texts from the given files.
The rules are: Every line starting with %%! is extracted.
The leading characters %%! are removed.
The filenames are converted to markdown headers.
An empty line is inserted between extractions.
 
Exit codes:
  0 .... success
  1 .... error

Tools/tasktags.sh

tasktags.sh
Task tag extraction
 
Syntax: tasktags.sh [options]
Options:
  -h ... this text
  -t ... produce a HTML table
  -m ... produce a Markdown table
  -v ... verbose output
 
Extracts task tags from source code and markdown documents.
 
Exit codes:
  0 .... success
  1 .... error