From 1b7258fb1dd24244d5eec4b09476e382d5473624 Mon Sep 17 00:00:00 2001
From: Tim Brooks <tim@timbrooks.org>
Date: Thu, 22 Jun 2023 10:00:54 -0600
Subject: [PATCH] DOc

---
 .../java/org/elasticsearch/index/engine/InternalEngine.java    | 3 +++
 1 file changed, 3 insertions(+)

diff --git a/server/src/main/java/org/elasticsearch/index/engine/InternalEngine.java b/server/src/main/java/org/elasticsearch/index/engine/InternalEngine.java
index be945b5bd8626..55e6fd1f00f99 100644
--- a/server/src/main/java/org/elasticsearch/index/engine/InternalEngine.java
+++ b/server/src/main/java/org/elasticsearch/index/engine/InternalEngine.java
@@ -2848,6 +2848,9 @@ protected void commitIndexWriter(final IndexWriter writer, final Translog transl
         }
     }
 
+    /**
+     * Allows InternalEngine extenders to return custom key-value pairs which will be included in the Lucene commit user-data.
+     */
     protected Map<String, String> getCommitExtraUserData() {
         return Collections.emptyMap();
     }