- changes defaults of getxml (format gzipped, don't patch dtd)

[helm.git] / helm / ocaml / getter / http_getter.mli

diff --git a/helm/ocaml/getter/http_getter.mli b/helm/ocaml/getter/http_getter.mli
index c7a2c5c2ac865329caf9ef392d3d7d7ea6110bdb..0b86e730d54eabac028cfb8aea52ec4cbf61ef0b 100644 (file)
--- a/helm/ocaml/getter/http_getter.mli
+++ b/helm/ocaml/getter/http_getter.mli
@@ -49,6 +49,9 @@ val register: uri:string -> url:string -> unit
 val unregister: string -> unit
 
 val update: ?logger:logger_callback -> unit -> unit
+
+  (** @param format defaults to `Gzipped
+   * @param patch_dtd defaults to false *)
 val getxml  : ?format:encoding -> ?patch_dtd:bool -> string -> string
 val getxslt : ?patch_dtd:bool -> string -> string
 val getdtd  : ?patch_dtd:bool -> string -> string
@@ -64,9 +67,10 @@ val ls: string -> ls_item list
 
   (** {2 Shorthands} *)
 
-val getxml'   : UriManager.uri -> string
-val resolve'  : UriManager.uri -> string
-val register' : UriManager.uri -> string -> unit
+val getxml'     : UriManager.uri -> string  (* `Gzipped format, no DTD patch *)
+val resolve'    : UriManager.uri -> string
+val register'   : UriManager.uri -> string -> unit
+val unregister' : UriManager.uri -> unit
 
   (** {2 Misc} *)
 
@@ -75,3 +79,5 @@ val update_from_one_server: ?logger:logger_callback -> string -> unit
 val has_server: int -> bool (* does a server with a given position exists? *)
 val init: unit -> unit
 
+  (** cal this at exit() *)
+val sync_dump_file: unit -> unit