1bench::out::text(n)     Benchmarking/Performance tools     bench::out::text(n)
2
3
4
5______________________________________________________________________________
6

NAME

8       bench::out::text  -  bench::out::text - Formatting benchmark results as
9       human readable text
10

SYNOPSIS

12       package require Tcl  8.2
13
14       package require bench::out::text  ?0.1.2?
15
16       ::bench::out::text bench_result
17
18______________________________________________________________________________
19

DESCRIPTION

21       This package provides commands for fomatting of benchmark results  into
22       human readable text.
23
24       A  reader  interested  in  the generation or processing of such results
25       should go and read bench - Processing benchmark suites instead.
26
27       If the bench language itself is the actual interest please  start  with
28       the bench language introduction and then proceed from there to the for‐
29       mal bench language specification.
30

PUBLIC API

32       ::bench::out::text bench_result
33              This command formats the specified benchmark result  for  output
34              to  a  file,  socket, etc. This specific command generates human
35              readable text.
36
37              For  other  formatting  styles  see  the  packages   bench   and
38              bench::out::csv  which  provide  commands  to  format  benchmark
39              results in raw form, or as importable CSV data, respectively.
40

BUGS, IDEAS, FEEDBACK

42       This document, and the package it describes, will  undoubtedly  contain
43       bugs  and  other problems.  Please report such in the category bench of
44       the  Tcllib  Trackers  [http://core.tcl.tk/tcllib/reportlist].   Please
45       also  report any ideas for enhancements you may have for either package
46       and/or documentation.
47
48       When proposing code changes, please provide unified diffs, i.e the out‐
49       put of diff -u.
50
51       Note  further  that  attachments  are  strongly  preferred over inlined
52       patches. Attachments can be made by going  to  the  Edit  form  of  the
53       ticket  immediately  after  its  creation, and then using the left-most
54       button in the secondary navigation bar.
55

SEE ALSO

57       bench, bench::out::csv
58

KEYWORDS

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

CATEGORY

63       Benchmark tools
64

66       Copyright (c) 2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>
67
68
69
70
71tcllib                               0.1.2                 bench::out::text(n)
Impressum