From 14127ca13b0097e63b27741e38d1199bc843e895 Mon Sep 17 00:00:00 2001
From: Dom <dom@itsallbroken.com>
Date: Wed, 5 May 2021 15:24:09 +0100
Subject: [PATCH] docs: fix greater than / less than comment
Segments will always be less-than-or-equal-to the configured maximum
size, not greater-than-or-equal-to.
---
data_types/src/database_rules.rs | 22 +++++++++++-----------
1 file changed, 11 insertions(+), 11 deletions(-)
diff --git a/data_types/src/database_rules.rs b/data_types/src/database_rules.rs
index 1fb805effe..225e809f90 100644
--- a/data_types/src/database_rules.rs
+++ b/data_types/src/database_rules.rs
@@ -500,21 +500,21 @@ pub struct WriteBufferConfig {
/// below this threshold
pub buffer_size: usize,
/// Write Buffer segments become read-only after crossing over this size,
- /// which means that segments will always be >= this size. When old segments
+ /// which means that segments will always be <= this size. When old segments
/// are dropped from of memory, at least this much space will be freed from
/// the buffer.
pub segment_size: usize,
/// What should happen if a write comes in that would exceed the Write
- /// Buffer size and the oldest segment that could be dropped hasn't yet
- /// been persisted to object storage. If the oldest segment has been
- /// persisted, then it will be dropped from the buffer so that new writes
- /// can be accepted. This option is only for defining the behavior of what
- /// happens if that segment hasn't been persisted. If set to return an
- /// error, new writes will be rejected until the oldest segment has been
- /// persisted so that it can be cleared from memory. Alternatively, this
- /// can be set so that old segments are dropped even if they haven't been
- /// persisted. This setting is also useful for cases where persistence
- /// isn't being used and this is only for in-memory buffering.
+ /// Buffer size and the oldest segment that could be dropped hasn't yet been
+ /// persisted to object storage. If the oldest segment has been persisted,
+ /// then it will be dropped from the buffer so that new writes can be
+ /// accepted. This option is only for defining the behaviour of what happens
+ /// if that segment hasn't been persisted. If set to return an error, new
+ /// writes will be rejected until the oldest segment has been persisted so
+ /// that it can be cleared from memory. Alternatively, this can be set so
+ /// that old segments are dropped even if they haven't been persisted. This
+ /// setting is also useful for cases where persistence isn't being used and
+ /// this is only for in-memory buffering.
pub buffer_rollover: WriteBufferRollover,
/// If set to true, buffer segments will be written to object storage.
pub store_segments: bool,