[ Tcllib Home | Main Table Of Contents | Table Of Contents | Keyword Index | Categories | Modules | Applications ]

# bench::out::text(n) 0.1.3 tcllib "Benchmarking/Performance tools"

## Name

bench::out::text - bench::out::text - Formatting benchmark results as human readable text

## Synopsis

- package require Tcl 8.5 9
- package require bench::out::text ?0.1.3?

- ::bench::out::text bench_result

## Description

This package provides commands for fomatting of benchmark results into human readable text.

A reader interested in the generation or processing of such results should go and read bench - Processing benchmark suites instead.

If the bench language itself is the actual interest please start with the bench language introduction and then proceed from there to the formal bench language specification.

## PUBLIC API

::bench::out::text bench_result

  This command formats the specified benchmark result for output to a file, socket, etc. This specific command generates human readable text.

  For other formatting styles see the packages bench and bench::out::csv which provide commands to format benchmark results in raw form, or as importable CSV data, respectively.

## Bugs, Ideas, Feedback

This document, and the package it describes, will undoubtedly contain bugs and other problems. Please report such in the category bench of the Tcllib Trackers. Please also report any ideas for enhancements you may have for either package and/or documentation.

When proposing code changes, please provide unified diffs, i.e the output of diff -u.

Note further that attachments are strongly preferred over inlined patches. Attachments can be made by going to the Edit form of the ticket immediately after its creation, and then using the left-most button in the secondary navigation bar.

## See Also

bench, bench::out::csv

## Keywords

benchmark, formatting, human readable, performance, testing, text

## Category

Benchmark tools

## Copyright

Copyright © 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>