aboutsummaryrefslogtreecommitdiffstats
path: root/file.c
diff options
context:
space:
mode:
Diffstat (limited to 'file.c')
-rw-r--r--file.c6
1 files changed, 6 insertions, 0 deletions
diff --git a/file.c b/file.c
index b0e4888f7e..ee2e87cfbc 100644
--- a/file.c
+++ b/file.c
@@ -2883,6 +2883,12 @@ unlink_internal(const char *path, VALUE pathv, void *arg)
*
* Deletes the named files, returning the number of names
* passed as arguments. Raises an exception on any error.
+ * Since the underlying implementation relies on the
+ * <code>unlink(2)</code> system call, the type of
+ * exception raised depends on its error type (see
+ * https://linux.die.net/man/2/unlink) and has the form of
+ * e.g. <code>Errno::ENOENT</code>.
+ *
* See also <code>Dir::rmdir</code>.
*/