From 9c846a93e84882984c0d074ebb25d62ae550be86 Mon Sep 17 00:00:00 2001 From: huming Date: Thu, 2 Jun 2022 15:03:35 +0800 Subject: [PATCH] chore(doc) --- .gitignore | 1 + pageserver/src/page_cache.rs | 2 +- pageserver/src/repository.rs | 3 ++- 3 files changed, 4 insertions(+), 2 deletions(-) diff --git a/.gitignore b/.gitignore index adb1b41503..291504ea81 100644 --- a/.gitignore +++ b/.gitignore @@ -5,6 +5,7 @@ __pycache__/ test_output/ .vscode +.idea /.zenith /integration_tests/.zenith diff --git a/pageserver/src/page_cache.rs b/pageserver/src/page_cache.rs index 0c179b95c5..716df0f749 100644 --- a/pageserver/src/page_cache.rs +++ b/pageserver/src/page_cache.rs @@ -20,7 +20,7 @@ //! assign a buffer for a page, you must hold the mapping lock and the lock on //! the slot at the same time. //! -//! Whenever you need to hold both locks simultenously, the slot lock must be +//! Whenever you need to hold both locks simultaneously, the slot lock must be //! acquired first. This consistent ordering avoids deadlocks. To look up a page //! in the cache, you would first look up the mapping, while holding the mapping //! lock, and then lock the slot. You must release the mapping lock in between, diff --git a/pageserver/src/repository.rs b/pageserver/src/repository.rs index 9d5056cd16..f687f24c6e 100644 --- a/pageserver/src/repository.rs +++ b/pageserver/src/repository.rs @@ -195,6 +195,7 @@ impl Display for TimelineSyncStatusUpdate { f.write_str(s) } } + /// /// A repository corresponds to one .zenith directory. One repository holds multiple /// timelines, forked off from the same initial call to 'initdb'. @@ -242,7 +243,7 @@ pub trait Repository: Send + Sync { /// /// 'timelineid' specifies the timeline to GC, or None for all. /// `horizon` specifies delta from last lsn to preserve all object versions (pitr interval). - /// `checkpoint_before_gc` parameter is used to force compaction of storage before CG + /// `checkpoint_before_gc` parameter is used to force compaction of storage before GC /// to make tests more deterministic. /// TODO Do we still need it or we can call checkpoint explicitly in tests where needed? fn gc_iteration(