7
7
class Telemetry { }
8
8
class Telemetry::Period { }
9
9
10
+ B < Note: > This class is a Rakudo-specific feature and not standard Perl 6.
11
+
10
12
On creation, a C < Telemetry > object contains a snapshot of the current state
11
13
of the virtual machine. This is in itself useful, but generally one needs
12
14
two snapshots for the difference (which is a C < Telemetry::Period > object).
@@ -22,7 +24,7 @@ use Telemetry :COLUMNS; # imports all of the possible columns of report
22
24
use Telemetry < cpu wallclock snap >; # only imports cpu, wallclock and snap
23
25
= end code
24
26
25
- = head2 available data
27
+ = head1 Available Data
26
28
27
29
= item affinity-tasks-completed
28
30
@@ -109,7 +111,7 @@ my $t = Telemetry.new;
109
111
say "Used $t (cpu / wallclock) microseconds to execute so far";
110
112
= end code
111
113
112
- = head1 Additional subroutines
114
+ = head1 Methods
113
115
114
116
= head2 routine T
115
117
@@ -203,7 +205,7 @@ pushes.
203
205
204
206
= head3 additional named parameters
205
207
206
- = item :columns
208
+ = item C < :columns >
207
209
208
210
Specify the names of the columns to be included in the report. Names can
209
211
be specified with the full method name (e.g. C < general-workers > ) or with
@@ -214,14 +216,14 @@ If that is not set either, defaults to:
214
216
= for code :skip-test
215
217
wallclock util% max-rss gw gtc tw ttc aw atc
216
218
217
- = item :header-repeat
219
+ = item C < :header-repeat >
218
220
219
221
Specifies after how many lines the header should be repeated in the report.
220
222
If not specified, defaults to what is specified in the
221
223
C < RAKUDO_REPORT_HEADER_REPEAT > environment variable. If that is not set either,
222
224
defaults to 32.
223
225
224
- = item :legend
226
+ = item C < :legend >
225
227
226
228
Specifies whether a legend should be added to the report. If not specified,
227
229
defaults to what is specified in the C < RAKUDO_REPORT_LEGEND > environment variable.
0 commit comments