bench_wtext(3)



bench::out::text(3tcl)  Benchmarking/Performance tools  bench::out::text(3tcl)

______________________________________________________________________________

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

SYNOPSIS
       package require Tcl  8.2

       package require bench::out::text  ?0.1.2?

       ::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 for-
       mal 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 re-
              sults 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  [http://core.tcl.tk/tcllib/reportlist].   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 out-
       put 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 (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>

tcllib                               0.1.2              bench::out::text(3tcl)

Man(1) output converted with man2html
list of all man pages