From 2b49b1f5d07e700c30889a71c81f5557de3e070f Mon Sep 17 00:00:00 2001 From: Hannes Mehnert Date: Sun, 4 Feb 2024 13:31:21 +0100 Subject: [PATCH] document write_header --- unix/tar_lwt_unix.mli | 1 + unix/tar_unix.mli | 1 + 2 files changed, 2 insertions(+) diff --git a/unix/tar_lwt_unix.mli b/unix/tar_lwt_unix.mli index cc8ae47..1282b38 100644 --- a/unix/tar_lwt_unix.mli +++ b/unix/tar_lwt_unix.mli @@ -63,6 +63,7 @@ val append_file : ?level:Tar.Header.compatibility -> ?header:Tar.Header.t -> string -> Lwt_unix.file_descr -> (unit, [ `Msg of string | `Unix of (Unix.error * string * string) ]) result Lwt.t +(** [write_header ~level hdr fd] writes the header [hdr] to [fd]. *) val write_header : ?level:Tar.Header.compatibility -> Tar.Header.t -> Lwt_unix.file_descr -> (unit, [ `Msg of string | `Unix of (Unix.error * string * string) ]) result Lwt.t diff --git a/unix/tar_unix.mli b/unix/tar_unix.mli index 283795f..3863ffd 100644 --- a/unix/tar_unix.mli +++ b/unix/tar_unix.mli @@ -63,6 +63,7 @@ val append_file : ?level:Tar.Header.compatibility -> ?header:Tar.Header.t -> string -> Unix.file_descr -> (unit, [ `Msg of string | `Unix of (Unix.error * string * string) ]) result +(** [write_header ~level hdr fd] writes the header [hdr] to [fd]. *) val write_header : ?level:Tar.Header.compatibility -> Tar.Header.t -> Unix.file_descr -> (unit, [ `Msg of string | `Unix of (Unix.error * string * string) ]) result