X-Git-Url: https://git.opendaylight.org/gerrit/gitweb?a=blobdiff_plain;f=opendaylight%2Fmd-sal%2Fsal-akka-raft%2Fsrc%2Fmain%2Fjava%2Forg%2Fopendaylight%2Fcontroller%2Fcluster%2Fraft%2FReplicatedLog.java;h=b7c8955aad982873ee02fff78f629b7f7bc1f1b5;hb=eff56082a308f3be21cd4eefd03e0799a6b04714;hp=29d6a4557db8dde765accbfe767b9b4f8debd290;hpb=3019650e87a3fc05f80e8f6359e01ca5f1c5f197;p=controller.git

diff --git a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java
index 29d6a4557d..b7c8955aad 100644
--- a/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java
+++ b/opendaylight/md-sal/sal-akka-raft/src/main/java/org/opendaylight/controller/cluster/raft/ReplicatedLog.java
@@ -44,7 +44,10 @@ public interface ReplicatedLog {
     long lastTerm();
 
     /**
-     * Remove all the entries from the logs >= index
+     * To be called when we need to remove entries from the in-memory log.
+     * This method will remove all entries >= index. This method should be used
+     * during recovery to appropriately trim the log based on persisted
+     * information
      *
      * @param index the index of the log entry
      */
@@ -52,10 +55,14 @@ public interface ReplicatedLog {
 
 
     /**
-     * Remove all entries starting from the specified entry and persist the
-     * information to disk
+     * To be called when we need to remove entries from the in-memory log and we
+     * need that information persisted to disk. This method will remove all
+     * entries >= index.
+     * <p>
+     * The persisted information would then be used during recovery to properly
+     * reconstruct the state of the in-memory replicated log
      *
-     * @param index
+     * @param index the index of the log entry
      */
     void removeFromAndPersist(long index);