You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@kafka.apache.org by gu...@apache.org on 2015/08/06 01:32:56 UTC

kafka git commit: MINOR: auto.offset.reset docs not in sync with validation

Repository: kafka
Updated Branches:
  refs/heads/trunk 95c626dc0 -> 4b798f0de


MINOR: auto.offset.reset docs not in sync with validation

In this commit https://github.com/apache/kafka/commit/0699ff2ce60abb466cab5315977a224f1a70a4da#diff-5533ddc72176acd1c32f5abbe94aa672 among other things auto.offset.reset possible options were changed from smallest to earliest and from largest to latest, but not in documentation for that configuration property.

This patch fixes documentation for auto.offset.reset consumer configuration property so it is in sync with validation logic.

Author: Stevo Slavić <ss...@gmail.com>

Reviewers: Jason, Ismael, Guozhang

Closes #91 from sslavic/patch-5 and squashes the following commits:

f4c9656 [Stevo Slavić] MINOR: auto.offset.reset docs not in sync with validation


Project: http://git-wip-us.apache.org/repos/asf/kafka/repo
Commit: http://git-wip-us.apache.org/repos/asf/kafka/commit/4b798f0d
Tree: http://git-wip-us.apache.org/repos/asf/kafka/tree/4b798f0d
Diff: http://git-wip-us.apache.org/repos/asf/kafka/diff/4b798f0d

Branch: refs/heads/trunk
Commit: 4b798f0dee004ac6b96ff563a0e2df65e016c694
Parents: 95c626d
Author: Stevo Slavić <ss...@gmail.com>
Authored: Wed Aug 5 16:33:55 2015 -0700
Committer: Guozhang Wang <wa...@gmail.com>
Committed: Wed Aug 5 16:33:55 2015 -0700

----------------------------------------------------------------------
 .../java/org/apache/kafka/clients/consumer/ConsumerConfig.java     | 2 +-
 1 file changed, 1 insertion(+), 1 deletion(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/4b798f0d/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
----------------------------------------------------------------------
diff --git a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
index 70377ae..8adabb6 100644
--- a/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
+++ b/clients/src/main/java/org/apache/kafka/clients/consumer/ConsumerConfig.java
@@ -77,7 +77,7 @@ public class ConsumerConfig extends AbstractConfig {
      * <code>auto.offset.reset</code>
      */
     public static final String AUTO_OFFSET_RESET_CONFIG = "auto.offset.reset";
-    private static final String AUTO_OFFSET_RESET_DOC = "What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted): <ul><li>smallest: automatically reset the offset to the smallest offset<li>largest: automatically reset the offset to the largest offset</li><li>none: throw exception to the consumer if no previous offset is found for the consumer's group</li><li>anything else: throw exception to the consumer.</li></ul>";
+    private static final String AUTO_OFFSET_RESET_DOC = "What to do when there is no initial offset in Kafka or if the current offset does not exist any more on the server (e.g. because that data has been deleted): <ul><li>earliest: automatically reset the offset to the earliest offset<li>latest: automatically reset the offset to the latest offset</li><li>none: throw exception to the consumer if no previous offset is found for the consumer's group</li><li>anything else: throw exception to the consumer.</li></ul>";
 
     /**
      * <code>fetch.min.bytes</code>