summaryrefslogtreecommitdiff
path: root/stdlib/ephemeron.mli
diff options
context:
space:
mode:
authorDamien Doligez <damien.doligez@inria.fr>2016-02-18 16:11:59 +0100
committerDamien Doligez <damien.doligez@inria.fr>2016-02-18 16:59:16 +0100
commit5401ce8473062b19dd3553d022593cc5d91ccbff (patch)
treea0c140149b7d6a599d71a59132360d12a955feff /stdlib/ephemeron.mli
parent6e794aee7257ea72e785dc743981b4cc36cb14c6 (diff)
downloadocaml-5401ce8473062b19dd3553d022593cc5d91ccbff.tar.gz
Update headers for the new license.
Remains to be done: remove all headers in testsuite/tests.
Diffstat (limited to 'stdlib/ephemeron.mli')
-rw-r--r--stdlib/ephemeron.mli36
1 files changed, 19 insertions, 17 deletions
diff --git a/stdlib/ephemeron.mli b/stdlib/ephemeron.mli
index cc62c296eb..1d1e58cccd 100644
--- a/stdlib/ephemeron.mli
+++ b/stdlib/ephemeron.mli
@@ -1,15 +1,17 @@
-(***********************************************************************)
-(* *)
-(* OCaml *)
-(* *)
-(* Damien Doligez, projet Para, INRIA Rocquencourt *)
-(* *)
-(* Copyright 1997 Institut National de Recherche en Informatique et *)
-(* en Automatique. All rights reserved. This file is distributed *)
-(* under the terms of the GNU Library General Public License, with *)
-(* the special exception on linking described in file ../LICENSE. *)
-(* *)
-(***********************************************************************)
+(**************************************************************************)
+(* *)
+(* OCaml *)
+(* *)
+(* Damien Doligez, projet Para, INRIA Rocquencourt *)
+(* *)
+(* Copyright 1997 Institut National de Recherche en Informatique et *)
+(* en Automatique. *)
+(* *)
+(* All rights reserved. This file is distributed under the terms of *)
+(* the GNU Lesser General Public License version 2.1, with the *)
+(* special exception on linking described in the file LICENSE. *)
+(* *)
+(**************************************************************************)
(** Ephemerons and weak hash table *)
@@ -66,12 +68,12 @@
module type S = sig
(** Propose the same interface as usual hash table. However since
- the bindings are weak, [mem h k] is true doesn't mean that a
- just following [find h k] will not raise the exception
- [Not_found] since the garbage collector can run between the two.
+ the bindings are weak, even if [mem h k] is true, a subsequent
+ [find h k] may raise [Not_found] because the garbage collector
+ can run between the two.
- Secondly during an iteration the table shouldn't be modified.
- Instead use {!filter_map_inplace} for that purpose.
+ Moreover, the table shouldn't be modified during a call to [iter].
+ Use [filter_map_inplace] in this case.
*)
include Hashtbl.S