From: Matan Breizman <mbreizma@redhat.com>
Date: Mon, 1 Apr 2024 08:20:14 +0000 (+0000)
Subject: crimson/osd/object_context_loader: add comment to with_head_obc
X-Git-Tag: v19.1.1~341^2~5
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=ef6ec4ed4f3eb7bc28841ccb852542ab496ff5ae;p=ceph.git

crimson/osd/object_context_loader: add comment to with_head_obc

Signed-off-by: Matan Breizman <mbreizma@redhat.com>
(cherry picked from commit 7e208d97e83e780bb939391df674c231a5f2cad8)
---

diff --git a/src/crimson/osd/object_context_loader.cc b/src/crimson/osd/object_context_loader.cc
index 4f0e2aeff0a4..885231decda9 100644
--- a/src/crimson/osd/object_context_loader.cc
+++ b/src/crimson/osd/object_context_loader.cc
@@ -22,6 +22,10 @@ using crimson::common::local_conf;
       return get_or_load_obc<State>(obc, existed)
       .safe_then_interruptible(
         [func = std::move(func)](auto obc) {
+        // The template with_obc_func_t wrapper supports two obcs (head and clone).
+        // In the 'with_head_obc' case, however, only the head is in use.
+        // Pass the same head obc twice in order to
+        // to support the generic with_obc sturcture.
         return std::move(func)(obc, obc);
       });
     }).finally([FNAME, this, obc=std::move(obc)] {