aboutsummaryrefslogtreecommitdiff
path: root/src/lib/smartlist_core/lib_smartlist_core.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/lib/smartlist_core/lib_smartlist_core.md')
-rw-r--r--src/lib/smartlist_core/lib_smartlist_core.md10
1 files changed, 10 insertions, 0 deletions
diff --git a/src/lib/smartlist_core/lib_smartlist_core.md b/src/lib/smartlist_core/lib_smartlist_core.md
new file mode 100644
index 0000000000..c031dd6f24
--- /dev/null
+++ b/src/lib/smartlist_core/lib_smartlist_core.md
@@ -0,0 +1,10 @@
+@dir /lib/smartlist_core
+@brief lib/smartlist_core: Minimal dynamic array implementation
+
+A `smartlist_t` is a dynamic array type for holding `void *`. We use it
+throughout the rest of the codebase.
+
+There are higher-level pieces in \refdir{lib/container} but
+the ones in lib/smartlist_core are used by the logging code, and therefore
+cannot use the logging code.
+