From 6dfd51d17d2530041a65102357c689c9fb062ce5 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Sun, 21 Feb 2016 16:40:32 +0100 Subject: [PATCH] deprecate `containers.bigarray` --- README.adoc | 2 +- doc/intro.txt | 1 + src/bigarray/CCArray1.mli | 4 +++- src/bigarray/CCBigstring.ml | 24 +----------------------- src/bigarray/CCBigstring.mli | 30 ++++++------------------------ 5 files changed, 12 insertions(+), 49 deletions(-) diff --git a/README.adoc b/README.adoc index 8689a4a3..26cbce77 100644 --- a/README.adoc +++ b/README.adoc @@ -31,7 +31,7 @@ What is _containers_? a LINQ-like query module, batch operations using GADTs, and others). - Utilities around the `unix` library in `containers.unix` (mainly to spawn sub-processes) -- A bigstring module using `bigarray` in `containers.bigarray` +- A bigstring module using `bigarray` in `containers.bigarray` (*deprecated*) - A lightweight S-expression printer and streaming parser in `containers.sexp` Some of the modules have been moved to their own repository (e.g. `sequence`, diff --git a/doc/intro.txt b/doc/intro.txt index 2344eccb..1b331182 100644 --- a/doc/intro.txt +++ b/doc/intro.txt @@ -126,6 +126,7 @@ CCParse {4 Bigarrays} +{b deprecated} (use package bigstring instead) Use bigarrays to hold large strings and map files directly into memory. {!modules: CCBigstring CCArray1} diff --git a/src/bigarray/CCArray1.mli b/src/bigarray/CCArray1.mli index ebde558e..4cb6fbea 100644 --- a/src/bigarray/CCArray1.mli +++ b/src/bigarray/CCArray1.mli @@ -25,7 +25,9 @@ OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. (** {1 Bigarrays of dimension 1} - {b status: experimental} + {b NOTE this module will be removed soon and should not be depended upon} + + {b status: deprecated} @since 0.12 *) (** {2 used types} *) diff --git a/src/bigarray/CCBigstring.ml b/src/bigarray/CCBigstring.ml index a22fe168..4dcef050 100644 --- a/src/bigarray/CCBigstring.ml +++ b/src/bigarray/CCBigstring.ml @@ -1,27 +1,5 @@ -(* -copyright (c) 2013-2014, simon cruanes -all rights reserved. -redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -redistributions of source code must retain the above copyright notice, this -list of conditions and the following disclaimer. redistributions in binary -form must reproduce the above copyright notice, this list of conditions and the -following disclaimer in the documentation and/or other materials provided with -the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -*) +(* This file is free software, part of containers. See file "license" for more details. *) (** {1 Interface to 1-dimension Bigarrays of bytes (char)} *) diff --git a/src/bigarray/CCBigstring.mli b/src/bigarray/CCBigstring.mli index 6eb0143b..5c8c6a9a 100644 --- a/src/bigarray/CCBigstring.mli +++ b/src/bigarray/CCBigstring.mli @@ -1,31 +1,13 @@ -(* -copyright (c) 2013-2014, simon cruanes -all rights reserved. -redistribution and use in source and binary forms, with or without -modification, are permitted provided that the following conditions are met: - -redistributions of source code must retain the above copyright notice, this -list of conditions and the following disclaimer. redistributions in binary -form must reproduce the above copyright notice, this list of conditions and the -following disclaimer in the documentation and/or other materials provided with -the distribution. - -THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND -ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED -WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE -DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE -FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL -DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR -SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER -CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, -OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE -OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE. -*) +(* This file is free software, part of containers. See file "license" for more details. *) (** {1 Interface to 1-dimension Bigarrays of bytes (char)} -@since 0.7 *) + @deprecated use the package [bigstring] instead. + + {b status: deprecated, do not use anymore} + + @since 0.7 *) type t = (char, Bigarray.int8_unsigned_elt, Bigarray.c_layout) Bigarray.Array1.t