Commit cd59e0c0 by Edward Thomson

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.
parent 04c3b35f
...@@ -126,11 +126,6 @@ GIT_EXTERN(void) giterr_clear(void); ...@@ -126,11 +126,6 @@ GIT_EXTERN(void) giterr_clear(void);
* This error message is stored in thread-local storage and only applies * This error message is stored in thread-local storage and only applies
* to the particular thread that this libgit2 call is made from. * 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 * @param error_class One of the `git_error_t` enum above describing the
* general subsystem that is responsible for the error. * general subsystem that is responsible for the error.
* @param string The formatted error message to keep * @param string The formatted error message to keep
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment