From f69e63dc5fa99277bc1e1ef6140383207be3c8ac Mon Sep 17 00:00:00 2001 From: Siying Dong Date: Fri, 24 May 2019 12:20:14 -0700 Subject: [PATCH] Improve comments in compaction.h Summary: Pull Request resolved: https://github.com/facebook/rocksdb/pull/5356 Differential Revision: D15499033 Pulled By: siying fbshipit-source-id: 069ae48669484beaf668dd90389b8743b3309dc3 --- db/compaction.h | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/db/compaction.h b/db/compaction.h index 2cf737b67..e9ded6325 100644 --- a/db/compaction.h +++ b/db/compaction.h @@ -14,6 +14,8 @@ #include "util/autovector.h" namespace rocksdb { +// The file contains class Compaction, as well as some helper functions +// and data structures used by the class. // Utility for comparing sstable boundary keys. Returns -1 if either a or b is // null which provides the property that a==null indicates a key that is less @@ -63,7 +65,7 @@ class ColumnFamilyData; class VersionStorageInfo; class CompactionFilter; -// A Compaction encapsulates information about a compaction. +// A Compaction encapsulates metadata about a compaction. class Compaction { public: Compaction(VersionStorageInfo* input_version, @@ -376,7 +378,7 @@ class Compaction { CompactionReason compaction_reason_; }; -// Utility function +// Return sum of sizes of all files in `files`. extern uint64_t TotalFileSize(const std::vector& files); } // namespace rocksdb