summaryrefslogtreecommitdiffstats
path: root/src/libnetdata/circular_buffer/README.md
diff options
context:
space:
mode:
Diffstat (limited to 'src/libnetdata/circular_buffer/README.md')
-rw-r--r--src/libnetdata/circular_buffer/README.md14
1 files changed, 14 insertions, 0 deletions
diff --git a/src/libnetdata/circular_buffer/README.md b/src/libnetdata/circular_buffer/README.md
new file mode 100644
index 000000000..b2d580cb9
--- /dev/null
+++ b/src/libnetdata/circular_buffer/README.md
@@ -0,0 +1,14 @@
+<!--
+title: "Circular Buffer"
+custom_edit_url: https://github.com/netdata/netdata/edit/master/src/libnetdata/circular_buffer/README.md
+sidebar_label: "Circular Buffer"
+learn_status: "Published"
+learn_topic_type: "Tasks"
+learn_rel_path: "Developers/libnetdata"
+-->
+
+# Circular Buffer
+
+`struct circular_buffer` is an adaptive circular buffer. It will start at an initial size
+and grow up to a maximum size as it fills. Two indices within the structure track the current
+`read` and `write` position for data.