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
main
Siying Dong 6 years ago committed by Facebook Github Bot
parent 596cc1547a
commit f69e63dc5f
  1. 6
      db/compaction.h

@ -14,6 +14,8 @@
#include "util/autovector.h" #include "util/autovector.h"
namespace rocksdb { 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 // 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 // null which provides the property that a==null indicates a key that is less
@ -63,7 +65,7 @@ class ColumnFamilyData;
class VersionStorageInfo; class VersionStorageInfo;
class CompactionFilter; class CompactionFilter;
// A Compaction encapsulates information about a compaction. // A Compaction encapsulates metadata about a compaction.
class Compaction { class Compaction {
public: public:
Compaction(VersionStorageInfo* input_version, Compaction(VersionStorageInfo* input_version,
@ -376,7 +378,7 @@ class Compaction {
CompactionReason compaction_reason_; CompactionReason compaction_reason_;
}; };
// Utility function // Return sum of sizes of all files in `files`.
extern uint64_t TotalFileSize(const std::vector<FileMetaData*>& files); extern uint64_t TotalFileSize(const std::vector<FileMetaData*>& files);
} // namespace rocksdb } // namespace rocksdb

Loading…
Cancel
Save