proxmox-mirrors/libgit2
1
0
Fork 0
mirror of https://git.proxmox.com/git/libgit2 synced 2025-05-02 14:37:30 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

giterr_set_str: remove GITERR_OS documentation

Browse Source 
The `giterr_set_str` does not actually honor `GITERR_OS`.  Remove
the documentation that claims that we do.
This commit is contained in:
Edward Thomson 2016-02-23 13:05:49 -05:00
parent 04c3b35f9c
commit cd59e0c0c7
1 changed files with 0 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
include/git2/errors.h
View File

@ -126,11 +126,6 @@ GIT_EXTERN(void) giterr_clear(void);
* This error message is stored in thread-local storage and only applies
* to the particular thread that this libgit2 call is made from.
*
* NOTE: Passing the `error_class` as GITERR_OS has a special behavior: we
* attempt to append the system default error message for the last OS error
* that occurred and then clear the last error. The specific implementation
* of looking up and clearing this last OS error will vary by platform.
*
* @param error_class One of the `git_error_t` enum above describing the
* general subsystem that is responsible for the error.
* @param string The formatted error message to keep