[PATCH v6 1/7] strbuf: clarify API boundary

From: Calvin Wan <calvinwan@google.com>
Date: May 12, 2023, 17:15 UTC
Message-ID: <20230512171516.2203472-1-calvinwan@google.com>
In-Reply-To: <20230512171429.2202982-1-calvinwan@google.com>

strbuf, as a generic and widely used structure across the codebase, should be limited as a library to only interact with primitives. Add documentation so future functions can appropriately be placed. Older functions that do not follow this boundary should eventually be moved or refactored.

Signed-off-by: Calvin Wan <calvinwan@google.com>
---
 strbuf.h | 8 ++++++++
 1 file changed, 8 insertions(+)

diff --git a/strbuf.h b/strbuf.h
index 3dfeadb44c..70778c6e10 100644
--- a/strbuf.h
+++ b/strbuf.h
@@ -1,6 +1,14 @@
 #ifndef STRBUF_H
 #define STRBUF_H
 
+/*
+ * NOTE FOR STRBUF DEVELOPERS
+ *
+ * strbuf is a low-level primitive; as such it should interact only
+ * with other low-level primitives. Do not introduce new functions
+ * which interact with higher-level APIs.
+ */
+
 struct string_list;
 
 /**

-- 
2.40.1.606.ga4b1b128d6-goog