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.
pull/24376/head
Dom 2021-05-05 15:24:09 +01:00
parent f36f1efeeb
commit 14127ca13b
1 changed files with 11 additions and 11 deletions

View File

@ -500,21 +500,21 @@ pub struct WriteBufferConfig {
/// below this threshold /// below this threshold
pub buffer_size: usize, pub buffer_size: usize,
/// Write Buffer segments become read-only after crossing over this size, /// 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 /// are dropped from of memory, at least this much space will be freed from
/// the buffer. /// the buffer.
pub segment_size: usize, pub segment_size: usize,
/// What should happen if a write comes in that would exceed the Write /// 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 /// Buffer size and the oldest segment that could be dropped hasn't yet been
/// been persisted to object storage. If the oldest segment has been /// persisted to object storage. If the oldest segment has been persisted,
/// persisted, then it will be dropped from the buffer so that new writes /// then it will be dropped from the buffer so that new writes can be
/// can be accepted. This option is only for defining the behavior of what /// accepted. This option is only for defining the behaviour of what happens
/// happens if that segment hasn't been persisted. If set to return an /// if that segment hasn't been persisted. If set to return an error, new
/// error, new writes will be rejected until the oldest segment has been /// writes will be rejected until the oldest segment has been persisted so
/// persisted so that it can be cleared from memory. Alternatively, this /// that it can be cleared from memory. Alternatively, this can be set so
/// can be set so that old segments are dropped even if they haven't been /// that old segments are dropped even if they haven't been persisted. This
/// persisted. This setting is also useful for cases where persistence /// setting is also useful for cases where persistence isn't being used and
/// isn't being used and this is only for in-memory buffering. /// this is only for in-memory buffering.
pub buffer_rollover: WriteBufferRollover, pub buffer_rollover: WriteBufferRollover,
/// If set to true, buffer segments will be written to object storage. /// If set to true, buffer segments will be written to object storage.
pub store_segments: bool, pub store_segments: bool,