From d67dceddb848a68b820fa3af4a2f689192c6064d Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 8 Dec 2014 10:36:25 +0100 Subject: [PATCH] prepare for 0.6.1 --- CHANGELOG.md | 8 ++++++++ HOWTO.md | 11 ++++++----- README.md | 2 +- _oasis | 2 +- core/CCFloat.mli | 2 +- core/CCGen.mli | 2 +- core/CCKTree.mli | 6 +++--- core/CCOpt.mli | 2 +- core/CCRandom.mli | 6 +++--- 9 files changed, 25 insertions(+), 16 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 141915f7..f931d873 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,13 @@ # Changelog +## 0.6.1 + +- use subtree `gen/` for `CCGen` (symlink) rather than a copy. +- Add benchmarks for the function `iter` of iterators. +- `CCKTree`: more printers (to files), `Format` printer +- `CCOpt.get_lazy` convenience function +- introduce `CCFloat`, add float functions to `CCRandom` (thanks to @struktured) + ## 0.6 #### breaking changes diff --git a/HOWTO.md b/HOWTO.md index 3226aac4..626395e5 100644 --- a/HOWTO.md +++ b/HOWTO.md @@ -3,12 +3,13 @@ 1. `make test-all` 2. update version in `_oasis` -3. `make update_next_tag` (to update `@since` comments) +3. `make update_next_tag` (to update `@since` comments; be careful not to change symlinks) 4. update `CHANGELOG.md` (see its end to find the right git command) -5. `git checkout stable` -6. `git merge master` -7. commit, tag, and push both to github -8. new opam package +5. commit the changes +6. `git checkout stable` +7. `git merge master` +8. tag, and push both to github +9. new opam package ## List Authors diff --git a/README.md b/README.md index b11cbff3..c355358c 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Documentation [here](http://cedeela.fr/~simon/software/containers). - `CCBV`, mutable bitvectors - `CCPersistentHashtbl`, a semi-persistent hashtable (similar to [persistent arrays](https://www.lri.fr/~filliatr/ftp/ocaml/ds/parray.ml.html)) - `CCVector`, a growable array (pure OCaml, no C) with mutability annotations -- `CCGen` and `CCSequence`, generic iterators structures (with structural types so they can be defined in several places). Now also in their own repository and opam packages (`gen` and `sequence`). +- `CCGen` and `CCSequence`, generic iterators structures (with structural types so they can be defined in several places). They are also available in their own repository and opam packages (`gen` and `sequence`). Note that the `@since` annotations may not be accurate because of the use of `git subtree`. - `CCKList`, a persistent iterator structure (akin to a lazy list) - `CCList`, functions on lists, including tail-recursive implementations of `map` and `append` and many other things - `CCArray`, utilities on arrays and slices diff --git a/_oasis b/_oasis index d2be514a..7d9aba04 100644 --- a/_oasis +++ b/_oasis @@ -1,6 +1,6 @@ OASISFormat: 0.4 Name: containers -Version: 0.6 +Version: 0.6.1 Homepage: https://github.com/c-cube/ocaml-containers Authors: Simon Cruanes License: BSD-2-clause diff --git a/core/CCFloat.mli b/core/CCFloat.mli index 1711385d..02da623e 100644 --- a/core/CCFloat.mli +++ b/core/CCFloat.mli @@ -24,7 +24,7 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. *) (** {1 Basic Float functions} -@since NEXT_RELEASE *) +@since 0.6.1 *) type t = float type fpclass = Pervasives.fpclass = diff --git a/core/CCGen.mli b/core/CCGen.mli index f295345b..0d284c22 100644 --- a/core/CCGen.mli +++ b/core/CCGen.mli @@ -98,7 +98,7 @@ val persistent_lazy : 'a t -> 'a Restart.t (** Same as {!persistent}, but consumes the generator on demand (by chunks). This allows to make a restartable generator out of an ephemeral one, without paying a big cost upfront (nor even consuming it fully). - @since NEXT_RELEASE *) + @since 0.6.1 *) val start : 'a Restart.t -> 'a t (** Create a new transient generator. diff --git a/core/CCKTree.mli b/core/CCKTree.mli index 8137fe19..c64444f3 100644 --- a/core/CCKTree.mli +++ b/core/CCKTree.mli @@ -127,17 +127,17 @@ module Dot : sig val print : graph formatter (** Printer with indentation, etc. - @since NEXT_RELEASE *) + @since 0.6.1 *) val print_to_file : string -> graph -> unit (** [print_to_file filename g] prints [g] into a file whose name is [filename]. - @since NEXT_RELEASE *) + @since 0.6.1 *) val to_file : ?name:string -> string -> attribute list t list -> unit (** [to_file filename trees] makes a graph out of the trees, opens the file [filename] and prints the graph into the file. @param name name of the graph - @since NEXT_RELEASE *) + @since 0.6.1 *) end diff --git a/core/CCOpt.mli b/core/CCOpt.mli index 7bca99e5..f3214310 100644 --- a/core/CCOpt.mli +++ b/core/CCOpt.mli @@ -75,7 +75,7 @@ val get_exn : 'a t -> 'a val get_lazy : (unit -> 'a) -> 'a t -> 'a (** [get_lazy default_fn x] unwraps [x], but if [x = None] it returns [default_fn ()] instead. - @since NEXT_RELEASE *) + @since 0.6.1 *) val sequence_l : 'a t list -> 'a list t (** [sequence_l [x1; x2; ...; xn]] returns [Some [y1;y2;...;yn]] if diff --git a/core/CCRandom.mli b/core/CCRandom.mli index 254538d4..506fca86 100644 --- a/core/CCRandom.mli +++ b/core/CCRandom.mli @@ -90,15 +90,15 @@ val int_range : int -> int -> int t val small_float : float t (** A reasonably small float. - @since NEXT_RELEASE *) + @since 0.6.1 *) val float : float -> float t (** Random float within the given range - @since NEXT_RELEASE *) + @since 0.6.1 *) val float_range : float -> float -> float t (** Inclusive range - @since NEXT_RELEASE *) + @since 0.6.1 *) val split : int -> (int * int) option t