From ae7e64f3ea6dab4a02fbcb0d61e85c5e06ccbef9 Mon Sep 17 00:00:00 2001
From: Yaming Kuang <yaming.kuang@gmail.com>
Date: Fri, 21 Feb 2025 16:19:03 -0700
Subject: [PATCH] incorperate comment

---
 src/include/homeblks/volume_mgr.hpp | 12 +++++-------
 src/lib/homeblks_impl.hpp           |  2 +-
 src/lib/volume_mgr.cpp              |  2 +-
 3 files changed, 7 insertions(+), 9 deletions(-)

diff --git a/src/include/homeblks/volume_mgr.hpp b/src/include/homeblks/volume_mgr.hpp
index 70ebd58..427ee91 100644
--- a/src/include/homeblks/volume_mgr.hpp
+++ b/src/include/homeblks/volume_mgr.hpp
@@ -12,9 +12,6 @@ namespace homeblocks {
 ENUM(VolumeError, uint16_t, UNKNOWN = 1, INVALID_ARG, TIMEOUT, UNKNOWN_VOLUME, UNSUPPORTED_OP, CRC_MISMATCH,
      NO_SPACE_LEFT, DRIVE_WRITE_ERROR);
 
-class Volume;
-using VolumePtr = std::shared_ptr< Volume >;
-
 struct VolumeInfo {
     VolumeInfo(volume_id_t _id, uint64_t _num_bytes) : id(_id), size_bytes(_num_bytes) {}
 
@@ -30,11 +27,12 @@ struct VolumeInfo {
     auto operator==(VolumeInfo const& rhs) const { return id == rhs.id; }
 
     std::string to_string() {
-        return fmt::format("VolumeInfo: id={} size_bytes={}, page_size={}, name={}", boost::uuids::to_string(id), size_bytes,
-                           page_size, vol_name);
+        return fmt::format("VolumeInfo: id={} size_bytes={}, page_size={}, name={}", boost::uuids::to_string(id),
+                           size_bytes, page_size, vol_name);
     }
 };
 
+using VolumeInfoPtr = std::shared_ptr< VolumeInfo >;
 struct VolumeStats {
     volume_id_t id;
 
@@ -52,8 +50,8 @@ class VolumeManager : public Manager< VolumeError > {
     virtual NullAsyncResult create_volume(VolumeInfo&& volume_info) = 0;
 
     virtual NullAsyncResult remove_volume(const volume_id_t& id) = 0;
-    
-    virtual VolumePtr lookup_volume(const volume_id_t& id) = 0;
+
+    virtual VolumeInfoPtr lookup_volume(const volume_id_t& id) = 0;
 
     // TODO: read/write/unmap APIs
 
diff --git a/src/lib/homeblks_impl.hpp b/src/lib/homeblks_impl.hpp
index dd3ad8a..f2b6e8f 100644
--- a/src/lib/homeblks_impl.hpp
+++ b/src/lib/homeblks_impl.hpp
@@ -105,7 +105,7 @@ class HomeBlocksImpl : public HomeBlocks, public VolumeManager, public std::enab
 
     NullAsyncResult remove_volume(const volume_id_t& id) final;
 
-    VolumePtr lookup_volume(const volume_id_t& id) final;
+    VolumeInfoPtr lookup_volume(const volume_id_t& id) final;
 
     // see api comments in base class;
     bool get_stats(volume_id_t id, VolumeStats& stats) const final;
diff --git a/src/lib/volume_mgr.cpp b/src/lib/volume_mgr.cpp
index 5610740..a0b434f 100644
--- a/src/lib/volume_mgr.cpp
+++ b/src/lib/volume_mgr.cpp
@@ -13,7 +13,7 @@ VolumeManager::NullAsyncResult HomeBlocksImpl::create_volume(VolumeInfo&& vol_in
 
 VolumeManager::NullAsyncResult HomeBlocksImpl::remove_volume(const volume_id_t& id) { return folly::Unit(); }
 
-VolumePtr HomeBlocksImpl::lookup_volume(const volume_id_t& id) { return nullptr; }
+VolumeInfoPtr HomeBlocksImpl::lookup_volume(const volume_id_t& id) { return nullptr; }
 
 bool HomeBlocksImpl::get_stats(volume_id_t id, VolumeStats& stats) const { return true; }