Rename 'cleanup' to 'post'.
[whenjobs.git] / lib / whenfile.mli
index 7883fa7..5ca68d0 100644 (file)
@@ -25,7 +25,7 @@ val init : Whenstate.t -> unit
 val get_state : unit -> Whenstate.t
 (** Return the updated state.  Call this after parsing the file. *)
 
 val get_state : unit -> Whenstate.t
 (** Return the updated state.  Call this after parsing the file. *)
 
-val add_when_job : Camlp4.PreCast.Loc.t -> string -> Whenexpr.cleanup option -> Camlp4.PreCast.Ast.expr -> Whenexpr.shell_script -> unit
+val add_when_job : Camlp4.PreCast.Loc.t -> string -> Whenexpr.pre option -> Whenexpr.post option -> Camlp4.PreCast.Ast.expr -> Whenexpr.shell_script -> unit
 (** When a 'when' macro appears as a toplevel statement in an
     input file, it causes this function to be called.
 
 (** When a 'when' macro appears as a toplevel statement in an
     input file, it causes this function to be called.
 
@@ -33,13 +33,13 @@ val add_when_job : Camlp4.PreCast.Loc.t -> string -> Whenexpr.cleanup option ->
 
     [name] is the name of the job.
 
 
     [name] is the name of the job.
 
-    [cleanup] is the optional cleanup function.
+    [pre] and [post] are the optional pre and post functions.
 
     [expr] is the expression, as an OCaml abstract syntax tree.
 
     [sh] is the shell script fragment (basically location + a big string). *)
 
 
     [expr] is the expression, as an OCaml abstract syntax tree.
 
     [sh] is the shell script fragment (basically location + a big string). *)
 
-val add_every_job : Camlp4.PreCast.Loc.t -> string -> Whenexpr.cleanup option -> Whenexpr.periodexpr -> Whenexpr.shell_script -> unit
+val add_every_job : Camlp4.PreCast.Loc.t -> string -> Whenexpr.pre option -> Whenexpr.post option -> Whenexpr.periodexpr -> Whenexpr.shell_script -> unit
 (** When an 'every' macro appears as a toplevel statement in an
     input file, it causes this function to be called.
 
 (** When an 'every' macro appears as a toplevel statement in an
     input file, it causes this function to be called.
 
@@ -47,7 +47,7 @@ val add_every_job : Camlp4.PreCast.Loc.t -> string -> Whenexpr.cleanup option ->
 
     [name] is the name of the job.
 
 
     [name] is the name of the job.
 
-    [cleanup] is the optional cleanup function.
+    [pre] and [post] are the optional pre and post functions.
 
     [periodexpr] is the period, eg. 30 seconds.
 
 
     [periodexpr] is the period, eg. 30 seconds.