added support for patch_fun also for gzipped documents

[helm.git] / helm / http_getter / http_getter_common.mli

diff --git a/helm/http_getter/http_getter_common.mli b/helm/http_getter/http_getter_common.mli
index 711a5713d9f6fa3d195e810e5c2c18d16d758dde..09d45f1824d832404e0440200ad688a94137098c 100644 (file)
--- a/helm/http_getter/http_getter_common.mli
+++ b/helm/http_getter/http_getter_common.mli
@@ -63,10 +63,14 @@ val return_400: string -> out_channel -> unit
   @param contype Content-Type header value
   @param contenc Content-Enconding header value
   @param patch_fun function used to patch file contents
+  @param gunzip is meaningful only if a patch function is provided. If gunzip
+  is true patch_fun is applied to the uncompressed version of the file. The file
+  is then compressed again and send to client
   @param outchan output channel over which sent file fname *)
 val return_file:
   fname:string ->
-  ?contype:string -> ?contenc:string -> ?patch_fun:(string -> string) ->
+  ?contype:string -> ?contenc:string ->
+  ?patch_fun:(string -> string) -> ?gunzip:bool ->
   out_channel ->
     unit