rust/neon
1
0
Fork 0
mirror of https://github.com/neondatabase/neon.git synced 2026-05-18 05:30:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

doc: more comment on lru_candidates to address questions from review

Browse Source
This commit is contained in:
Christian Schwarz
2023-03-28 11:53:48 +02:00
parent 42d63270a5
commit 0428b6822a
1 changed files with 6 additions and 0 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
pageserver/src/disk_usage_eviction_task.rs
View File

@@ -488,6 +488,12 @@ enum Mode {
/// Figure out eviction candidates for the given tenant and append them to `lru_candidates`.
///
/// The `mode` argument controls which layers get appended to `lru_candidates`.
/// Read its type's doc comments for more details.
///
/// The caller is responsible for sorting `lru_candidates` once it has called this function
/// for all tenants.
///
/// The `scratch` vector is temporary storage and taken as an argument to avoid allocations.
/// It must be empty when calling this function. It is guaranteed to be empty when we
/// return `ControlFlow::Continue`.