Commits

camlspotter committed e243da0

added dotfile.mli

Comments (0)

Files changed (1)

ocamlspot/dotfile.mli

+(***********************************************************************)
+(*                                                                     *)
+(*                            ocamlspotter                             *)
+(*                                                                     *)
+(*                             Jun FURUSE                              *)
+(*                                                                     *)
+(*   Copyright 2008, 2009 Jun Furuse. 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.                                        *)
+(*                                                                     *)
+(***********************************************************************)
+
+(* module for .ocamlspot file 
+
+   build_dir: dirname
+
+      Work around for ocamlbuild. If .ocamlspot is placed in a directory $DIR,
+      then spot files of source files under $DIR ex. $DIR/subdir/source.ml
+      is searched in $DIR/dirname/subdir/.
+*)
+
+type t = { build_dir : string option; }
+  (** the info stored in dotfile *)
+
+val name : string
+  (** name of dot file. [".ocamlspot"] *)
+
+val find : string -> (string * string) option
+  (** Find the dotfile in the given directory. If not found, check its parent recursively. 
+      Returns the found dirname and path name. The found file is [Filename.concat dirname path]. 
+  *)
+
+val load : string -> t
+  (** Load the dotfile of the given path *)
+
+val find_and_load : string -> (string * t) option
+  (** Find and load the dotfile *)