You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@lucene.apache.org by is...@apache.org on 2017/05/25 12:17:52 UTC

lucene-solr:branch_6x: SOLR-10004: Adding descriptions for a few classes to assess impact on smoke tester warnings

Repository: lucene-solr
Updated Branches:
  refs/heads/branch_6x 6746357b1 -> 192ca5f09


SOLR-10004: Adding descriptions for a few classes to assess impact on smoke tester warnings


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/192ca5f0
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/192ca5f0
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/192ca5f0

Branch: refs/heads/branch_6x
Commit: 192ca5f09366df9fbc748e9de3d69e343f77ec68
Parents: 6746357
Author: Ishan Chattopadhyaya <is...@apache.org>
Authored: Thu May 25 17:43:45 2017 +0530
Committer: Ishan Chattopadhyaya <is...@apache.org>
Committed: Thu May 25 17:44:19 2017 +0530

----------------------------------------------------------------------
 solr/core/src/java/org/apache/solr/update/PeerSync.java  |  6 +++++-
 .../java/org/apache/solr/update/SolrCmdDistributor.java  |  4 +++-
 solr/core/src/java/org/apache/solr/update/UpdateLog.java | 11 +++++++++--
 3 files changed, 17 insertions(+), 4 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/192ca5f0/solr/core/src/java/org/apache/solr/update/PeerSync.java
----------------------------------------------------------------------
diff --git a/solr/core/src/java/org/apache/solr/update/PeerSync.java b/solr/core/src/java/org/apache/solr/update/PeerSync.java
index 53c9076..d114f02 100644
--- a/solr/core/src/java/org/apache/solr/update/PeerSync.java
+++ b/solr/core/src/java/org/apache/solr/update/PeerSync.java
@@ -65,7 +65,11 @@ import static org.apache.solr.common.params.CommonParams.ID;
 import static org.apache.solr.update.processor.DistributedUpdateProcessor.DistribPhase.FROMLEADER;
 import static org.apache.solr.update.processor.DistributingUpdateProcessorFactory.DISTRIB_UPDATE_PARAM;
 
-/** @lucene.experimental */
+/**
+ * @lucene.experimental
+ * This class is useful for performing peer to peer synchronization of recently indexed update commands during
+ * recovery process.
+ */
 public class PeerSync implements SolrMetricProducer {
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
   private boolean debug = log.isDebugEnabled();

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/192ca5f0/solr/core/src/java/org/apache/solr/update/SolrCmdDistributor.java
----------------------------------------------------------------------
diff --git a/solr/core/src/java/org/apache/solr/update/SolrCmdDistributor.java b/solr/core/src/java/org/apache/solr/update/SolrCmdDistributor.java
index 5caf43e..26d1a02 100644
--- a/solr/core/src/java/org/apache/solr/update/SolrCmdDistributor.java
+++ b/solr/core/src/java/org/apache/solr/update/SolrCmdDistributor.java
@@ -50,7 +50,9 @@ import java.util.concurrent.ExecutorCompletionService;
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.Future;
 
-
+/**
+ * Used for distributing commands from a shard leader to its replicas.
+ */
 public class SolrCmdDistributor {
   private static final int MAX_RETRIES_ON_FORWARD = 25;
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/192ca5f0/solr/core/src/java/org/apache/solr/update/UpdateLog.java
----------------------------------------------------------------------
diff --git a/solr/core/src/java/org/apache/solr/update/UpdateLog.java b/solr/core/src/java/org/apache/solr/update/UpdateLog.java
index de9916e..9aa46b9 100644
--- a/solr/core/src/java/org/apache/solr/update/UpdateLog.java
+++ b/solr/core/src/java/org/apache/solr/update/UpdateLog.java
@@ -79,7 +79,11 @@ import static org.apache.solr.update.processor.DistributedUpdateProcessor.Distri
 import static org.apache.solr.update.processor.DistributingUpdateProcessorFactory.DISTRIB_UPDATE_PARAM;
 
 
-/** @lucene.experimental */
+/** 
+ * @lucene.experimental 
+ * This holds references to the transaction logs and pointers for the document IDs to their
+ * exact positions in the transaction logs.
+ */
 public class UpdateLog implements PluginInfoInitialized, SolrMetricProducer {
   private static final long STATUS_TIME = TimeUnit.NANOSECONDS.convert(60, TimeUnit.SECONDS);
   public static String LOG_FILENAME_PATTERN = "%s.%019d";
@@ -142,7 +146,7 @@ public class UpdateLog implements PluginInfoInitialized, SolrMetricProducer {
   /**
    * The index of the _version_ value in an entry from the transaction log.
    */
-public static final int VERSION_IDX = 1;
+  public static final int VERSION_IDX = 1;
   
   /**
    * The index of the previous pointer in an entry from the transaction log.
@@ -203,6 +207,9 @@ public static final int VERSION_IDX = 1;
     }
   };
 
+  /**
+   * Holds the query and the version for a DeleteByQuery command
+   */
   public static class DBQ {
     public String q;     // the query string
     public long version; // positive version of the DBQ