os: document that Rename does not replace an existing directory

Fixes #18240.

Change-Id: Ife951e2c1320b3f1362c85642615b24fd4291189
Reviewed-on: https://go-review.googlesource.com/34135
Reviewed-by: Brad Fitzpatrick <bradfitz@golang.org>

diff --git a/src/os/file.go b/src/os/file.go
index de245c54792b012258f8fcaad848cccf023789e4..d45a00b12396a64cdf50fca59540392538cc5abf 100644 (file)
--- a/src/os/file.go
+++ b/src/os/file.go
@@ -260,7 +260,7 @@ func Create(name string) (*File, error) {
 var lstat = Lstat
 
 // Rename renames (moves) oldpath to newpath.
-// If newpath already exists, Rename replaces it.
+// If newpath already exists and is not a directory, Rename replaces it.
 // OS-specific restrictions may apply when oldpath and newpath are in different directories.
 // If there is an error, it will be of type *LinkError.
 func Rename(oldpath, newpath string) error {