Commit 4e8376a98cedf82f9e5f5e1acbabba031ed7130c
2021-07-30T06:34:15
Move GIT_WARN_UNUSED_RESULT from the public to the private API
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 51 52 53 54 55 56 57 58
diff --git a/include/git2/common.h b/include/git2/common.h
index a6069e3..4402dfd 100644
--- a/include/git2/common.h
+++ b/include/git2/common.h
@@ -71,24 +71,6 @@ typedef size_t size_t;
# define GIT_FORMAT_PRINTF(a,b) /* empty */
#endif
-/**
- * Declare that a function's return value must be used.
- *
- * Used mostly to guard against potential silent bugs at runtime. This is
- * recommended to be added to functions that:
- *
- * - Allocate / reallocate memory. This prevents memory leaks or errors where
- * buffers are expected to have grown to a certain size, but could not be
- * resized.
- * - Acquire locks. When a lock cannot be acquired, that will almost certainly
- * cause a data race / undefined behavior.
- */
-#if defined(__GNUC__)
-# define GIT_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
-#else
-# define GIT_WARN_UNUSED_RESULT
-#endif
-
#if (defined(_WIN32)) && !defined(__CYGWIN__)
#define GIT_WIN32 1
#endif
diff --git a/src/common.h b/src/common.h
index f83eeb6..a7c6e8e 100644
--- a/src/common.h
+++ b/src/common.h
@@ -136,6 +136,24 @@ GIT_INLINE(int) git_error__check_version(const void *structure, unsigned int exp
#define GIT_ERROR_CHECK_VERSION(S,V,N) if (git_error__check_version(S,V,N) < 0) return -1
/**
+ * Declare that a function's return value must be used.
+ *
+ * Used mostly to guard against potential silent bugs at runtime. This is
+ * recommended to be added to functions that:
+ *
+ * - Allocate / reallocate memory. This prevents memory leaks or errors where
+ * buffers are expected to have grown to a certain size, but could not be
+ * resized.
+ * - Acquire locks. When a lock cannot be acquired, that will almost certainly
+ * cause a data race / undefined behavior.
+ */
+#if defined(__GNUC__)
+# define GIT_WARN_UNUSED_RESULT __attribute__((warn_unused_result))
+#else
+# define GIT_WARN_UNUSED_RESULT
+#endif
+
+/**
* Initialize a structure with a version.
*/
GIT_INLINE(void) git__init_structure(void *structure, size_t len, unsigned int version)