summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorXavier Leroy <xavier.leroy@inria.fr>2017-08-30 17:14:09 +0200
committerXavier Leroy <xavier.leroy@inria.fr>2017-08-30 17:14:09 +0200
commitbdb9b258471dad9e968bba3fe876195512a412cc (patch)
tree1661fa567c7e91667e5c99f134a404ba08efab91
parent3cd2a99085b50249d59094177b95ac193d6d03c2 (diff)
downloadocaml-win32-rename.tar.gz
Improve documentation of Unix.renamewin32-rename
Bring it in line with that of Sys.rename.
-rw-r--r--otherlibs/unix/unix.mli7
1 files changed, 6 insertions, 1 deletions
diff --git a/otherlibs/unix/unix.mli b/otherlibs/unix/unix.mli
index d134157061..32ea7f13a6 100644
--- a/otherlibs/unix/unix.mli
+++ b/otherlibs/unix/unix.mli
@@ -557,7 +557,12 @@ val unlink : string -> unit
*)
val rename : string -> string -> unit
-(** [rename old new] changes the name of a file from [old] to [new]. *)
+(** [rename old new] changes the name of a file from [old] to [new],
+ moving it between directories if needed. If [new] already
+ exists, its contents will be replaced with those of [old].
+ Depending on the operating system, the metadata (permissions,
+ owner, etc) of [new] can either be preserved or be replaced by
+ those of [old]. *)
val link : string -> string -> unit
(** [link source dest] creates a hard link named [dest] to the file