Debian Codegraph @

Changes

raw ◀ ▶
1 Debian patch touch this file
1 =encoding utf8
2
3 =head1 Devel::NYTProf Changes
4
5 History of significant changes in Devel::NYTProf
6
7 =head2 Changes in Devel::NYTProf 6.15 - 31st Mar 2026
8
9 Updated URL linking to Brendan Gregg's Flame Graph page; thanks to Paul
10 Cochrane.
11 (L<GH 220|https://github.com/timbunce/devel-nytprof/pull/220>).
12
13 Infrastructure: set up GitHub Actions using configuration based on file
14 originally suggeted by Gabor Szabo.
15
16 Eliminated "Possible precedence problem ..." warning being emitted during
17 tests; thanks to Masahiro Iuchi.
•18 (L<GH 230|https://github.com/timbunce/devel-nytprof/pull/230>).
19
20 =head2 Changes in Devel::NYTProf 6.14 - 18th Oct 2023
21
22 B<There should be no significant differences in the performance of Devel-NYTProf
23 from that of the previous release.> This release is primarily maintenance-
24 focused.
25
26 More build-time warnings using recent versions of C compilers have been
27 eliminated, particularly with recent production releases of Perl. Thanks to
28 Karl Williamson for guidance on updating F<ppport.h> and using it to update
29 F<NYTProf.xs>.
30
31 =head2 Changes in Devel::NYTProf 6.13 - 10th Oct 2023
32
33 B<There should be no significant differences in the performance of Devel-NYTProf
34 from that of the previous release.> This release is primarily maintenance-
35 focused.
36
37 The largest difference in the distribution
38 is the removal of the F<nytprofpf> program (L<GH
39 206|https://github.com/timbunce/devel-nytprof/pull/206>). This program was
40 written for an open-source software competition which is no longer being held.
41
42 Other changes include:
43
44 Removal of remaining reference to Travis CI
45 (L<GH 202|https://github.com/timbunce/devel-nytprof/pull/202>).
46
47 Elimination of 'bad-function-cast' warnings during 'make'
48 (L<GH 205|https://github.com/timbunce/devel-nytprof/pull/205>).
49
50 Correction of typographic error in F<nytprofhtml> thanks to Amory Meltzer
51 (L<GH 210|https://github.com/timbunce/devel-nytprof/pull/210>).
52
53 Depending on Per version, skip one test file that was exercising 'given' and
54 'when' keywords (now deprecated)
55 (L<GH 211|https://github.com/timbunce/devel-nytprof/pull/211>).
56
57 Elimination of the 'register' keyword from NYTProf.xs (partial resolution of
58 L<GH 191|https://github.com/timbunce/devel-nytprof/issues/191>) which is
59 forbidden as of ISO C++17.
60
61 =head2 Changes in Devel::NYTProf 6.12 - 16th Nov 2022
62
63 B<There should be no significant differences in the performance of Devel-NYTProf
64 from that of the previous release.> This release is primarily focused on
65 adapting the library to a change in Perl 5 as of release 5.37.6 in November
66 2022; code contributed by Tony Cook in L<GH 200: support SSNEW*() macros
67 returning SSize_t instead of
68 I32|https://github.com/timbunce/devel-nytprof/pull/200>. Corrections to
69 errors in documentation contributed by joshnaitis in L<GH 198: Fix typos in
70 /bin report generators|https://github.com/timbunce/devel-nytprof/pull/198>.
71 'make' targets dependent on Subversion (former version control system) removed
72 in L<GH 196|https://github.com/timbunce/devel-nytprof/pull/196>. CPAN module
73 Sub::Name added as test-time prerequisite.
74
75 =head2 Changes in Devel::NYTProf 6.11 - 19th Sep 2021
76
77 Removed F<lib/Devel/NYTProf/js/jquery.floatThead.min.js> in L<GH 194: Remove
78 jquery.floatThead.min.js|https://github.com/timbunce/devel-nytprof/pull/194>.
79 In L<GH 192: nytprofhtml - internal anchor links in html pages go to wrong
80 locations|https://github.com/timbunce/devel-nytprof/issues/192> Shawn Laffan
81 reported that internal links to anchors in the generated HTML pages were not
82 correctly positioned in the vertical dimension. Discontinuing use of this
83 Javascript file appears to correct the problem.
84
85 =head2 Changes in Devel::NYTProf 6.10 - 9th May 2021
86
87 B<There should be no significant differences in the performance of Devel-NYTProf
88 from that of the previous release.> This release is primarily focused on
89 upgrading the jquery used and improvements to F<Makefile.PL> and the test
90 suite.
91
92 =head3 Substantive
93
94 L<GH 186: Updated jquery components to version
95 3.4.1|https://github.com/timbunce/devel-nytprof/pull/186>, based on bug report
96 L<GH 132|https://github.com/timbunce/devel-nytprof/issues/132> filed by
97 Matthew Musgrove and original patch submitted by Reini Urban.
98
99 Eliminated some C++ build-time warnings through patches submitted by Reini
100 Urban.
101
102 Officially discouraged use of F<Devel::NYTProf::Apache>. While it remains in
103 the CPAN distribution, it is not exercised by the test suite and has not been
104 updated for many years. We are open to offers to spin it out to its own CPAN
105 distribution.
106
107 =head3 Test Suite
108
109 Skip 4 test files on (Linux) quadmath builds; profile data used in these tests
110 not (yet) appropriate. Thanks to Slaven Rezić and H. Merijn Brand for
111 discussion in L<GH 168|https://github.com/timbunce/devel-nytprof/issues/168>
112 and L<GH 188|https://github.com/timbunce/devel-nytprof/issues/188>.
113
114 =head3 Housekeeping
115
116 L<GH 185|https://github.com/timbunce/devel-nytprof/pull/185>: Added F<make>
117 target C<disttest_author> for more thorough testing of release tarball.
118
119 =head2 Changes in Devel::NYTProf 6.09 - 2nd May 2021
120
121 B<There should be no significant differences in the performance of Devel-NYTProf
122 from that of the previous release.> This release is primarily focused on
123 correcting problems in the test suite introduced in version 6.08 6 days
124 earlier.
125
126 =head3 Substantive
127
128 C<Devel::NYTProf::Util::fmt_float()> modified to strip off more than one
129 leading C<0>. Thanks to Shawn Laffan in GH 170.
130
131 =head3 Test Suite
132
133 All test files now run with C<use strict; use warnings;>.
134
135 F<t/11-reader.t, t/12-data.t, t/13-fileinfo.t, t/14-subinfo.t> are now skipped
136 on longdouble builds and when C<NYTP_ZLIB_VERSION> is not set. The profile
137 data files these tests use do not work in those contexts. This should reduce
138 the number of false negatives reported by CPANtesters. Thanks to Tinita for
139 feedback in GH 169.
140
141 F<xt/90-pod.t> transferred back to F<t/> but will only run when environmental
142 variable C<NYTPROF_AUTHOR_TESTING> is set.
143
144 =head3 Housekeeping
145
146 Created environmental variable C<NYTPROF_AUTHOR_TESTING> to regulate when
147 certain unit tests and test files are run. Created `make` targets
148 C<test_author> and C<atest> (an alias) to take advantage of this envvar.
149
150 =head2 Changes in Devel::NYTProf 6.08 - 27th April 2021
151
152 B<There should be no observable differences in the performance of Devel-NYTProf
153 from that of the previous release.> This release is maintenance-focused and
154 changes mainly concern improvements in test coverage, elimination of
155 build-time warnings and correction of small errors detected by end-users.
156
157 =head3 Substantive
158
159 Corrected 1 error in F<Makefile.PL>
160 (L<https://github.com/timbunce/devel-nytprof/pull/158>; thanks to Kent Fredric).
161
162 Corrected other errors in F<NYTProf.xs> and F<ppport.h> at suggestion of Reini Urban
163 in earlier pull request.
164
165 Two subroutines in F<Devel::NYTProf::Data> -- C<packages_at_depth_subinfo()>
166 and C<package_fids()> -- which were not used anywhere in the codebase or test
167 suite were removed and placed in F<devstuff/superseded.pm>. One function --
168 C<get_str_id()> defined in F<NYTProf.xs> but never used in the codebase was
169 similarly removed and placed in F<devstuff/superseded.xs>. Anyone who was
170 using these functions may file a pull request to have them restored to the
171 codebase.
172
173 In C<Devel::NYTProf::Data::strip_prefix_from_paths()>, a branch concerned with
174 the possibility that an argument was a hash was not exercised anywhere in the
175 codebase or the test suite and was simply commented out. Anyone who was using
176 this functionality may file a pull request to have it restored to the
177 codebase.
178
179 Eliminated all build-time warnings being generated during F<make> on testing
180 platforms Linux, FreeBSD, OpenBSD, Windows.
181
182 =head3 Test Suite
183
184 Improved coverage provided by test suite to each of the following files:
185
186 lib/Devel/NYTProf/Data.pm
187 lib/Devel/NYTProf/FileInfo.pm
188 lib/Devel/NYTProf/Reader.pm
189 lib/Devel/NYTProf/SubInfo.pm
190 lib/Devel/NYTProf/Util.pm
191
192 This was accomplished mainly by adding 4 new test files:
193
194 t/11-reader.t
195 t/12-data.t
196 t/13-fileinfo.t
197 t/14-subinfo.t
198
199 ... and their corresponding data files. In addition, there were substantial
200 additions to F<t/30-util.t>.
201
202 Coverage was evaluated with C<trace_level> unset and C<trace_level> 5.
203
204 =head3 Housekeeping
205
206 Updated Travis and AppVeyor configuration files.
207
208 Updated F<MANIFEST> and F<MANIFEST.SKIP> so that F<make manifest> works as intended.
209
210 Moved the following 6 test files from F<t/> to F<xt/>:
211
212 t/68-hashline.t
213 t/71-moose.t
214 t/72-autodie.t
215 t/90-pod.t
216 t/91-pod_coverage.t
217 t/92-file_port.t
218
219 Reason: They either (a) had been previously described as insufficiently
220 developed and were being skipped; or (b) are of concern only to NYTProf
221 developers. Hence, a failure in any of them should not preclude installation
222 and use of Devel::NYTProf.
223
224 Added a F<make test_short> target to F<Makefile.PL> and environmental variable
225 C<NYTPROF_TEST_SHORT>. These will enable NYTProf developers to cut testing
226 time without significant loss in accuracy
227 (L<https://github.com/timbunce/devel-nytprof/pull/155>).
228
229 Corrected one date error in 6.07 release
230 (L<https://github.com/timbunce/devel-nytprof/issues/152>; thanks to @shawnlaffan).
231
232 Applied several commits either cherry-picked from, or initiated by Reini Urban
233 in an older pull request.
234
235 =head2 Changes in Devel::NYTProf 6.07 - 6th April 2021
236
237 Focus is to enable test suite to pass with perl-5.33.3 and higher. (Changes
238 in blead required changes in expectations set in test data files.)
239
240 Correction to MANIFEST
241 thanks to mattlaw. #142
242
243 POD improvements
244 thanks to tomhukins. #129
245
246 Makefile.PL modernizations
247 thanks to karenetheridge. #126
248
249 .gitignore corrections
250 thanks to jkeenan. #146
251
252 Adapt tests to work with 5.33 and higher
253 thanks to jkeenan. #147
254
255 =head2 Changes in Devel::NYTProf 6.06 - 4th June 2018
256
257 Fix sorting of numbers ending ...5s as microsec
258 thanks to pichi. #120
259
260 Fix tests for Strawberry Perl portable
261 thanks to shawnlaffan. #123
262
263 Fixed broken link in the pod to YAPC::NA 2014 talk video
264 thanks to manwar. #116
265
266 Add "NYTProf" to buffer overflow error message for easier triage
267 thanks to atomicstack. #119.
268
269 Add appveyor config file for CI on Windows
270 thanks to shawnlaffan. #117
271
272 =head2 Changes in Devel::NYTProf 6.05 - 23rd March 2018
273
274 Fix test failures on Perl 5.27.6+ #113
275
276 Fix to prevent memory corruption in incr_sub_inclusive_time
277 thanks to lucrocha #115
278
279 Fix test failures on Perl 5.26 w/ PERL_USE_UNSAFE_INC=0,
280 thanks to Kent Fredric #112
281
282 Fix for the double opening of the web browser with --open,
283 thanks to trizen #107
284
285 Updated links in docs from old svn repository to Github
286 thanks to smpeters #114
287
288 =head2 Changes in Devel::NYTProf 6.04 - 24th November 2016
289
290 Fixed build on perl 5.25+ due to OpSIBLING, thanks to Dan Collins #102
291 Fixed nytprofmerge on Windows thanks to andrey-starodubtsev #99
292 Fixed nytprofhtml invalid UTF-8 char and improved CSS #105
293 Fixed spelling mistake in nytprofcsv docs. Closes #95
294
295 Table headers now stay visible, thanks to Sebastian Rose #106
296 Assorted improvments to .travis.yml
297
298 =head2 Changes in Devel::NYTProf 6.03 - 25th March 2016
299
300 Fix to account for the deep stack optimizations in perl 5.23.8
301 by Dave Mitchell, with my great gratitude!
302 Fix SIGUSR2 on MSWin32 and div by zero #78 PR#79
303 with thanks to Nicolas Georges.
304 Fix for perl 5.8.8 but adding definition for tTHX.
305 Unify 'Profile format error' messages.
306
307 Improve the TROUBLESHOOTING docs.
308 Added some more docs for the start=init option #85
309 Corrected URL of KCachegrind home page #87
310 with thanks to Denis Ibaev.
311 Corrected URL of sample report #80
312 Removed dead code.nytimes.com URL and redundant history #84
313
314 =head2 Changes in Devel::NYTProf 6.02 - 2nd August 2015
315
316 FlameGraphs upgraded the latest version, which supports searching.
317 Use JSON::MaybeXS instead of JSON::Any (deprecated), thanks to Ether #73
318 Updated metacpan urls, thanks to Ether #74
319 Internal context optimizations, thanks to jandubois #75
320
321 =head2 Changes in Devel::NYTProf 6.01 - 4th April 2015
322
323 Changed the clock used on Windows to high resolution QueryPerformanceCounter
324 which makes NYTProf useful on windows, at last, thanks to bulk88, #68
325
326 Fallback to checking PATH for nytprof scripts, #61 thanks to calid
327 Fix unused variable warnings thanks to zefram, RT#103107
328 Fix handling of PERL_DISABLE_PMC, thanks to bulk88, #67
329
330 Use larger buffer size when writing the data file, thanks to bulk88 #69
331
332 Clarified the docs re DB:: functions, #63 thanks to dbooth-boston
333 Documentation cleanup thanks to wollmers, #64
334 Clarify reason for loading Devel::NYTProf as early as possible.
335 Clarification of the RUN-TIME CONTROL OF PROFILING docs
336
337 =head2 Changes in Devel::NYTProf 5.07 - 21st Feb 2015
338
339 Fixed use of nytprofcalls and flamegraph scripts to not require PATH #21
340 Fixed nytprofhtml --open for KDE4 thanks to HMBRAND RT#99080
341 Fixed for installs into directory path with spaces, mohawk2 #40
342 Fixed printf NV conversion compiler warnings thanks to zefram RT#91986
343 Disabled optimize in t/test25-strevalb.t if -DDEBUGGING and perl >= 5.20
344 as workaround for perl RT#70211, #38
345
346 Added 'addtimestamp' option to add a timestamp to the output filename
347 (similar to addpid option), PR#17 thanks to Naosuke Yokoe (zentooo)
348 Added nytprofpf script to generate reports in the plat_forms format
349 http://www.plat-forms.org PR#11 thanks to Holger Schmeisky.
350 Added ability to increase the maximum length of a subroutine name #44
351
352 Optimized output performance on threaded perl, thanks to bulk88. PR#27
353
354 Add docs re FCGI::Engine and open('-|') #20
355 Corrected typo in nytprofhtml thanks to wollmers #41
356 Fixed link to screencast, thanks to Herwin. #19
357 Added hint to use --no-flame for big reports. #28
358
359 =head2 Changes in Devel::NYTProf 5.06 - 12th Sept 2013
360
361 Fixed for perl 5.19.4. RT#88288 thanks to sprout.
362 Fixed test for change in perl 5.18.x error message text.
363 Fixed to no longer open a file when start=no. RT#86497/RT#87404.
364 Fixed compiler warnings. RT#86728 thanks to Alexander Bluhm.
365
366 Document that Devel::NYTProf needs to be loaded as early as possible
367 even when using start=no. PR#10 thanks to moritz.
368 Removed unused keyword $Id$. PR#9 thanks to dsteinbrunner.
369 Removed old benchmark.pl files. RT#86704.
370 Corrected assorted typos. PR#8 thanks to dsteinbrunner.
371 Added meta-spec to META_MERGE. PR#12 thanks to dsteinbrunner.
372
373 =head2 Changes in Devel::NYTProf 5.05 - 2nd July 2013
374
375 Fixed crash on "Can't use string as a subroutine ref" error,
376 and probably other die-at-pp_entersub cases,
377 with thanks to Zefram. RT#86638
378 Fixed crash with libcexit=1, thanks to Zefram. RT#86548
379
380 =head2 Changes in Devel::NYTProf 5.04 - 20th June 2013
381
382 Allow negative times in tests for systems with unstable clocks
383 thanks to Gisle Aas, RT#85556.
384 Added libcexit=1 option thanks to Zefram, RT#75912.
385 Added documentation for endatexit and libcexit options.
386 Added documentation for nytprofhtml --minimal
387 thanks to Mike Doherty, RT#86039.
388
389 =head2 Changes in Devel::NYTProf 5.03 - 20th May 2013
390
391 Fix windows to use flamegraph.bat [Christian Walde]
392 Generates META.yml which mentions github repo [Christian Walde]
393 Add meta robots noindex to html pages [Tokuhiro Matsuno]
394
395 =head2 Changes in Devel::NYTProf 5.02 - 21st April 2013
396
397 Fix Windows build, properly RT#84738.
398
399 =head2 Changes in Devel::NYTProf 5.01 - 19th April 2013
400
401 Fix Windows build RT#84738.
402
403 Can't rely on #!-line to always work, PR#3
404 thanks to Gisle Aas.
405
406 Avoid triggering "gcc internal compiler error" PR#4
407 thanks to Gisle Aas.
408
409 =head2 Changes in Devel::NYTProf 5.00 - 8th April 2013
410
411 Added subroutine entry and return event stream,
412 controlled via the calls=N option. Default calls=1.
413
414 Added nytprofcalls command to process the call event stream to
415 generate timings for distinct call stacks (experimental).
416
417 Added Flame Graph visualization SVG using the call stack data.
418
419 Changed blocks=N option to be 0 (disabled) by default.
420
421 Fixed test for perl 5.17+ hash randomization.
422 Fixed nytprofhtml for Windows thanks to Jan Dubois. PR#2
423 Fixed assorted nits thanks to Steve Peters. PR#1
424 Deprecated nytprofcsv - speak up if you use it!
425 No longer warn about $&, $` and $' being slow if $] >= 5.017008.
426
427 =head2 Changes in Devel::NYTProf 4.25 - 6th Feb 2013
428
429 Fix u2time clock (ie Time::HiRes, used by Windows)
430
431 =head2 Changes in Devel::NYTProf 4.24 - 3rd Feb 2013
432
433 Clarify sigexit option docs.
434 Loosen test timing constraints (for slow cpantester VMs).
435
436 =head2 Changes in Devel::NYTProf 4.23 - 31st Dec 2012
437
438 Significant improvement in the accuracy of the subroutine profiler,
439 especially for frequent calls to very short duration subs/ops,
440 and more so for POSIX and OSX systems with sub-microsecond clocks.
441
442 Fixed tests to work with perl 5.17.7+ (PL_sawampersand gone).
443 Fixed some doc typos thanks to Jesse Sheidlower.
444 Improved nytprofmerge behaviour with inconsistent attributes.
445 Removed the usecputime=1 option. Use clock=N instead if possible.
446 Moved main repo to git (and https://github.com/timbunce/devel-nytprof)
447
448 =head2 Changes in Devel::NYTProf 4.12 - 28th Dec 2012
449
450 Fixed the perl v5.17+ fix to do-the-right-thing for 5.17.4.
451 Fixed pod encoding issues.
452
453 =head2 Changes in Devel::NYTProf 4.11 (svn 1442) 26th Dec 2012
454
455 Fixed to work with perl v5.17+, specifically string eval
456 changes and hash randomization.
457 Fixed so tests ignore sitecustomize.pl, RT#79784
458 thanks to [email protected].
459 Fixed to sort tables with microsecond values in non-utf8
460 encodings, RT#77843
461
462 Deprecated the usecputime=1 option and documented that it
463 will be removed in a future version.
464
465 Corrected spelling thanks to Alessandro Ghedini @debian RT#80370
466
467 =head2 Changes in Devel::NYTProf 4.09 (svn 1431) 15th Sep 2012
468
469 Fixed to work for perl v5.17.3+ thanks to David Mitchell.
470
471 =head2 Changes in Devel::NYTProf 4.08 (svn 1427) 11th Aug 2012
472
473 Fixed version numbers in nytprofhtml and nytprofmerge.
474
475 =head2 Changes in Devel::NYTProf 4.07 (svn 1419) 10th Aug 2012
476
477 Fixed html generation to be valid, RT#70207 (H.Merijn Brand).
478 nytprofmerge no longer dies on some errors, RT#75918.
479 nytprofmerge now sums cumulative_overhead_ticks, RT#75909.
480 nytprofmerge now gets in man page installed, RT#75911.
481
482 Enable file=/dev/null to work as fix for RT#74565.
483 Updated ::Apache docs including troubleshooting, RT#75912.
484 Note Devel::NYTProf::Data is undocumented and why, RT#75914.
485 Use Browser::Open if installed for nytprofhtml --open.
486
487 Added and clarified some notes in the troubleshooting docs.
488 Added warning for Apache2::SizeLimit in ::Apache, RT#75912.
489 Clarified docs re fork generating multiple files, RT#78873.
490
491 =head2 Changes in Devel::NYTProf 4.06 (svn r1406) 30th Nov 2010
492
493 Fixed risk of nytprofhtml failure due to over-long filenames RT#62319
494
495 Improved handling of Class::MOP/Moose generated methods.
496 Improved handling of embedded filenames, e.g., "(eval N)[$path]"
497 Updated and clarified usecputime=1 docs.
498 Updated tests for (expected) new functionality in Sub::Name.
499 Updated tests for changes in perl 5.13.x.
500
501 Added special handling for the perl built-in accept()
502 Effectively the clock stops ticking while in accept().
503 This makes profiles of pure-perl web servers more useful.
504 Added --no-mergeevals option to nytprofhtml.
505 Added "If Statement and Subroutine Timings Don't Match" and
506 "If Headline Subroutine Timings Don't Match the Called Subs"
507 sections to the DATA COLLECTION AND INTERPRETATION docs.
508 Added note to the docs re profiling applications that use Coro.
509
510 =head2 Changes in Devel::NYTProf 4.05 (svn 1359) 15th Sept 2010
511
512 Fixed tests to work with a new optimization in perl 5.13.4.
513 Fixed handling of negative values for subroutine line ranges
514 (that may be added to %DB::sub by buggy software).
515 Fixed handling of negative times from unstable clocks
516 that caused spikes in statement times.
517 Fixed risk of bad line numbers hanging report generation.
518
519 =head2 Changes in Devel::NYTProf 4.04 (svn 1332) 9th July 2010
520
521 Profile now reports presence of the slow regex match vars ($& $' $`).
522 The (cumulative inclusive) recursion time measured for subs that are involved
523 in recursion is now reported as 'recursion: ... sum of overlapping time'.
524 Trace log messages are now flushed immediately.
525 Reduced risk of crashes in embedded applications that don't handle PL_endav
526 carefully, like current versions of mod_perl.
527
528 =head2 Changes in Devel::NYTProf 4.03 (svn 1316) 19th June 2010
529
530 Fixed another nytprofhtml performance problem for profiles with
531 many files/evals. Much faster merging of evals now.
532
533 For subs that recurse, show max depth and time in subroutine table.
534
535 =head2 Changes in Devel::NYTProf 4.02 (svn 1309) 17th June 2010
536
537 Fixed nytprofhtml performance problem for profiles with
538 many files/evals.
539
540 Added progress reporting to nytprofhtml.
541
542 =head2 Changes in Devel::NYTProf 4.01 (svn 1296) 10th June 2010
543
544 Fixed links from block/sub level report pages to string eval report
545 pages. RT#58284
546
547 Restored ordering of line - block - sub links on index page.
548
549 Clarified that saving the source code of string evals requires perl
550 version 5.8.9+, 5.10.1+, 5.12 or later. RT#58283
551
552 =head2 Changes in Devel::NYTProf 4.00 (svn 1291) 8th June 2010
553
554 Major changes:
555
556 Added profile reporting of code executed in string evals.
557 Each string eval executed gets it's own report page.
558 You can 'see' the code that was executed, with profile info.
559 String evals may be collapsed/merged in some cases.
560
561 Improved many sub-optimal behaviours related to string evals.
562
563 Subroutine calls that couldn't be associated with a specific line,
564 such as calls made by perl to END blocks, are now shown in reports.
565
566 Subroutine definitions that couldn't be associated with a specific file,
567 such as xsubs in packages with no perl source, are now shown in reports.
568
569 Enabled savesrc=1 by default.
570
571 The data file format has changed so v3.x files can't be read.
572 The Devel::NYTProf::ReadStream interface has also changed.
573
574 Other changes:
575
576 Fixed off-by-1 error in number of Files an xsub/opcode was called from.
577 Fixed Devel::NYTProf::Apache to work in more situations
578 and enable the addpid option by default.
579 Fixed that END blocks defined at runtime are included in the profile
580 thanks to Nicholas Clark.
581
582 Compilation-only checks (perl -c) can be profiled thanks to Nicholas Clark.
583 Improved behaviour for 'duplicate' anon-subs defined in separate
584 invocations of a particular string eval.
585 Multiple BEGINs (e.g., use) on the same line get distinct names.
586
587 Added --minimal option to nytprofhtml to disable generation of
588 graphviz .dot files and block/sub-level statement report files.
589 Added automatic detection of calls to POSIX::_exit() by the sub profiler
590 so finish_profile() gets called and a usable profile is produced.
591 Added posix_exit=1 option to do the same thing (in a different way)
592 when the sub profiler is not being used (i.e., subs=0).
593
594 Documentation Changes:
595
596 Sequences of blank lines are skipped in generated reports.
597 Relevant for savesrc mode in which perl doesn't store pod sections.
598 Corrected typos in nytprofhtml docs thanks to [email protected].
599 Documented how to use Devel::NYTProf::Apache with virtual hosts that
600 use the PerlOptions +Parent or +Clone configuration.
601
602 =head2 Changes in Devel::NYTProf 3.11 (svn 1171) 12th March 2010
603
604 Fixed assorted issues on Windows thanks to Jan Dubois.
605 Fixed assorted issues 64bit systems thanks to Jan Dubois.
606
607 Refactored I/O to create an API that encapsulates the data
608 file format, thanks to Nicholas Clark.
609 Updated and optimized nytprofmerge to use the new API
610 yielding a significant speed boost, thanks to Nicholas Clark.
611
612 =head2 Changes in Devel::NYTProf 3.02 (svn 1094) 5th March 2010
613
614 Fixed handling of usecputime=1 option and updated
615 docs to note the significant limitations.
616 Fixed association of XS subs to source files
617 in some edge cases thanks to Nicholas Clark.
618 Fixed nytprofmerge edge cases thanks to Nicholas Clark.
619
620 Added high-resolution (100ns) timer for Mac OS X
621 many thanks to Markus Peter.
622 Added assorted optimizations thanks to Nicholas Clark.
623
624 Changed subroutine profiler to be slightly more efficient.
625 Changed some tests to be more informative on failure.
626 Changed nytprofhtml to be smarter when source isn't available.
627 Changed nytprofhtml to show sort arrow on sortable tables.
628
629 Removed Devel::NYTProf::PgPLPerl module. That's now a separate
630 PostgreSQL::PLPerl::NYTProf distribution.
631
632 Updated docs to include a note about timing on Windows.
633 Updated docs to include a section about making NYTProf faster.
634
635 =head2 Changes in Devel::NYTProf 3.01 (svn r1005) 28th Dec 2009
636
637 Fixed (removed) use of vfscanf() which broke on Windows.
638 Fixed version number in nytprofmerge.
639
640 Added documentation to nytprofcg and nytprofmerge.
641
642 Updated NYTProf docs, including noting major contributors.
643 Updated docs to fix assorted typos, thanks to Jonathan Yu.
644 Updated nytprofcsv documentation.
645
646 =head2 Changes in Devel::NYTProf 3.00 (svn r998) 24th Dec 2009
647
648 Note: The file format has changed. Old files can't be read.
649
650 Fixed (rare) overflow bug for 32bit perls.
651 Fixed discarding of (rare) negative intervals.
652 Fixed risk of infinite recursion if trace enabled and
653 $SIG{__WARN__} was set to a code reference.
654 Fixed subroutine recursion depth measurement.
655 Fixed missing embedded eval source code for some older perls.
656 Fixed assorted compiler warnings for various configurations.
657
658 Changed ReadStream SUB_LINE_RANGE tag to SUB_INFO.
659
660 Added log=F option to write trace log to a file.
661 Added warning when reading a file with a minor version higher
662 than expected.
663
664 Added slowops=N option which enables profiling of potentially slow
665 perl opcodes (e.g., system calls and regexs). They're treated like xsubs.
666 slowops=0 disables profiling of 'slowops'
667 slowops=1 puts timings into one package ("CORE::", eg CORE::sleep)
668 slowops=2 (the default) puts timings into into the package that made the
669 call, e.g., "Foo::CORE:sleep" (note the single colon).
670
671 Added sigexit=1 option to enable a useable profile when the process
672 exits due to a signals (catches INT HUP PIPE BUS SEGV by default)
673 Can also do sigexit=TRAP,ABRT,SYS,... to hook specific signals.
674 Thanks to Andrew Sterling Hanenkamp for the seed of this idea.
675
676 Added forkdepth=N option to enable profiling to be turned off after N
677 generations of fork().
678
679 Added nameevals=0 and nameanonsubs=0 options to make NYTProf less
680 visible to code that may assume the default perl naming behaviour.
681 Note that using these will limit the usefulness of reports.
682
683 Added initial support for profiling PostgreSQL PL/Perl code
684 via Devel::NYTProf::PgPLPerl module.
685
686 Added nytprofmerge utility:
687 Reads multiple nytprof data files and writes a new merged file.
688 Many thanks to Nicholas Clark!
689
690 Changes to subroutine profiler:
691
692 Rewritten. Captures more data more accurately and robustly.
693 Added profiling of calls to xsubs that exit via an exception.
694 Added profiling of goto &sub;
695 Added recording the name of the calling subroutine to enable proper
696 linking of call trees. Previously only the calling file and line
697 were recorded. (This is more significant than it sounds :)
698 Added docs describing how the subroutine profiler works.
699 Multiple BEGIN blocks (including "use") within a package are now
700 distinguished by appending the number of the line they start on
701 (for perl 5.8.9+ and 5.10.1+)
702
703 Changes to nytprofhtml:
704
705 Added interactive treemap view of package and subroutine times.
706 Left-click to zoom in (drill-down) one level, right-click to zoom out.
707
708 Added generation of GraphViz dot language files to visualize
709 the call graph. A top-level link on the index page provides an
710 inter-package graph, and per-source-file links provide a graph
711 of sub calls in to, out of, and between the subs in the file.
712 See http://en.wikipedia.org/wiki/Graphviz
713
714 Added columns to the main source code reports to show
715 a count of sub calls and time spent in those calls.
716
717 Assorted cosmetic improvements.
718 Changed colors on report pages to be less saturated.
719
720
721 =head2 Changes in Devel::NYTProf 2.10 (svn r774) 18th June 2009
722
723 Fixed call count for XSubs that was one too high.
724 Fixed enable_profile() after fork thanks to delamonpansie
725 http://code.google.com/p/perl-devel-nytprof/issues/detail?id=15
726 Fixed to use correct scripts during test and so avoid permissions
727 issues, thanks to David Golden.
728 Fixed spurious "Unable to determine line number" warnings
729 when using options like -p, -n, -Mfoo.
730
731 Changed enable_profile() to discard the time spent since
732 profile was disabled.
733 Changed NYTPROF env var parsing to allow backslash to escape
734 colons, for Windows, thanks to Joshua ben Jore.
735
736 Added license, homepage, bugtracker, repository and MailingList
737 resources to META.yml thanks to Michael G Schwern.
738 Added nytprofcg utility to generate callgrind data for
739 viewing via Kcachegrind, thanks to Chia-liang Kao.
740
741 =head2 Changes in Devel::NYTProf 2.09 (svn r733) 29th March 2009
742
743 Added support for modules using AutoLoader, e.g., POSIX & Storable,
744 to fix the "Unable to open '... (autosplit into ...)'" warnings.
745 Fixed report filename generation to remove colons,
746 for Windows, reported by Adam Kennedy in rt bug #43798.
747 Fixed report filename generation to remove dots, for VMS.
748 Fixed savesrc option which wasn't safe and reliable.
749 Added missing t/test22-strevala.t to MANIFEST.
750 Extended testing to exercise compress and savesrc options.
751
752 Ported to VMS, thanks to Peter (Stig) Edwards:
753
754 Renamed t/\d\d.test.t files to t/\d\d_test.t
755 t/test*.pm.x files to t/test*.pm_x
756 t/test*fork.\d.* files to t/test*fork-\d.*
757 .js and .css file to only have one period/dot
758 for greater portability. VMS ODS-2 files can only have
759 one period/dot.
760 Added t/92-file_port.t as a developer-only and
761 request-using-ENV test, to help maintain portable files,
762 currently .indent.pro and .perltidyrc fall foul of portable
763 filename characters as defined by ANSI C and perlport.
764 NYTProf.xs's open_output_file use mode 'wb' and not 'wbx'
765 to avoid unsupported error when on VMS.
766
767 =head2 Changes in Devel::NYTProf 2.08 (svn r685) 15th Feb 2009
768
769 Core:
770
771 Added optimize=0 option to disable the perl optimizer
772 so you can see more accurate statement execution counts
773 for some kinds of constructs.
774
775 Added savesrc=1 option to copy source code into the profile
776 so reports are not affected by changes to the source files.
777
778 Added ability for DB::enable_profile() to specify a new file
779 for profile data to be written to.
780
781 Reporting:
782
783 Time spent within nested string evals is accounted for.
784
785 Fixed searching @INC for source files for reports.
786
787 Dramatically increased performance of nytprofhtml
788 relative to the 2.07 version.
789
790 Many tables in html reports are sortable by clicking on header columns
791 (requires JavaScript, uses jQuery and tablesorter.js)
792
793 Statement timings are now shown as integers in appropriate
794 units: seconds, milliseconds, microseconds or nanoseconds.
795
796 Hovering over times in subroutine or file summary tables
797 now shows the percentage time.
798
799 Added tables showing timings rolled up per package name depth.
800
801 Improved HTML conformance thanks to Leland Johnson.
802
803 =head2 Changes in Devel::NYTProf 2.07 (svn r583) 1st Nov 2008
804
805 Core:
806
807 NOTE: The file format has changed. Files from 2.04 and 2.05
808 can still be read by this version.
809
810 Subroutine inclusive time no longer counts time
811 spent recursed into the same subroutine. That time is
812 now recorded separately, along with the max recursion depth.
813
814 Added stmts=0 option to disable the statement profiler
815 so just the subroutine profiler runs. That reduces the
816 profiler overhead and gives you much smaller data files.
817
818 Now builds on Windows, with thanks to Jan Dubois!
819
820 Removed use of vfscanf() to improve portability to Windows
821 and old unix systems, thanks to Jan Dubois.
822
823 The profiler takes more care to avoid changing $!.
824
825 Reports:
826
827 Fixed significant error in time reported as spent in a subroutine,
828 which was showing the sum of the inclusive and exclusive time
829 instead of just the inclusive time.
830
831 Subroutine calls made within string evals are now shown in reports.
832 Subroutine caller details now includes calls from within string evals.
833
834 XS subs (xsubs) are now automatically associated with a source
835 file that defines normal subs in the same package.
836 Callers and timing information for xsubs are now shown at the
837 bottom of the corresponding source file.
838 References to xsubs in reports now include a working link
839 if the xsub is in a package that contains profiled perl code.
840
841 The html global subroutine index pages no longer list subs that
842 were never called.
843
844 Assorted report formating enhancements thanks to Gisle Aas.
845
846 Exclusive and Inclusive time column positions have been switched
847 to be consistent with how the times are presented elsewhere.
848
849 nytprofhtml includes a --open option to open the generated html
850
851 Documentation:
852
853 Greatly expanded description of the clocks used for profiling
854 and their issues, especially on multi-processor systems.
855
856 Other:
857
858 Added Devel::NYTProf::ReadStream module which provides a perl
859 interface for reading the raw profile data, thanks to Gisle Aas.
860
861
862 =head2 Changes in Devel::NYTProf 2.05 (svn r498) 8th Oct 2008
863
864 Fixed alteration of $! during profiling thanks to Slaven Rezic.
865 Fixed clock_gettime() clock selection to fallback to CLOCK_REALTIME
866 if CLOCK_MONOTONIC is not available, e.g, on linux 2.4.
867 Fixed error when application ends after DB::disable_profile().
868
869 Added some docs to Devel::NYTProf::Apache
870 Added clock=N option to enable user to select the clock.
871
872 =head2 Changes in Devel::NYTProf 2.04 (svn r483) 1st Oct 2008
873
874 Fixed rare divide-by-zero error in reporting code.
875 Fixed rare core dump in reporting code.
876 Fixed detection of #line directives to be more picky.
877 Fixed some compiler warnings thanks to Richard Foley.
878
879 Added on-the-fly ~90% zip compression thanks to Nicholas Clark.
880 Reduces data file size per million statements executed
881 from approx ~13MB to ~1MB (depends on code being profiled).
882
883 Added extra table of all subs sorted by inclusive time.
884
885 No longer warns about '/loader/0x800d8c/...' synthetic file
886 names perl assigns reading code from a CODE ref in @INC
887
888 =head2 Changes in Devel::NYTProf 2.03 (svn r405) 15 Aug 2008
889
890 NOTES:
891 1. File format changed. Old profiles can't be read.
892 2. Perl 5.8.1 is the oldest perl version supported.
893
894 Fixed accounting for time spent executing subs that were
895 compiled in string evals.
896 Fixed risk of file corruption by names containing newlines.
897
898 Changed to also profile compile-time activity by default.
899 Improved formating of stats for subs called by a statement.
900
901 Added start=begin|init|end|no option to NYTPROF env var.
902 Added addpid=1 option to NYTPROF env var.
903 Added support for .pmc files.
904 Added detection of #line directives in source code
905 currently just warns that they are not handled.
906
907 Known issues:
908 Perl 5.8.8 can report garbage file names for XS subs.
909 (Perl 5.8.6 and 5.10 don't seem to have this problem.)
910 Where a subroutine is called from code compiled in a string
911 evals, the artificial "eval file names" are not yet merged.
912 (You're unlikely to notice this obscure case anyway.)
913
914 =head2 Changes in Devel::NYTProf 2.02 (svn r361) 24 Jul 2008
915
916 Fixed colors to use the median (not average) deviation from the median value.
917 Fixed sub name resolution to work in more, perhaps all, unusual cases.
918
919 Improved accuracy of subroutine timing by deducting statement measurement overheads.
920 Improved readability of subroutine caller lists.
921 Replaced use of fpurge() with a more portable approach.
922
923 Added exclusive subroutine time (time in sub excluding subs it called).
924 Added recording of xsub filenames (i.e. DBI.c)
925 Added use of clock_gettime(), if available, for 100ns resolution.
926 Uses CLOCK_MONOTONIC or else CLOCK_REALTIME. Thanks to Steve Peters.
927
928 =head2 Changes in Devel::NYTProf 2.01
929
930 Fixed and unified module version numbers.
931
932 =head2 Changes in Devel::NYTProf 2.00
933
934 Major changes. Much extra functionality and performance.
935 See http://blog.timbunce.org/2008/07/15/nytprof-v2-a-major-advance-in-perl-profilers/
936
937 =head2 Changes in and before 1.50
938
939 1.50 ? ? ? 0:00:00 2008
940 - Major revision to include Tim Bunce's call scope statistics features,
941 code/doc refactoring, optimizations and bug fixes.
942 - Fixes major issues with profiling code that forks.
943
944 1.13 Wed Mar 26 9:35:00 2008
945 - Fixed RedHat EL bug - %f isn't the C format for floating-point for RHEL
946 Changed Reader.pm to warn-and-continue instead of dieing when a source
947 file cannot be found. (the file will be skipped). Feature by request.
948 Makefile.PL changes by tim.bunce - fix warning on LICENSE key when
949 installed by older versions of MakeMaker. Added vim modeline.
950
951 1.12 Tue Mar 25 11:05:00 2008
952 - Fixed YET ANOTHER test failure caused by trivial differences between v5.6
953 and v5.8.x. Added test15 that only executes on <5.8 and test06 now only
954 runs on >5.8.0
955
956 1.11 Mon Mar 24 11:26:00 2008
957 - Rewrote test06 and test 13 only. No functionality changes. There is a Perl
958 debugger bug. In perl >5.6 closing "}" in empty loops get execution
959 counts for some reason. This caused 5.6 to fail 'make test'
960 needlessly. (5.6 actually handles it better and 5.8 & 5.10). So I
961 changed the code to avoid empty loop tests, which are no more useful
962 than loops with code in them.
963 *test06 now tests only loops - foreach, while and do-while loops.
964 *test13 now tests only forms of eval, and eval failures - loops removed
965
966 1.10 Web Mar 19 21:02:00 2008
967 - Another CPAN versioning fix. Hopefully the last!!!
968 - Added Makefile.pl check to report unsupported OS on Win32
969
970 0.09 Wed Mar 19 13:05:00 2008
971 - Fixed broken CPAN version numbering
972 - Implemented malloc() fix by Tim Bunce (tim.bunce@gmail.[nospam]com
973 - Wrote a better eval test, now covers all uses ("", perlcode, {...})
974 - Fixed AutoSplit file source problem
975 - Wrote AutoSplit/AutoLoader tests (test14)
976 - Bugs fixed (hopefully) 33889, 34234, 33991, 33878
977
978 0.08 Mon Mar 10 17:35:00 2008
979 - Added #define to fix missing linkage for OutCopFile (Perl <5.8.0 fix)
980 - Added test12, basic do script test
981 - Moved min version to 5.6.0 again (another attempt)
982
983 0.05 Fri Mar 7 10:29:00 2008
984 - Changed XS code to compile clean with -ansi and -pedantic
985 - Removed `cont' on file argument to process due to XS error in Perl 5.6
986 - Added code to Makefile.PL so that header sources are run through the C
987 pre-processor (if available) as a potential fix for some BSD systems.
988
989 0.03 Thu Mar 6 09:12:00 2008
990 - Fixed a VERY tricky bug some people had encountered. Scalar references to
991 code that is evaled at runtime will cause divide-by-zero error IF the
992 reference was declared in a BEGIN {...} and used outside of a BEGIN.
993 (The debugger/profiler can't see what happens in a BEGIN)
994 - Added test case for above issue as test11
995 - Fixed (i hope) the OSX segfault when using a re-malloc'd pointer that was
996 once freed.
997 - Changed XS to compile cleanly with -Wall.
998 - Adopted versioning scheme: modules/files start at 1.0 and the distro will
999 continue from 0.0, thus making mixed versions less confusing.
1000 - Enabled the debugging switch so that NYTProf can be used in the form
1001 perl -MDevel::NYTProf code.pl (BUT this is ALPHA quality -- may bork)
1002 - Minor cleanup to Makefile.PL
1003
1004 0.02 Wed Mar 5 14:20:00 2008
1005 - fixed a bunch of minor problems with the distribution that caused cpan
1006 warnings and also cause the exe scripts to not be installed
1007 - now a working cpan distro
1008
1009 0.01 Tue Feb 12 10:34:03 2008
1010 - original version; created by h2xs 1.23 with options
1011 -A -n Devel::NYTProf
1012
1013 =cut
1014
1015 # vim: ts=8 sw=2 sts=2 expandtab: