1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: add clarification on birthtime in fs stat

Browse Source 
Clarifies the possibility of birthtime in the fs stat
object being greater than atime or mtime when not available
in the filesystem (see issue for further info).

Fixes: https://github.com/nodejs/node/issues/2222
PR-URL: https://github.com/nodejs/node/pull/5479
Reviewed-By: James M Snell <jasnell@gmail.com>
This commit is contained in:
Kári Tristan Helgason 2016-02-28 21:28:17 +00:00 committed by Claudio Rodriguez
parent 5d214961b2
commit 995a33b5f6
1 changed files with 5 additions and 4 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

9
doc/api/fs.markdown
View File

@ -190,10 +190,11 @@ The times in the stat object have the following semantics:
* `birthtime` "Birth Time" - Time of file creation. Set once when the * `birthtime` "Birth Time" - Time of file creation. Set once when the
file is created. On filesystems where birthtime is not available, file is created. On filesystems where birthtime is not available,
this field may instead hold either the `ctime` or this field may instead hold either the `ctime` or
`1970-01-01T00:00Z` (ie, unix epoch timestamp `0`). On Darwin and `1970-01-01T00:00Z` (ie, unix epoch timestamp `0`). Note that this
other FreeBSD variants, also set if the `atime` is explicitly set to value may be greater than `atime` or `mtime` in this case. On Darwin
an earlier value than the current `birthtime` using the `utimes(2)` and other FreeBSD variants, also set if the `atime` is explicitly
system call. set to an earlier value than the current `birthtime` using the
`utimes(2)` system call.
Prior to Node v0.12, the `ctime` held the `birthtime` on Windows Prior to Node v0.12, the `ctime` held the `birthtime` on Windows
systems. Note that as of v0.12, `ctime` is not "creation time", and systems. Note that as of v0.12, `ctime` is not "creation time", and