From: Calvin Wan Date: Thu, 11 May 2023 19:48:16 GMT Subject: [PATCH v5 1/7] strbuf: clarify API boundary Message-ID: <20230511194822.1493798-1-calvinwan@google.com> In-Reply-To: <20230511194446.1492907-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 --- strbuf.h | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/strbuf.h b/strbuf.h index 3dfeadb44c..0256114002 100644 --- a/strbuf.h +++ b/strbuf.h @@ -1,6 +1,15 @@ #ifndef STRBUF_H #define STRBUF_H +/* + * NOTE FOR STRBUF DEVELOPERS + * + * The objects that this API interacts with should be limited to other + * primitives, however, there are older functions in here that interact + * with non-primitive objects which should eventually be moved out or + * refactored. + */ + struct string_list; /** -- 2.40.1.606.ga4b1b128d6-goog