blob: 31428aec4ddca92ffec9ee4679d173e3fe230cbe (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
[comment {-*- tcl -*- doctools manpage}]
[manpage_begin bench::in n 0.1]
[see_also bench]
[see_also bench::out::csv]
[see_also bench::out::text]
[see_also bench_intro]
[keywords benchmark]
[keywords csv]
[keywords formatting]
[keywords {human readable}]
[keywords parsing]
[keywords performance]
[keywords reading]
[keywords testing]
[keywords text]
[copyright {2007 Andreas Kupries <andreas_kupries@users.sourceforge.net>}]
[moddesc {Benchmarking/Performance tools}]
[titledesc {bench::in - Reading benchmark results}]
[category {Benchmark tools}]
[require Tcl 8.2]
[require csv]
[require bench::in [opt 0.1]]
[description]
This package provides a command for reading benchmark results from
files, sockets, etc.
[para]
A reader interested in the creation, processing or writing of such
results should go and read
[term {bench - Processing benchmark suites}] instead.
[para]
If the bench language itself is the actual interest please start with
the [term {bench language introduction}] and then proceed from there
to the formal [term {bench language specification}].
[para]
[section {PUBLIC API}]
[list_begin definitions]
[call [cmd ::bench::in::read] [arg file]]
This command reads a benchmark result from the specified [arg file]
and returns it as its result. The command understands the three
formats created by the commands
[list_begin commands]
[cmd_def bench::out::raw] Provided by package [package bench].
[cmd_def bench::out::csv] Provided by package [package bench::out::csv].
[cmd_def bench::out::text] Provided by package [package bench::out::text].
[list_end]
[para]
and automatically detects which format is used by the input file.
[list_end]
[vset CATEGORY bench]
[include ../doctools2base/include/feedback.inc]
[manpage_end]
|
