Ekdohibs
/
ocaml
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Document how to perform the inverse of (gm|local)time 

The goal is to make the documentation slightly more self contained on
the links between the time functions.
master
Christophe Troestler 2017-02-17 22:17:16 +01:00
parent 9e2177ed87
commit af092cccff
1 changed files with 5 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

7
otherlibs/unix/unix.mli
View File

@ -970,11 +970,14 @@ val gettimeofday : unit -> float
val gmtime : float -> tm
(** Convert a time in seconds, as returned by {!Unix.time}, into a date and
a time. Assumes UTC (Coordinated Universal Time), also known as GMT. *)
a time. Assumes UTC (Coordinated Universal Time), also known as GMT.
To perform the inverse conversion, set the TZ environment variable
to "UTC", use {!mktime}, and then restore the original value of TZ. *)
val localtime : float -> tm
(** Convert a time in seconds, as returned by {!Unix.time}, into a date and
a time. Assumes the local time zone. *)
a time. Assumes the local time zone.
The function performing the inverse conversion is {!mktime}. *)
val mktime : tm -> float * tm
(** Convert a date and time, specified by the [tm] argument, into