diff options
author | Rui Abreu Ferreira <raf-ep@gmx.com> | 2015-10-20 00:02:01 +0100 |
---|---|---|
committer | Rui Abreu Ferreira <raf-ep@gmx.com> | 2015-11-25 23:15:37 +0000 |
commit | 8dea8a036fcf4f8d0ce8fd26cc3826067b384f13 (patch) | |
tree | 3527473d564080b2a5e5c67d5d9a9ddd9eab9bcc /src/nvim/os/fs.c | |
parent | 4f24b9e06f59592c120dd6d5c1e7f0f4a53b23f1 (diff) | |
download | rneovim-8dea8a036fcf4f8d0ce8fd26cc3826067b384f13.tar.gz rneovim-8dea8a036fcf4f8d0ce8fd26cc3826067b384f13.tar.bz2 rneovim-8dea8a036fcf4f8d0ce8fd26cc3826067b384f13.zip |
Fix comments for os_* functions return value
In windows libuv does not return -errno, instead it uses negative
error codes e.g. UV_ENOENT. This commit changes the comments in os_*
functions to reflect this.
Diffstat (limited to 'src/nvim/os/fs.c')
-rw-r--r-- | src/nvim/os/fs.c | 10 |
1 files changed, 5 insertions, 5 deletions
diff --git a/src/nvim/os/fs.c b/src/nvim/os/fs.c index 3fb00eb24e..94b0be90fd 100644 --- a/src/nvim/os/fs.c +++ b/src/nvim/os/fs.c @@ -185,13 +185,13 @@ static bool is_executable_in_path(const char_u *name, char_u **abspath) /// Opens or creates a file and returns a non-negative integer representing /// the lowest-numbered unused file descriptor, for use in subsequent system -/// calls (read, write, lseek, fcntl, etc.). If the operation fails, `-errno` -/// is returned, and no file is created or modified. +/// calls (read, write, lseek, fcntl, etc.). If the operation fails, a libuv +/// error code is returned, and no file is created or modified. /// /// @param flags Bitwise OR of flags defined in <fcntl.h> /// @param mode Permissions for the newly-created file (IGNORED if 'flags' is /// not `O_CREAT` or `O_TMPFILE`), subject to the current umask -/// @return file descriptor, or negative `errno` on failure +/// @return file descriptor, or libuv error code on failure int os_open(const char* path, int flags, int mode) FUNC_ATTR_NONNULL_ALL { @@ -322,7 +322,7 @@ int os_rename(const char_u *path, const char_u *new_path) /// Make a directory. /// -/// @return `0` for success, -errno for failure. +/// @return `0` for success, libuv error code for failure. int os_mkdir(const char *path, int32_t mode) FUNC_ATTR_NONNULL_ALL { @@ -342,7 +342,7 @@ int os_mkdir(const char *path, int32_t mode) /// failed to create. I.e. it will contain dir or any /// of the higher level directories. /// -/// @return `0` for success, -errno for failure. +/// @return `0` for success, libuv error code for failure. int os_mkdir_recurse(const char *const dir, int32_t mode, char **const failed_dir) FUNC_ATTR_NONNULL_ALL FUNC_ATTR_WARN_UNUSED_RESULT |