From 4783c635fd6939efdcbcc8c4ef5e2bf4686cd7b7 Mon Sep 17 00:00:00 2001 From: Simon Cruanes Date: Mon, 9 Aug 2021 13:26:30 -0400 Subject: [PATCH] remove dead doc files --- doc/build_deps.ml | 32 --------- doc/dune | 8 --- doc/intro.txt | 166 ---------------------------------------------- 3 files changed, 206 deletions(-) delete mode 100755 doc/build_deps.ml delete mode 100644 doc/dune delete mode 100644 doc/intro.txt diff --git a/doc/build_deps.ml b/doc/build_deps.ml deleted file mode 100755 index 7763f622..00000000 --- a/doc/build_deps.ml +++ /dev/null @@ -1,32 +0,0 @@ -#!/usr/bin/env ocaml - -(* note: this requires to generate documentation first, so that - .odoc files are generated *) - -#use "topfind";; -#require "containers";; -#require "containers.io";; -#require "gen";; -#require "unix";; - -let odoc_files = - CCIO.File.walk "_build" - |> Gen.filter_map - (function - | `File, f when CCString.suffix ~suf:".odoc" f -> Some f - | _ -> None - ) - |> Gen.flat_map - (fun f -> Gen.of_list ["-load"; f]) - |> Gen.to_list -;; - -let out = "deps.dot";; - -let cmd = - "ocamldoc -dot -o " ^ out ^ " " ^ String.concat " " odoc_files -;; - -print_endline ("run: " ^ cmd);; -Unix.system cmd;; -print_endline ("output in " ^ out);; diff --git a/doc/dune b/doc/dune deleted file mode 100644 index 2dbb14d7..00000000 --- a/doc/dune +++ /dev/null @@ -1,8 +0,0 @@ - -;(alias -; (name runtest) -; (deps containers.md) -; (action (progn -; (run mdx test %{deps}) -; (diff? %{deps} %{deps}.corrected)))) -; diff --git a/doc/intro.txt b/doc/intro.txt deleted file mode 100644 index 8800a6ab..00000000 --- a/doc/intro.txt +++ /dev/null @@ -1,166 +0,0 @@ -{1 Containers} - -{2 Change Log} - -See {{: https://github.com/c-cube/ocaml-containers/blob/master/CHANGELOG.adoc } this file} - -{2 License} - -This code is free, under the BSD license. - -The logo (media/logo.png) is -CC-SA3 {{:http://en.wikipedia.org/wiki/File:Hypercube.svg} wikimedia} - -{2 Contents} - -The design is mostly centered around polymorphism rather than functors. Such -structures comprise (some modules in misc/, some other in core/): - -the core library, containers, now depends on base-bytes (provided -by ocamlfind). - -{4 Core Modules (extension of the standard library)} - -{b findlib name}: containers - -{!modules: -CCArray -CCArrayLabels -CCArray_slice -CCBool -CCChar -CCEqual -CCFloat -CCFormat -CCFun -CCHash -CCHashtbl -CCHeap -CCIO -CCInt -CCInt64 -CCList -CCListLabels -CCMap -CCOpt -CCOrd -CCPair -CCParse -CCRandom -CCRef -CCResult -CCSet -CCString -CCVector -Containers -} - -The module {!Containers} contains aliases to most other modules defined -in {i containers core}, and mixins -such as: - -{[ module List = struct - include List - include CCList - end -]} - -{4 Containers.data} - -{b findlib name}: containers.data - -Various data structures. - -{!modules: -CCBitField -CCBV -CCCache -CCDeque -CCFQueue -CCFlatHashtbl -CCGraph -CCHashSet -CCHashTrie -CCHet -CCImmutArray -CCIntMap -CCMixmap -CCMixset -CCMixtbl -CCMultiMap -CCMultiSet -CCPersistentArray -CCPersistentHashtbl -CCRAL -CCRingBuffer -CCSimple_queue -CCTrie -CCWBTree -} - -{4 Containers.unix} - -Helpers that depend on {!Unix}, e.g. to spawn sub-processes. - -{!modules: CCUnix} - -{4 Containers.sexp} - -A small S-expression library. The interface is relatively unstable, but -the main type ([CCSexp.t]) isn't. - -{!modules: -CCSexp -} - -{4 Containers.iter} - -Iterators: - -{!modules: -CCKList -CCKTree -CCLazy_list} - -{4 String} - -containers.string has been removed. Some of its functionality is present -in {!CCString}; some in other libraries such as [Spelll]. - -{4 Bigarrays} - -containers.bigarray has been removed. Use the [Bigstring] library for -arrays of bytes. - -{4 Advanced} - -containers.advanced has been removed. Use [OLinq] to replace some of its -functionality. - -{4 Misc} - -Moved to its own repository. - -{4 Lwt} - -Moved to its own repository - -{4 Thread Helpers} - -{b findlib name}: containers.thread - -Modules related to the use of [Thread]. - -{!modules: -CCBlockingQueue -CCLock -CCPool -CCSemaphore -CCThread -CCTimer -} - - -{2 Index} - -{!indexlist}