document write_header

mirage · Feb 4, 2024 · 2b49b1f · 2b49b1f
1 parent 462063b
commit 2b49b1f
Show file tree

Hide file tree

Showing 2 changed files with 2 additions and 0 deletions.
diff --git 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
@@ -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