This is a live mirror of the Perl 5 development currently hosted at https://github.com/perl/perl5
Update ChangeLog before release
[perl5.git] / dist / Storable / ChangeLog
CommitLineData
289e2b8e
AMS
1Wed Jul 2 16:25:25 IST 2014 Abhijit Menon-Sen <ams@toroid.org>
2 Version 2.51
3
4 * [perl #121928] Fix memory leak for dclone inside freeze hook
5 (Alex Solovey)
6 * Do not call DESTROY for empty objects
7 (Vladimir Timofeev)
8 * Other bugfixes
65206418 9
76b97db5
AMS
10Sat Jul 13 18:34:27 IST 2013 Abhijit Menon-Sen <ams@toroid.org>
11 Version 2.45
12
13 * [perl #118829] Memory leaks in STORABLE_attach
14 (Vladimir Timofeev)
15 * [perl #118139] Don't SEGV during global destruction
16 (Nicholas Clark, report/test from Reini Urban)
17 * Added security warnings section (Steffen Mueller)
18 * Update INSTALLDIRS to favour installation in 'site'
19 (James E Keenan)
664f237a 20
6ac1779f 21Tue 11 Sep 06:51:11 IST 2012 Abhijit Menon-Sen <ams@toroid.org>
7a950fe4 22 Version 2.39
6ac1779f
AMS
23
24 Various bugfixes, including compatibility fixes for older
25 versions of Perl and vstring handling.
26
cefcbacf
AMS
27Sun 3 Jul 09:10:11 IST 2011 Abhijit Menon-Sen <ams@toroid.org>
28 Version 2.29
29
30 Various bugfixes, notably including preventing nfreeze from
31 incorrectly stringifying integers.
32
3139f421
DL
33Fri 3 Dec 14:12:32 GMT 2010 David Leadbeater <dgl@dgl.cx>
34 Version 2.25
35
36 Support for serializing coderefs containing UTF-8.
37
51f77169
AMS
38Fri Nov 12 10:52:19 IST 2010 Abhijit Menon-Sen <ams@toroid.org>
39
40 Version 2.24
41
42 Performance improvement for overloaded classes from Benjamin
43 Holzman.
44
45Fri Nov 12 10:36:22 IST 2010 Abhijit Menon-Sen <ams@toroid.org>
46
47 Version 2.23
48
49 Release the latest version from the Perl repository.
50
70006c44
SH
51Thu Aug 6 10:55:50 IST 2009 Abhijit Menon-Sen <ams@toroid.org>
52
53 Version 2.21
54
55 Includes hints/hpux.pl that was inadvertently left out of 2.20.
56
5c24ba53
AMS
57Mon May 18 09:38:20 IST 2009 Abhijit Menon-Sen <ams@toroid.org>
58
59 Version 2.20
60
61 Fix bug handling blessed references to overloaded objects, plus
62 other miscellaneous fixes.
63
64 (Version 2.19 was released with 5.8.9.)
65
8c68d109
AMS
66Thu Nov 22 13:24:18 IST 2007 Abhijit Menon-Sen <ams@toroid.org>
67
68 Version 2.18
69
70 Compile fixes for older Perls. (No functional changes.)
71
b90d408e
AMS
72Sat Nov 17 02:12:12 IST 2007 Abhijit Menon-Sen <ams@toroid.org>
73
74 Version 2.17
75
76 Various broken tests fixed. (No functional changes.)
77
c268aba5
RGS
78Sat Mar 31 06:11:06 IST 2007 Abhijit Menon-Sen <ams@toroid.org>
79
80 Version 2.16
81
82 1. Fixes to Storable::dclone, read_magic, retrieve_lscalar
83 2. Storable 0.1 compatibility
84 3. Miscellaneous compile/leak/test/portability fixes
85
0bb78401
AMS
86Mon May 23 22:48:49 IST 2005 Abhijit Menon-Sen <ams@wiw.org>
87
88 Version 2.15
89
90 Minor changes to address a couple of compile problems.
91
2f796f32 92Mon Apr 25 07:29:14 IST 2005 Abhijit Menon-Sen <ams@wiw.org>
c3c53033
NC
93
94 Version 2.14
95
96 1. Store weak references
2f796f32 97 2. Add STORABLE_attach hook.
c3c53033 98
fa523c3a
NC
99Thu Jun 17 12:26:43 BST 2004 Nicholas Clark <nick@ccl4.org>
100
101 Version 2.13
102
103 1. Don't change the type of top level overloaded references to RV -
104 they are perfectly correct as PVMG
105 2. Storable needs to cope with incoming frozen data that happens to be
106 utf8 encoded.
107
754c00ca
NC
108Wed Mar 17 15:40:29 GMT 2004 Nicholas Clark <nick@ccl4.org>
109
3f575d8d
NC
110 Version 2.12
111
754c00ca 112 1. Add regression tests for the auto-require of STORABLE_thaw
165cc789 113 2. Add auto-require of modules to restore overloading (and tests)
3f575d8d 114 3. Change to no context (should give speedup with ithreads)
754c00ca 115
dfd91409
NC
116Sat Mar 13 20:11:03 GMT 2004 Nicholas Clark <nick@ccl4.org>
117
118 Version 2.11
119
120 1. Storing restricted hashes in canonical order would SEGV. Fixed.
121 2. It was impossible to retrieve references to PL_sv_no and and
122 PL_sv_undef from STORABLE_thaw hooks.
123 3. restrict.t was failing on 5.8.0, due to 5.8.0's unique
124 implementation of restricted hashes using PL_sv_undef
125 4. These changes allow a space optimisation for restricted hashes.
126
a8b7ef86
AMS
127Sat Jan 24 16:22:32 IST 2004 Abhijit Menon-Sen <ams@wiw.org>
128
129 Version 2.10
130
131 1. Thread safety: Storable::CLONE/init_perlinterp() now create
132 a new Perl context for each new ithread.
133 (From Stas Bekman and Jan Dubois.)
134 2. Fix a tag count mismatch with $Storable::Deparse that caused
135 all back-references after a stored sub to be off-by-N (where
136 N was the number of code references in between).
137 (From Sam Vilain.)
138 3. Prevent CODE references from turning into SCALAR references.
139 (From Slaven Rezic.)
140
dcf2e277
NC
141Sat Jan 3 18:49:18 GMT 2004 Nicholas Clark <nick@ccl4.org>
142
143 Version 2.09
144
145 Fix minor problems with the CPAN release
7224c650 146 1: Make Storable.xs work on 5.8.2 and later (already in the core)
dcf2e277
NC
147 2: Ship the linux hints file
148 3: Ship Test::More for the benefit of Perls pre 5.6.2
7224c650 149 4: Correct Makefile.PL to only install in core for 5.8.0 and later
dcf2e277 150
fcaa57e7
AMS
151Sat Sep 6 01:08:20 IST 2003 Abhijit Menon-Sen <ams@wiw.org>
152
153 Version 2.08
154
155 This release works around a 5.8.0 bug which caused hashes to not
156 be marked as having key flags even though an HEK had HEK_WASUTF8
157 set. (Note that the only reasonable solution is to silently drop
158 the flag from the affected key.)
159
160 Users of RT 3 who were seeing assertion failures should upgrade.
161 (Perl 5.8.1 will have the bug fixed.)
162
a5271820
AMS
163Mon May 5 10:24:16 IST 2003 Abhijit Menon-Sen <ams@wiw.org>
164
165 Version 2.07
166
167 Minor bugfixes (self-tied objects are now correctly stored, as
168 are the results of additions larger than INT_MAX).
169
a2307be4
NC
170Mon Oct 7 21:56:38 BST 2002 Nicholas Clark <nick@ccl4.org>
171
172 Version 2.06
173
174 Remove qr// from t/downgrade.t so that it will run on 5.004
175 Mention $File::Spec::VERSION a second time in t/forgive.t so that it
176 runs without warnings in 5.004 (this may be a 5.00405 bug I'm working
177 round)
178 Fix t/integer.t initialisation to actually generate 64 bits of 9c
179 Fix comparison tests to use eval to get around 64 bit IV conversion
180 issues on 5.6.x, following my t/integer.t ^ precedence bug found by
181 Rafael Garcia-Suarez
182 Alter t/malice.t to work with Test/More.pm in t/, and skip individual
183 subtests that use $Config{ptrsize}, so that the rest of the test can
184 now be run with 5.004
185 Change t/malice.t and the error message in check_magic in Storable.xs
186 from "Pointer integer size" to "Pointer size"
187 Remove prerequisite of Test::More from Makefile.PL
188 Ship Test::Builder, Test::Simple and Test::More in t
189
9cfdba97
AMS
190Thu Oct 3 08:57:22 IST 2002 Abhijit Menon-Sen <ams@wiw.org>
191
192 Version 2.05
193
194 Adds support for CODE references from Slaven Rezic
195 <slaven.rezic@berlin.de>.
196
17374ab3
NC
197Fri Jun 7 23:55:41 BST 2002 Nicholas Clark
198
199 Version 2.04
200
201 Bug fix from Radu Greab <radu@netsoft.ro> (plus regression test)
202 to fix a recently introduced bug detected by Dave Rolsky.
203 Bug was that for a non threaded build, the class information was
204 being lost at freeze time on the first object with a STORABLE_freeze
205 hook. Consequentially the object was not blessed at all when thawed.
206 (The presence (or lack) of STORABLE_thaw was irrelevant; this was
207 a store-time data lost bug, caused by failure to initialize internal
208 context)
209 The bug was introduced as development perl change 16442 (on
210 2002/05/07), so has been present since 2.00.
211 Patches to introduce more regression tests to reduce the chance of
c4a6f826 212 a reoccurence of this sort of goof are always welcome.
17374ab3 213
ee0f7aac
NC
214Thu May 30 20:31:08 BST 2002 Nicholas Clark <nick@ccl4.org>
215
8932d55c
AMS
216 Version 2.03 Header changes on 5.6.x on Unix where IV is long long
217
218 5.6.x introduced the ability to have IVs as long long. However,
219 Configure still defined BYTEORDER based on the size of a long.
220 Storable uses the BYTEORDER value as part of the header, but
c4a6f826 221 doesn't explicitly store sizeof(IV) anywhere in the header.
8932d55c
AMS
222 Hence on 5.6.x built with IV as long long on a platform that
223 uses Configure (ie most things except VMS and Windows) headers
224 are identical for the different IV sizes, despite the files
225 containing some fields based on sizeof(IV)
226
227 5.8.0 is consistent; all platforms have BYTEORDER in config.h
228 based on sizeof(IV) rather than sizeof(long). This means that
229 the value of BYTEORDER will change from (say) 4321 to 87654321
230 between 5.6.1 and 5.8.0 built with the same options to Configure
231 on the same machine. This means that the Storable header will
232 differ, and the two versions will wrongly thing that they are
233 incompatible.
234
235 For the benefit of long term consistency, Storable now
236 implements the 5.8.0 BYTEORDER policy on 5.6.x. This means that
237 2.03 onwards default to be incompatible with 2.02 and earlier
238 (ie the large 1.0.x installed base) on the same 5.6.x perl.
239
240 To allow interworking, a new variable
241 $Storable::interwork_56_64bit is introduced. It defaults to
242 false. Set it to true to read and write old format files. Don't
243 use it unless you have existing stored data written with 5.6.x
244 that you couldn't otherwise read, or you need to interwork with
245 a machine running older Storable on a 5.6.x with long long IVs
246 (i.e., you probably don't need to use it).
247
2aeb6432
NC
248Sat May 25 22:38:39 BST 2002 Nicholas Clark <nick@ccl4.org>
249
25f64a11
AMS
250 Version 2.02
251
252 Rewrite Storable.xs so that the file header structure for write_magic
253 is built at compile time, and check_magic attempts to the header in
254 blocks rather than byte per byte. These changes make the compiled
255 extension 2.25% smaller, but are not significant enough to give a
256 noticeable speed up.
2aeb6432 257
db670f21
NC
258Thu May 23 22:50:41 BST 2002 Nicholas Clark <nick@ccl4.org>
259
25f64a11
AMS
260 Version 2.01
261
262 - New regression tests integer.t
263 - Add code to safely store large unsigned integers.
264 - Change code not to attempt to store large integers (ie > 32 bits)
265 in network order as 32 bits.
266
267 *Never* underestimate the value of a pathological test suite carefully
268 crafted with maximum malice before writing a line of real code. It
269 prevents crafty bugs from stowing away in your released code.
270 It's much less embarrassing to find them before you ship.
271 (Well, never underestimate it if you ever want to work for me)
272
8989364b
NC
273Fri May 17 22:48:59 BST 2002 Nicholas Clark <nick@ccl4.org>
274
25f64a11
AMS
275 Version 2.0, binary format 2.5 (but writes format 2.4 on pre 5.7.3)
276
277 The perl5 porters have decided to make sure that Storable still
278 builds on pre-5.8 perls, and make the 5.8 version available on CPAN.
279 The VERSION is now 2.0, and it passes all tests on 5.005_03, 5.6.1
280 and 5.6.1 with threads. On 5.6.0 t/downgrade.t fails tests 34 and 37,
281 due to a bug in 5.6.0 - upgrade to 5.6.1.
282
283 Jarkko and I have collated the list of changes the perl5 porters have
284 from the perl5 Changes file:
285
286 - data features of upcoming perl 5.8.0 are supported: Unicode hash
287 keys (Unicode hash values have been supported since Storable 1.0.1)
288 and "restricted hashes" (readonly hashes and hash entries)
289 - a newer version of perl can now be used to serialize data which is
290 not supported in earlier perls: Storable will attempt to do the
291 right thing for as long as possible, croaking only when safe data
292 conversion simply isn't possible. Alternatively earlier perls can
293 opt to have a lossy downgrade data instead of croaking
294 - when built with perls pre 5.7.3 this Storable writes out files
295 with binary format 2.4, the same format as Storable 1.0.8 onwards.
296 This should mean that this Storable will inter-operate seamlessly
297 with any Storable 1.0.8 or newer on perls pre 5.7.3
298 - dclone() now works with empty string scalar objects
299 - retrieving of large hashes is now more efficient
300 - more routines autosplit out of the main module, so Storable should
301 load slightly more quickly
302 - better documentation
303 - the internal context objects are now freed explicitly, rather than
304 relying on thread or process exit
305 - bugs fixed in debugging trace code affecting builds made with 64 bit
306 IVs
307 - code tidy-ups to allow clean compiles with more warning options
308 turned on avoid problems with $@ getting corrupted on 5.005_03 if
309 Carp wasn't already loaded
310 - added &show_file_magic, so you can add to /etc/magic and teach
311 Unix's file command about Storable files
312
313 We plan to keep Storable on CPAN in sync with the Perl core, so
314 if you encounter bugs or other problems building or using Storable,
315 please let us know at perl5-porters@perl.org
316 Patches welcome!
317
596596d5
JH
318Sat Dec 1 14:37:54 MET 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
319
25f64a11
AMS
320 This is the LAST maintenance release of the Storable module.
321 Indeed, Storable is now part of perl 5.8, and will be maintained
322 as part of Perl. The CPAN module will remain available there
323 for people running pre-5.8 perls.
596596d5 324
25f64a11
AMS
325 Avoid requiring Fcntl upfront, useful to embedded runtimes.
326 Use an eval {} for testing, instead of making Storable.pm
327 simply fail its compilation in the BEGIN block.
596596d5 328
25f64a11 329 store_fd() will now correctly autoflush file if needed.
596596d5 330
6e0ac6f5
JH
331Tue Aug 28 23:53:20 MEST 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
332
25f64a11
AMS
333 Fixed truncation race with lock_retrieve() in lock_store().
334 The file has to be truncated only once the exclusive lock is held.
6e0ac6f5 335
25f64a11 336 Removed spurious debugging messages in .xs file.
6e0ac6f5 337
e993d95c
JH
338Sun Jul 1 13:27:32 MEST 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
339
25f64a11
AMS
340 Systematically use "=over 4" for POD linters.
341 Apparently, POD linters are much stricter than would
342 otherwise be needed, but that's OK.
e993d95c 343
25f64a11
AMS
344 Fixed memory corruption on croaks during thaw(). Thanks
345 to Claudio Garcia for reproducing this bug and providing the
346 code to exercise it. Added test cases for this bug, adapted
347 from Claudio's code.
e993d95c 348
25f64a11 349 Made code compile cleanly with -Wall (from Jarkko Hietaniemi).
e993d95c 350
25f64a11
AMS
351 Changed tagnum and classnum from I32 to IV in context. Also
352 from Jarkko.
e993d95c 353
8be2b38b
JH
354Thu Mar 15 01:22:32 MET 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
355
25f64a11
AMS
356 Last version was wrongly compiling with assertions on, due
357 to an edit glitch. That did not cause any problem (apart from
358 a slight performance loss) excepted on Win* platforms, where the
359 assertion code does not compile.
8be2b38b
JH
360
361Sat Feb 17 13:37:37 MET 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
362
25f64a11 363 Version 1.0.10.
8be2b38b 364
25f64a11
AMS
365 Forgot to increase version number at previous patch (there were
366 two of them, which is why we jump from 1.0.8 to 1.0.10).
8be2b38b 367
b12202d0
JH
368Sat Feb 17 13:35:00 MET 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
369
25f64a11 370 Version 1.0.8, binary format 2.4.
b12202d0 371
25f64a11 372 Fixed incorrect error message.
b12202d0 373
25f64a11
AMS
374 Now bless objects ASAP at retrieve time, which is meant to fix
375 two bugs:
b12202d0 376
25f64a11
AMS
377 * Indirect references to overloaded object were not able to
378 restore overloading if the object was not blessed yet,
379 which was possible since blessing occurred only after the
380 recursive retrieval.
b12202d0 381
25f64a11
AMS
382 * Storable hooks asking for serialization of blessed ref could
383 get un-blessed refs at retrieval time, for the very same
384 reason.
b12202d0 385
25f64a11 386 The fix implemented here was suggested by Nick Ing-Simmons.
b12202d0 387
25f64a11
AMS
388 Added support for blessed ref to tied structures. This is the
389 cause for the binary format change.
b12202d0 390
25f64a11
AMS
391 Added EBCDIC version of the compatibility test with 0.6.11,
392 from Peter Prymmer
b12202d0 393
25f64a11
AMS
394 Added tests for the new features, and to make sure the bugs they
395 are meant to fix are indeed fixed.
b12202d0 396
862382c7
JH
397Wed Jan 3 10:43:18 MET 2001 Raphael Manfredi <Raphael_Manfredi@pobox.com>
398
25f64a11 399 Removed spurious 'clean' entry in Makefile.PL.
862382c7 400
25f64a11
AMS
401 Added CAN_FLOCK to determine whether we can flock() or not,
402 by inspecting Perl's configuration parameters, as determined
403 by Configure.
862382c7 404
25f64a11
AMS
405 Trace offending package when overloading cannot be restored
406 on a scalar.
862382c7 407
25f64a11
AMS
408 Made context cleanup safer to avoid dup freeing, mostly in the
409 presence of repeated exceptions during store/retrieve (which can
410 cause memory leaks anyway, so it's just additional safety, not a
411 definite fix).
862382c7 412
90826881
JH
413Sun Nov 5 18:23:48 MET 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
414
25f64a11 415 Version 1.0.6.
90826881 416
25f64a11
AMS
417 Fixed severe "object lost" bug for STORABLE_freeze returns,
418 when refs to lexicals, taken within the hook, were to be
419 serialized by Storable. Enhanced the t/recurse.t test to
420 stress hook a little more with refs to lexicals.
90826881 421
212e9bde
JH
422Thu Oct 26 19:14:38 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
423
25f64a11 424 Version 1.0.5.
212e9bde 425
25f64a11
AMS
426 Documented that store() and retrieve() can return undef.
427 That is, the error reporting is not always made via exceptions,
428 as the paragraph on error reporting was implying.
212e9bde 429
25f64a11
AMS
430 Auto requires module of blessed ref when STORABLE_thaw misses.
431 When the Storable engine looks for the STORABLE_thaw hook and
432 does not find it, it now tries to require the package into which
433 the blessed reference is.
212e9bde 434
25f64a11
AMS
435 Just check $^O, in t/lock.t: there's no need to pull the whole
436 Config module for that.
212e9bde 437
8be2b38b
JH
438Mon Oct 23 20:03:49 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
439
25f64a11 440 Version 1.0.4.
8be2b38b 441
25f64a11
AMS
442 Protected calls to flock() for DOS platform: apparently, the
443 flock/fcnlt emulation is reported to be broken on that
444 platform.
8be2b38b 445
25f64a11
AMS
446 Added logcarp emulation if they don't have Log::Agent, since
447 we now use it to carp when lock_store/lock_retrieve is used
448 on DOS.
8be2b38b 449
dd19458b
JH
450Fri Sep 29 21:52:29 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
451
25f64a11 452 Version 1.0.3.
dd19458b 453
25f64a11
AMS
454 Avoid using "tainted" and "dirty" since Perl remaps them via
455 cpp (i.e. #define). This is deeply harmful when threading
456 is enabled. This concerned both the context structure and
457 local variable and argument names. Brrr..., scary!
dd19458b
JH
458
459Thu Sep 28 23:46:39 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
460
25f64a11 461 Version 1.0.2.
dd19458b 462
25f64a11 463 Fixed spelling in README.
dd19458b 464
25f64a11
AMS
465 Added lock_store, lock_nstore, and lock_retrieve (advisory locking)
466 after a proposal from Erik Haugan <erik@solbors.no>.
dd19458b 467
25f64a11 468 Perls before 5.004_04 lack newSVpvn, added remapping in XS.
dd19458b 469
25f64a11 470 Fixed stupid typo in the t/utf8.t test.
dd19458b
JH
471
472Sun Sep 17 18:51:10 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
473
25f64a11 474 Version 1.0.1, binary format 2.3.
dd19458b 475
25f64a11 476 Documented that doubles are stored stringified by nstore().
dd19458b 477
25f64a11
AMS
478 Added Salvador Ortiz Garcia in CREDITS section, He identified
479 a bug in the store hooks and proposed the right fix: the class
480 id was allocated too soon. His bug case was also added to
481 the regression test suite.
dd19458b 482
25f64a11
AMS
483 Now only taint retrieved data when source was tainted. A bug
484 discovered by Marc Lehmann.
dd19458b 485
25f64a11
AMS
486 Added support for UTF-8 strings, a contribution of Marc Lehmann.
487 This is normally only activated in post-5.6 perls.
dd19458b 488
9e21b3d0
JH
489Thu Aug 31 23:06:06 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
490
25f64a11
AMS
491 First official release Storable 1.0, for inclusion in perl 5.7.0.
492 The license scheme is now compatible with Perl's.
9e21b3d0 493
f0ffaed8
JH
494Thu Aug 24 01:02:02 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
495
25f64a11
AMS
496 ANSI-fied most of the code, preparing for Perl core integration.
497 The next version of Storable will be 0.8, and will be integrated
498 into the Perl core (development branch).
f0ffaed8 499
25f64a11
AMS
500 Dispatch tables were moved upfront to relieve some compilers,
501 especially on AIX and Windows platforms.
f0ffaed8 502
25f64a11 503 Merged 64-bit fixes from perl5-porters.
f0ffaed8 504
7a6a85bf
RG
505Mon Aug 14 09:22:04 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
506
25f64a11
AMS
507 Added a refcnt dec in retrieve_tied_key(): sv_magic() increases
508 the refcnt on the mg_ptr as well.
7a6a85bf 509
25f64a11
AMS
510 Removed spurious dependency to Devel::Peek, which was used for
511 testing only in t/tied_items.t. Thanks to Conrad Heiney
512 <conrad@fringehead.org> for spotting it first.
7a6a85bf
RG
513
514Sun Aug 13 22:12:59 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
515
25f64a11
AMS
516 Marc Lehmann kindly contributed code to add overloading support
517 and to handle references to tied variables.
7a6a85bf 518
25f64a11
AMS
519 Rewrote leading blurb about compatibility to make it clearer what
520 "backward compatibility" is about: when I say 0.7 is backward
521 compatible with 0.6, it means the revision 0.7 can read files
522 produced by 0.6.
7a6a85bf 523
25f64a11 524 Mention new Clone(3) extension in SEE ALSO.
7a6a85bf 525
25f64a11
AMS
526 Was wrongly optimizing for "undef" values in hashes by not
527 fully recursing: as a result, tied "undef" values were incorrectly
528 serialized.
7a6a85bf
RG
529
530Sun Jul 30 12:59:17 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
531
25f64a11 532 First revision of Storable 0.7.
7a6a85bf 533
25f64a11
AMS
534 The serializing format is new, known as version 2.0. It is fully
535 backward compatible with 0.6. Earlier formats are deprecated and
536 have not even been tested: next version will drop pre-0.6 format.
7a6a85bf 537
25f64a11 538 Changes since 0.6@11:
7a6a85bf 539
25f64a11
AMS
540 - Moved interface to the "beta" status. Some tiny parts are still
541 subject to change, but nothing important enough to warrant an "alpha"
542 status any longer.
7a6a85bf 543
25f64a11
AMS
544 - Slightly reduced the size of the Storable image by factorizing
545 object class names and removing final object storage notification due
546 to a redesign of the blessed object storing.
7a6a85bf 547
25f64a11
AMS
548 - Classes can now redefine how they wish their instances to be serialized
549 and/or deep cloned. Serializing hooks are written in Perl code.
7a6a85bf 550
25f64a11 551 - The engine is now fully re-entrant.
7a6a85bf
RG
552
553Sun Apr 2 23:47:50 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
554
25f64a11
AMS
555 Added provision to detect more recent binary formats, since
556 the new upcoming Storable-0.7 will use a different format.
557 In order to prevent attempting the de-serialization of newer
558 formats by older versions, I'm adding this now to the 0.6 series.
7a6a85bf 559
25f64a11
AMS
560 I'm expecting this revision to be the last of the 0.6 series.
561 Unless it does not work with perl 5.6, which I don't use yet,
562 and therefore against which I cannot test.
7a6a85bf
RG
563
564Wed Mar 29 19:55:21 MEST 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
565
25f64a11
AMS
566 Added note about format incompatibilities with old versions
567 (i.e. pre 0.5@9 formats, which cannot be understood as there
568 was no versionning information in the file by then).
7a6a85bf 569
25f64a11
AMS
570 Protect all $@ variables when eval {} used, to avoid corrupting
571 it when store/retrieve is called within an exception handler.
7a6a85bf 572
25f64a11
AMS
573 Mistakenly included "patchlevel.h" instead of <patchlevel.h>,
574 preventing Perl's patchlevel from being included, which is
575 needed starting from 5.6.
7a6a85bf
RG
576
577Tue May 12 09:15:15 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
578
25f64a11
AMS
579 Fixed shared "undef" bug in hashes, which did not remain shared
580 through store/retrieve.
7a6a85bf
RG
581
582Thu Feb 10 19:48:16 MET 2000 Raphael Manfredi <Raphael_Manfredi@pobox.com>
583
25f64a11
AMS
584 added last_op_in_netorder() predicate
585 documented last_op_in_netorder()
586 added tests for the new last_op_in_netorder() predicate
7a6a85bf
RG
587
588Wed Oct 20 19:07:36 MEST 1999 Raphael Manfredi <Raphael_Manfredi@pobox.com>
589
25f64a11 590 Forgot to update VERSION
7a6a85bf
RG
591
592Tue Oct 19 21:25:02 MEST 1999 Raphael Manfredi <Raphael_Manfredi@pobox.com>
593
25f64a11 594 Added mention of japanese translation for the manual page.
7a6a85bf 595
25f64a11
AMS
596 Fixed typo in macro that made threaded code not compilable,
597 especially on Win32 platforms.
7a6a85bf 598
25f64a11
AMS
599 Changed detection of older perls (pre-5.005) by testing PATCHLEVEL
600 directly instead of relying on internal symbols.
7a6a85bf
RG
601
602Tue Sep 14 22:13:28 MEST 1999 Raphael Manfredi <Raphael_Manfredi@pobox.com>
603
25f64a11
AMS
604 Integrated "thread-safe" patch from Murray Nesbitt.
605 Note that this may not be very efficient for threaded code,
606 see comment in the code.
7a6a85bf 607
25f64a11
AMS
608 Try to avoid compilation warning on 64-bit CPUs. Can't test it,
609 since I don't have access to such machines.
7a6a85bf
RG
610
611Mon Jul 12 14:37:19 METDST 1999 Raphael Manfredi <Raphael_Manfredi@pobox.com>
612
25f64a11 613 changed my e-mail to pobox.
7a6a85bf 614
c4a6f826 615 mentioned it is not thread-safe.
7a6a85bf 616
25f64a11 617 updated version number.
7a6a85bf 618
25f64a11 619 uses new internal PL_* naming convention.
7a6a85bf
RG
620
621Fri Jul 3 13:38:16 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
622
25f64a11
AMS
623 Updated benchmark figures due to recent optimizations done in
624 store(): tagnums are now stored as-is in the hash table, so
625 no surrounding SV is created. And the "shared keys" mode for
626 hash table was turned off.
7a6a85bf 627
25f64a11
AMS
628 Fixed backward compatibility (wrt 0.5@9) for retrieval of
629 blessed refs. That old version did something wrong, but the
630 bugfix prevented correct retrieval of the old format.
7a6a85bf
RG
631
632Mon Jun 22 11:00:48 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
633
25f64a11 634 Changed benchmark figures.
7a6a85bf 635
25f64a11
AMS
636 Adjust refcnt of tied objects after calling sv_magic() to avoid
637 memory leaks. Contributed by Jeff Gresham.
7a6a85bf
RG
638
639Fri Jun 12 11:50:04 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
640
25f64a11
AMS
641 Added workaround for persistent LVALUE-ness in perl5.004. All
642 scalars tagged as being an lvalue are handled as if they were
643 not an lvalue at all. Added test for that LVALUE bug workaround.
7a6a85bf 644
c4a6f826
PAR
645 Now handles Perl immortal scalars explicitly, by storing &sv_yes
646 as such, explicitly.
7a6a85bf 647
25f64a11
AMS
648 Retrieval of non-immortal undef cannot be shared. Previous
649 version was over-optimizing by not creating a separate SV for
650 all undefined scalars seen.
7a6a85bf
RG
651
652Thu Jun 4 17:21:51 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
653
25f64a11 654 Baseline for Storable-0.6@0.
7a6a85bf 655
25f64a11
AMS
656 This version introduces a binary incompatibility in the generated
657 binary image, which is more compact than older ones by approximatively
658 15%, depending on the exact degree of sharing in your structures.
7a6a85bf 659
25f64a11
AMS
660 The good news is that your older images can still be retrieved with
661 this version, i.e. backward compatibility is preserved. This version
662 of Storable can only generate new binaries however.
7a6a85bf 663
25f64a11
AMS
664 Another good news is that the retrieval of data structure is
665 significantly quicker than before, because a Perl array is used
666 instead of a hash table to keep track of retrieved objects, and
667 also because the image being smaller, less I/O function calls are
668 made.
7a6a85bf
RG
669
670Tue May 12 09:15:15 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
671
25f64a11 672 Version number now got from Storable.pm directly.
7a6a85bf 673
25f64a11
AMS
674 Fixed overzealous sv_type() optimization, which would make
675 Storable fail when faced with an "upgraded" SV to the PVIV
676 or PVNV kind containing a reference.
7a6a85bf
RG
677
678Thu Apr 30 15:11:30 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
679
25f64a11
AMS
680 Extended the SYNOPSIS section to give quick overview of the
681 routines and their signature.
7a6a85bf 682
25f64a11
AMS
683 Optimized sv_type() to avoid flags checking when not needed, i.e.
684 when their type makes it impossible for them to be refs or tied.
685 This slightly increases throughput by a few percents when refs
686 and tied variables are marginal occurrences in your data.
7a6a85bf 687
25f64a11
AMS
688 Stubs for XS now use OutputStream and InputStream file types to
689 make it work when the given file is actually a socket. Perl
690 makes a distinction for sockets in its internal I/O structures
691 by having both a read and a write structure, whereas plain files
692 share the same one.
7a6a85bf
RG
693
694Tue Jun 3 09:41:33 METDST 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
695
25f64a11
AMS
696 Thanks to a contribution from Benjamin A. Holzman, Storable is now
697 able to correctly serialize tied SVs, i.e. tied arrays, hashes
698 and scalars.
7a6a85bf
RG
699
700Thu Apr 9 18:07:51 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
701
25f64a11 702 I said SvPOK() had changed to SvPOKp(), but that was a lie...
7a6a85bf
RG
703
704Wed Apr 8 13:14:29 METDST 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
705
25f64a11
AMS
706 Wrote sizeof(SV *) instead of sizeof(I32) when portable, which
707 in effect mangled the object tags and prevented portability
c4a6f826 708 across 32/64 bit architectures!
7a6a85bf
RG
709
710Wed Mar 25 14:57:02 MET 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
711
25f64a11
AMS
712 Added code example for store_fd() and retrieve_fd() in the
713 man page, to emphasize that file descriptors must be passed as
714 globs, not as plain strings.
7a6a85bf 715
25f64a11
AMS
716 Cannot use SV addresses as tag when using nstore() on LP64. This
717 was the cause of problems when creating a storable image on an
718 LP64 machine and retrieving it on an ILP32 system, which is
719 exactly what nstore() is meant for...
7a6a85bf 720
25f64a11 721 However, we continue to use SV addresses as tags for plain store(),
c4a6f826 722 because benchmarking shows that it saves up to 8% of the store
25f64a11
AMS
723 time, and store() is meant to be fast at the expense of lack
724 of portability.
7a6a85bf 725
25f64a11
AMS
726 This means there will be approximately an 8% degradation of
727 performance for nstore(), but it's now working as expected.
728 That cost may vary on your machine of course, since it is
729 solely caused by the memory allocation overhead used to create
730 unique SV tags for each distinct stored SV.
7a6a85bf
RG
731
732Tue Jan 20 09:21:53 MET 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
733
25f64a11 734 Don't use any '_' in version number.
7a6a85bf
RG
735
736Tue Jan 13 17:51:50 MET 1998 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
737
25f64a11 738 Updated version number.
7a6a85bf 739
25f64a11 740 added binmode() calls for systems where it matters.
7a6a85bf 741
25f64a11
AMS
742 Be sure to pass globs, not plain file strings, to C routines,
743 so that Storable can be used under the Perl debugger.
7a6a85bf
RG
744
745Wed Nov 5 10:53:22 MET 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
746
25f64a11 747 Fix memory leaks on seen hash table and returned SV refs.
7a6a85bf 748
25f64a11 749 Storable did not work properly when tainting enabled.
7a6a85bf 750
25f64a11
AMS
751 Fixed "Allocation too large" messages in freeze/thaw and added.
752 proper regression test in t/freeze.t.
7a6a85bf
RG
753
754Tue Jun 3 09:41:33 METDST 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
755
25f64a11 756 Updated version number
7a6a85bf 757
25f64a11 758 Added freeze/thaw interface and dclone.
7a6a85bf
RG
759
760Fri May 16 10:45:47 METDST 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
761
25f64a11
AMS
762 Forgot that AutoLoader does not export its own AUTOLOAD.
763 I could use
7a6a85bf 764
25f64a11
AMS
765 use AutoLoader 'AUTOLOAD';
766
767 but that would not be backward compatible. So the export is
768 done by hand...
7a6a85bf
RG
769
770Tue Mar 25 11:21:32 MET 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
771
25f64a11 772 Empty scalar strings are now "defined" at retrieval time.
7a6a85bf 773
25f64a11 774 New test to ensure an empty string is defined when retrieved.
7a6a85bf
RG
775
776Thu Feb 27 16:32:44 MET 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
777
25f64a11 778 Updated version number
7a6a85bf 779
25f64a11 780 Declare VERSION as being used
7a6a85bf 781
25f64a11
AMS
782 Fixed a typo in the PerlIO_putc remapping.
783 PerlIO_read and perlIO_write inverted size/nb_items.
784 (only relevant for pre-perl5.004 versions)
7a6a85bf
RG
785
786Thu Feb 27 15:58:31 MET 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
787
25f64a11 788 Updated version number
7a6a85bf 789
25f64a11 790 Added VERSION identification
7a6a85bf 791
25f64a11 792 Allow build with perl5.003, which is ante perlIO time
7a6a85bf
RG
793
794Mon Jan 13 17:53:18 MET 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
795
25f64a11 796 Random code fixes.
7a6a85bf
RG
797
798Wed Jan 22 15:19:56 MET 1997 Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
799
25f64a11 800 Updated version number in Makefile.PL.
7a6a85bf 801
25f64a11 802 Added "thanks to" section to README.
7a6a85bf 803
25f64a11 804 Documented new forgive_me variable.
7a6a85bf 805
25f64a11 806 Made 64-bit clean.
7a6a85bf 807
25f64a11
AMS
808 Added forgive_me support to allow store() of data structures
809 containing non-storable items like CODE refs.