diff options
| author | Calvin Wan <calvinwan@google.com> | 2023-06-06 19:48:37 +0000 |
|---|---|---|
| committer | Junio C Hamano <gitster@pobox.com> | 2023-06-12 13:49:35 -0700 |
| commit | 4557779660924843a3645694e5295a71a07a7fe2 (patch) | |
| tree | af2ec760a8901a1de1f4be8dbe2bcabb75a4b386 | |
| parent | fe86abd7511a9a6862d5706c6fa1d9b57a63ba09 (diff) | |
| download | git-4557779660924843a3645694e5295a71a07a7fe2.tar.gz | |
strbuf: clarify API boundary
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>
Signed-off-by: Junio C Hamano <gitster@pobox.com>
| -rw-r--r-- | strbuf.h | 8 |
1 files changed, 8 insertions, 0 deletions
@@ -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; /** |