From 88ff80780b3ccdbf802625c8302b9e4405a09b66 Mon Sep 17 00:00:00 2001
From: Zhongyi Xie <xiez@fb.com>
Date: Fri, 24 May 2019 10:36:26 -0700
Subject: [PATCH] improve comment for WalManager (#5350)

Summary:
att
Pull Request resolved: https://github.com/facebook/rocksdb/pull/5350

Differential Revision: D15496467

Pulled By: miasantreble

fbshipit-source-id: c29c0b143bf4df2040695a82be0feb9814ddb641
---
 db/wal_manager.h | 6 ++++++
 1 file changed, 6 insertions(+)

diff --git a/db/wal_manager.h b/db/wal_manager.h
index 6caf1640c..9d5afb25d 100644
--- a/db/wal_manager.h
+++ b/db/wal_manager.h
@@ -28,6 +28,10 @@
 namespace rocksdb {
 
 #ifndef ROCKSDB_LITE
+
+// WAL manager provides the abstraction for reading the WAL files as a single
+// unit. Internally, it opens and reads the files using Reader or Writer
+// abstraction.
 class WalManager {
  public:
   WalManager(const ImmutableDBOptions& db_options,
@@ -40,6 +44,8 @@ class WalManager {
 
   Status GetSortedWalFiles(VectorLogPtr& files);
 
+  // Allow user to tail transaction log to find all recent changes to the
+  // database that are newer than `seq_number`.
   Status GetUpdatesSince(
       SequenceNumber seq_number, std::unique_ptr<TransactionLogIterator>* iter,
       const TransactionLogIterator::ReadOptions& read_options,