Upgrade to Storable 1.0.5, from Raphael Manfredi.
[p5sagit/p5-mst-13.2.git] / ext / Storable / ChangeLog
1 Thu Oct 26 19:14:38 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
2
3 . Description:
4
5         Version 1.0.5.
6
7         Documented that store() and retrieve() can return undef.
8         That is, the error reporting is not always made via exceptions,
9         as the paragraph on error reporting was implying.
10
11         Auto requires module of blessed ref when STORABLE_thaw misses.
12         When the Storable engine looks for the STORABLE_thaw hook and
13         does not find it, it now tries to require the package into which
14         the blessed reference is.
15
16         Just check $^O, in t/lock.t: there's no need to pull the whole
17         Config module for that.
18
19 Fri Sep 29 21:52:29 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
20
21 . Description:
22
23         Version 1.0.3.
24
25         Avoid using "tainted" and "dirty" since Perl remaps them via
26         cpp (i.e. #define).  This is deeply harmful when threading
27         is enabled.  This concerned both the context structure and
28         local variable and argument names.  Brrr..., scary!
29
30 Thu Sep 28 23:46:39 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
31
32 . Description:
33
34         Version 1.0.2.
35
36         Fixed spelling in README.
37
38         Added lock_store, lock_nstore, and lock_retrieve (advisory locking)
39         after a proposal from Erik Haugan <erik@solbors.no>.
40
41         Perls before 5.004_04 lack newSVpvn, added remapping in XS.
42
43         Fixed stupid typo in the t/utf8.t test.
44
45 Sun Sep 17 18:51:10 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
46
47 . Description:
48
49         Version 1.0.1, binary format 2.3.
50
51         Documented that doubles are stored stringified by nstore().
52
53         Added Salvador Ortiz Garcia in CREDITS section,  He identified
54         a bug in the store hooks and proposed the right fix: the class
55         id was allocated too soon.  His bug case was also added to
56         the regression test suite.
57
58         Now only taint retrieved data when source was tainted.  A bug
59         discovered by Marc Lehmann.
60
61         Added support for UTF-8 strings, a contribution of Marc Lehmann.
62         This is normally only activated in post-5.6 perls.
63
64 Thu Aug 31 23:06:06 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
65
66         First official release Storable 1.0, for inclusion in perl 5.7.0.
67         The license scheme is now compatible with Perl's.
68
69 Thu Aug 24 01:02:02 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
70
71 . Description:
72
73
74         ANSI-fied most of the code, preparing for Perl core integration.
75         The next version of Storable will be 0.8, and will be integrated
76         into the Perl core (development branch).
77
78         Dispatch tables were moved upfront to relieve some compilers,
79         especially on AIX and Windows platforms.
80
81         Merged 64-bit fixes from perl5-porters.
82
83 Mon Aug 14 09:22:04 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
84
85 . Description:
86
87         Added a refcnt dec in retrieve_tied_key(): sv_magic() increases
88         the refcnt on the mg_ptr as well.
89
90         Removed spurious dependency to Devel::Peek, which was used for
91         testing only in t/tied_items.t.  Thanks to Conrad Heiney
92         <conrad@fringehead.org> for spotting it first.
93
94 Sun Aug 13 22:12:59 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
95
96 . Description:
97
98         Marc Lehmann kindly contributed code to add overloading support
99         and to handle references to tied variables.
100
101         Rewrote leading blurb about compatibility to make it clearer what
102         "backward compatibility" is about: when I say 0.7 is backward
103         compatible with 0.6, it means the revision 0.7 can read files
104         produced by 0.6.
105
106         Mention new Clone(3) extension in SEE ALSO.
107
108         Was wrongly optimizing for "undef" values in hashes by not
109         fully recursing: as a result, tied "undef" values were incorrectly
110         serialized.
111
112 Sun Jul 30 12:59:17 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
113
114         First revision of Storable 0.7.
115
116         The serializing format is new, known as version 2.0.  It is fully
117         backward compatible with 0.6.  Earlier formats are deprecated and
118         have not even been tested: next version will drop pre-0.6 format.
119
120         Changes since 0.6@11:
121
122         - Moved interface to the "beta" status.  Some tiny parts are still
123           subject to change, but nothing important enough to warrant an "alpha"
124           status any longer.
125
126         - Slightly reduced the size of the Storable image by factorizing
127           object class names and removing final object storage notification due
128           to a redesign of the blessed object storing.
129
130         - Classes can now redefine how they wish their instances to be serialized
131           and/or deep cloned.  Serializing hooks are written in Perl code.
132
133         - The engine is now fully re-entrant.
134
135 Sun Apr  2 23:47:50 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
136
137 . Description:
138
139         Added provision to detect more recent binary formats, since
140         the new upcoming Storable-0.7 will use a different format.
141         In order to prevent attempting the de-serialization of newer
142         formats by older versions, I'm adding this now to the 0.6 series.
143
144         I'm expecting this revision to be the last of the 0.6 series.
145         Unless it does not work with perl 5.6, which I don't use yet,
146         and therefore against which I cannot test.
147
148 Wed Mar 29 19:55:21 MEST 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
149
150 . Description:
151
152         Added note about format incompatibilities with old versions
153         (i.e. pre 0.5@9 formats, which cannot be understood as there
154         was no versionning information in the file by then).
155
156         Protect all $@ variables when eval {} used, to avoid corrupting
157         it when store/retrieve is called within an exception handler.
158
159         Mistakenly included "patchlevel.h" instead of <patchlevel.h>,
160         preventing Perl's patchlevel from being included, which is
161         needed starting from 5.6.
162
163 Tue May 12 09:15:15 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
164
165 . Description:
166
167         Fixed shared "undef" bug in hashes, which did not remain shared
168         through store/retrieve.
169
170 Thu Feb 10 19:48:16 MET 2000   Raphael Manfredi <Raphael_Manfredi@pobox.com>
171
172 . Description:
173
174         added last_op_in_netorder() predicate
175         documented last_op_in_netorder()
176         added tests for the new last_op_in_netorder() predicate
177
178 Wed Oct 20 19:07:36 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
179
180 . Description:
181
182         Forgot to update VERSION
183
184 Tue Oct 19 21:25:02 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
185
186 . Description:
187
188         Added mention of japanese translation for the manual page.
189
190         Fixed typo in macro that made threaded code not compilable,
191         especially on Win32 platforms.
192
193         Changed detection of older perls (pre-5.005) by testing PATCHLEVEL
194         directly instead of relying on internal symbols.
195
196 Tue Sep 14 22:13:28 MEST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
197
198 . Description:
199
200         Integrated "thread-safe" patch from Murray Nesbitt.
201         Note that this may not be very efficient for threaded code,
202         see comment in the code.
203
204         Try to avoid compilation warning on 64-bit CPUs. Can't test it,
205         since I don't have access to such machines.
206
207 Mon Jul 12 14:37:19 METDST 1999   Raphael Manfredi <Raphael_Manfredi@pobox.com>
208
209 . Description:
210
211         changed my e-mail to pobox.
212
213         mentionned it is not thread-safe.
214
215         updated version number.
216
217         uses new internal PL_* naming convention.
218
219 Fri Jul  3 13:38:16 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
220
221 . Description:
222
223         Updated benchmark figures due to recent optimizations done in
224         store(): tagnums are now stored as-is in the hash table, so
225         no surrounding SV is created. And the "shared keys" mode for
226         hash table was turned off.
227
228         Fixed backward compatibility (wrt 0.5@9) for retrieval of
229         blessed refs. That old version did something wrong, but the
230         bugfix prevented correct retrieval of the old format.
231
232 Mon Jun 22 11:00:48 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
233
234 . Description:
235
236         Changed benchmark figures.
237
238         Adjust refcnt of tied objects after calling sv_magic() to avoid
239         memory leaks.  Contributed by Jeff Gresham.
240
241 Fri Jun 12 11:50:04 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
242
243 . Description:
244
245         Added workaround for persistent LVALUE-ness in perl5.004. All
246         scalars tagged as being an lvalue are handled as if they were
247         not an lvalue at all.  Added test for that LVALUE bug workaround.
248
249         Now handles Perl immortal scalars explicitely, by storing &sv_yes
250         as such, explicitely.
251
252         Retrieval of non-immortal undef cannot be shared. Previous
253         version was over-optimizing by not creating a separate SV for
254         all undefined scalars seen.
255
256 Thu Jun  4 17:21:51 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
257
258 . Description:
259
260         Baseline for Storable-0.6@0.
261
262         This version introduces a binary incompatibility in the generated
263         binary image, which is more compact than older ones by approximatively
264         15%, depending on the exact degree of sharing in your structures.
265
266         The good news is that your older images can still be retrieved with
267         this version, i.e. backward compatibility is preserved. This version
268         of Storable can only generate new binaries however.
269
270         Another good news is that the retrieval of data structure is
271         significantly quicker than before, because a Perl array is used
272         instead of a hash table to keep track of retrieved objects, and
273         also because the image being smaller, less I/O function calls are
274         made.
275
276 Tue May 12 09:15:15 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
277
278 . Description:
279
280         Version number now got from Storable.pm directly.
281
282         Fixed overzealous sv_type() optimization, which would make
283         Storable fail when faced with an "upgraded" SV to the PVIV
284         or PVNV kind containing a reference.
285
286 Thu Apr 30 15:11:30 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
287
288 . Description:
289
290         Extended the SYNOPSIS section to give quick overview of the
291         routines and their signature.
292
293         Optimized sv_type() to avoid flags checking when not needed, i.e.
294         when their type makes it impossible for them to be refs or tied.
295         This slightly increases throughput by a few percents when refs
296         and tied variables are marginal occurrences in your data.
297
298         Stubs for XS now use OutputStream and InputStream file types to
299         make it work when the given file is actually a socket. Perl
300         makes a distinction for sockets in its internal I/O structures
301         by having both a read and a write structure, whereas plain files
302         share the same one.
303
304 Tue Jun  3 09:41:33 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
305
306 . Description:
307
308         Thanks to a contribution from Benjamin A. Holzman, Storable is now
309         able to correctly serialize tied SVs, i.e. tied arrays, hashes
310         and scalars.
311
312 Thu Apr  9 18:07:51 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
313
314 . Description:
315
316         I said SvPOK() had changed to SvPOKp(), but that was a lie...
317
318 Wed Apr  8 13:14:29 METDST 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
319
320 . Description:
321
322         Wrote sizeof(SV *) instead of sizeof(I32) when portable, which
323         in effect mangled the object tags and prevented portability
324         accross 32/64 bit architectures!
325
326 Wed Mar 25 14:57:02 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
327
328 . Description:
329
330         Added code example for store_fd() and retrieve_fd() in the
331         man page, to emphasize that file descriptors must be passed as
332         globs, not as plain strings.
333
334         Cannot use SV addresses as tag when using nstore() on LP64. This
335         was the cause of problems when creating a storable image on an
336         LP64 machine and retrieving it on an ILP32 system, which is
337         exactly what nstore() is meant for...
338
339         However, we continue to use SV addresses as tags for plain store(),
340         because benchamarking shows that it saves up to 8% of the store
341         time, and store() is meant to be fast at the expense of lack
342         of portability.
343
344         This means there will be approximately an 8% degradation of
345         performance for nstore(), but it's now working as expected.
346         That cost may vary on your machine of course, since it is
347         solely caused by the memory allocation overhead used to create
348         unique SV tags for each distinct stored SV.
349
350 Tue Jan 20 09:21:53 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
351
352 . Description:
353
354         Don't use any '_' in version number.
355
356 Tue Jan 13 17:51:50 MET 1998   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
357
358 . Description:
359
360         Updated version number.
361
362         added binmode() calls for systems where it matters.
363
364         Be sure to pass globs, not plain file strings, to C routines,
365         so that Storable can be used under the Perl debugger.
366
367 Wed Nov  5 10:53:22 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
368
369 . Description:
370
371         Fix memory leaks on seen hash table and returned SV refs.
372
373         Storable did not work properly when tainting enabled.
374
375         Fixed "Allocation too large" messages in freeze/thaw and added.
376         proper regression test in t/freeze.t.
377
378 Tue Jun  3 09:41:33 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
379
380 . Description:
381
382         Updated version number
383
384         Added freeze/thaw interface and dclone.
385
386 Fri May 16 10:45:47 METDST 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
387
388 . Description:
389
390         Forgot that AutoLoader does not export its own AUTOLOAD.
391         I could use
392
393                 use AutoLoader 'AUTOLOAD';
394         
395         but that would not be backward compatible. So the export is
396         done by hand...
397
398 Tue Mar 25 11:21:32 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
399
400 . Description:
401
402         Empty scalar strings are now "defined" at retrieval time.
403
404         New test to ensure an empty string is defined when retrieved.
405
406 Thu Feb 27 16:32:44 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
407
408 . Description:
409
410         Updated version number
411
412         Declare VERSION as being used
413
414         Fixed a typo in the PerlIO_putc remapping.
415         PerlIO_read and perlIO_write inverted size/nb_items.
416         (only relevant for pre-perl5.004 versions)
417
418 Thu Feb 27 15:58:31 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
419
420 . Description:
421
422         Updated version number
423
424         Added VERSION identification
425
426         Allow build with perl5.003, which is ante perlIO time
427
428 Mon Jan 13 17:53:18 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
429
430 . Description:
431
432         Random code fixes.
433
434 Wed Jan 22 15:19:56 MET 1997   Raphael Manfredi <Raphael_Manfredi@grenoble.hp.com>
435
436 . Description:
437
438         Updated version number in Makefile.PL.
439
440         Added "thanks to" section to README.
441
442         Documented new forgive_me variable.
443
444         Made 64-bit clean.
445
446         Added forgive_me support to allow store() of data structures
447         containing non-storable items like CODE refs.
448