Commit f78f6bd597bf0207a89d8defd4f0b9582830844c
2020-01-18T18:00:39
error functions: return an int Stop returning a void for functions, future-proofing them to allow them to fail.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50
diff --git a/include/git2/errors.h b/include/git2/errors.h
index 370b6ac..5c85c4d 100644
--- a/include/git2/errors.h
+++ b/include/git2/errors.h
@@ -143,8 +143,9 @@ GIT_EXTERN(void) git_error_clear(void);
* @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
+ * @return 0 on success or -1 on failure
*/
-GIT_EXTERN(void) git_error_set_str(int error_class, const char *string);
+GIT_EXTERN(int) git_error_set_str(int error_class, const char *string);
/**
* Set the error message to a special value for memory allocation failure.
diff --git a/src/errors.c b/src/errors.c
index c75f6b1..b34aa3a 100644
--- a/src/errors.c
+++ b/src/errors.c
@@ -95,19 +95,25 @@ void git_error_vset(int error_class, const char *fmt, va_list ap)
set_error_from_buffer(error_class);
}
-void git_error_set_str(int error_class, const char *string)
+int git_error_set_str(int error_class, const char *string)
{
git_buf *buf = &GIT_GLOBAL->error_buf;
assert(string);
- if (!string)
- return;
+ if (!string) {
+ git_error_set(GIT_ERROR_INVALID, "unspecified caller error");
+ return -1;
+ }
git_buf_clear(buf);
git_buf_puts(buf, string);
- if (!git_buf_oom(buf))
- set_error_from_buffer(error_class);
+
+ if (git_buf_oom(buf))
+ return -1;
+
+ set_error_from_buffer(error_class);
+ return 0;
}
void git_error_clear(void)