diff options
| author | Edward Thomson <ethomson@github.com> | 2016-02-23 13:05:49 -0500 |
|---|---|---|
| committer | Edward Thomson <ethomson@github.com> | 2016-02-23 13:08:58 -0500 |
| commit | cd59e0c0c757a5bcc4ed2324b207846b411368cb (patch) | |
| tree | 5d601ca5e629b8f3e142ba81c8139b8f2434c792 | |
| parent | 04c3b35f9c90fb93390c0198bc1a8123ca13e081 (diff) | |
| download | libgit2-cd59e0c0c757a5bcc4ed2324b207846b411368cb.tar.gz | |
giterr_set_str: remove `GITERR_OS` documentation
The `giterr_set_str` does not actually honor `GITERR_OS`. Remove
the documentation that claims that we do.
| -rw-r--r-- | include/git2/errors.h | 5 |
1 files changed, 0 insertions, 5 deletions
diff --git a/include/git2/errors.h b/include/git2/errors.h index 1b528cf25..3ecea34bf 100644 --- a/include/git2/errors.h +++ b/include/git2/errors.h @@ -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 |