doc: fs.mkdir('/') throws EPERM on Windows

Fixes: nodejs#25110 PR-URL: nodejs#25340 Reviewed-By: Rich Trott <rtrott@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com> Reviewed-By: Ben Coe <bencoe@gmail.com>
refack · Jan 10, 2019 · 2aa197b · 2aa197b
1 parent 734e482
commit 2aa197b
Showing 1 changed file with 9 additions and 0 deletions.
diff --git a/doc/api/fs.md b/doc/api/fs.md
@@ -2212,6 +2212,15 @@ fs.mkdir('/tmp/a/apple', { recursive: true }, (err) => {
 });
 ```
 
+On Windows, using `fs.mkdir()` on the root directory even with recursion will
+result in an error:
+
+```js
+fs.mkdir('/', { recursive: true }, (err) => {
+ // => [Error: EPERM: operation not permitted, mkdir 'C:\']
+});
+```
+
 See also: mkdir(2).
 
 ## fs.mkdirSync(path[, options])