kafka-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From gwens...@apache.org
Subject kafka git commit: MINOR: Fix broken documentation link
Date Fri, 18 Dec 2015 00:52:34 GMT
Repository: kafka
Updated Branches:
  refs/heads/trunk 587a2f4ef -> a2a417caf


MINOR: Fix broken documentation link

The link to 'Producer Configs' section of the documentation is updated with this PR.

Author: vahidhashemian <vahidhashemian@us.ibm.com>
Author: Vahid Hashemian <vahidhashemian@us.ibm.com>

Reviewers: Gwen Shapira

Closes #692 from vahidhashemian/typo03/fix_broken_doc_link


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

Branch: refs/heads/trunk
Commit: a2a417caf9fa4f177e099fed7d2a9b8d1942a9d6
Parents: 587a2f4
Author: vahidhashemian <vahidhashemian@us.ibm.com>
Authored: Thu Dec 17 16:52:24 2015 -0800
Committer: Gwen Shapira <cshapi@gmail.com>
Committed: Thu Dec 17 16:52:24 2015 -0800

----------------------------------------------------------------------
 .../org/apache/kafka/clients/producer/KafkaProducer.java     | 8 ++++----
 .../org/apache/kafka/clients/producer/ProducerConfig.java    | 2 +-
 docs/design.html                                             | 2 +-
 3 files changed, 6 insertions(+), 6 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/kafka/blob/a2a417ca/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java
----------------------------------------------------------------------
diff --git a/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java b/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java
index 49560b5..2a75f97 100644
--- a/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java
+++ b/clients/src/main/java/org/apache/kafka/clients/producer/KafkaProducer.java
@@ -146,7 +146,7 @@ public class KafkaProducer<K, V> implements Producer<K, V>
{
 
     /**
      * A producer is instantiated by providing a set of key-value pairs as configuration.
Valid configuration strings
-     * are documented <a href="http://kafka.apache.org/documentation.html#newproducerconfigs">here</a>.
Values can be
+     * are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>.
Values can be
      * either strings or Objects of the appropriate type (for example a numeric configuration
would accept either the
      * string "42" or the integer 42).
      * @param configs   The producer configs
@@ -158,7 +158,7 @@ public class KafkaProducer<K, V> implements Producer<K, V>
{
 
     /**
      * A producer is instantiated by providing a set of key-value pairs as configuration,
a key and a value {@link Serializer}.
-     * Valid configuration strings are documented <a href="http://kafka.apache.org/documentation.html#newproducerconfigs">here</a>.
+     * Valid configuration strings are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>.
      * Values can be either strings or Objects of the appropriate type (for example a numeric
configuration would accept
      * either the string "42" or the integer 42).
      * @param configs   The producer configs
@@ -174,7 +174,7 @@ public class KafkaProducer<K, V> implements Producer<K, V>
{
 
     /**
      * A producer is instantiated by providing a set of key-value pairs as configuration.
Valid configuration strings
-     * are documented <a href="http://kafka.apache.org/documentation.html#newproducerconfigs">here</a>.
+     * are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>.
      * @param properties   The producer configs
      */
     public KafkaProducer(Properties properties) {
@@ -183,7 +183,7 @@ public class KafkaProducer<K, V> implements Producer<K, V>
{
 
     /**
      * A producer is instantiated by providing a set of key-value pairs as configuration,
a key and a value {@link Serializer}.
-     * Valid configuration strings are documented <a href="http://kafka.apache.org/documentation.html#newproducerconfigs">here</a>.
+     * Valid configuration strings are documented <a href="http://kafka.apache.org/documentation.html#producerconfigs">here</a>.
      * @param properties   The producer configs
      * @param keySerializer  The serializer for key that implements {@link Serializer}. The
configure() method won't be
      *                       called in the producer when the serializer is passed in directly.

http://git-wip-us.apache.org/repos/asf/kafka/blob/a2a417ca/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java
----------------------------------------------------------------------
diff --git a/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java b/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java
index 126d2a4..98b119b 100644
--- a/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java
+++ b/clients/src/main/java/org/apache/kafka/clients/producer/ProducerConfig.java
@@ -30,7 +30,7 @@ import static org.apache.kafka.common.config.ConfigDef.ValidString.in;
 
 /**
  * Configuration for the Kafka Producer. Documentation for these configurations can be found
in the <a
- * href="http://kafka.apache.org/documentation.html#newproducerconfigs">Kafka documentation</a>
+ * href="http://kafka.apache.org/documentation.html#producerconfigs">Kafka documentation</a>
  */
 public class ProducerConfig extends AbstractConfig {
 

http://git-wip-us.apache.org/repos/asf/kafka/blob/a2a417ca/docs/design.html
----------------------------------------------------------------------
diff --git a/docs/design.html b/docs/design.html
index 9596879..97c810b 100644
--- a/docs/design.html
+++ b/docs/design.html
@@ -114,7 +114,7 @@ The client controls which partition it publishes messages to. This can
be done a
 <p>
 Batching is one of the big drivers of efficiency, and to enable batching the Kafka producer
will attempt to accumulate data in memory and to send out larger batches in a single request.
The batching can be configured to accumulate no more than a fixed number of messages and to
wait no longer than some fixed latency bound (say 64k or 10 ms). This allows the accumulation
of more bytes to send, and few larger I/O operations on the servers. This buffering is configurable
and gives a mechanism to trade off a small amount of additional latency for better throughput.
 <p>
-Details on <a href="#newproducerconfigs">configuration</a> and <a href="http://kafka.apache.org/082/javadoc/index.html?org/apache/kafka/clients/producer/KafkaProducer.html">api</a>
for the producer can be found elsewhere in the documentation.
+Details on <a href="#producerconfigs">configuration</a> and <a href="http://kafka.apache.org/082/javadoc/index.html?org/apache/kafka/clients/producer/KafkaProducer.html">api</a>
for the producer can be found elsewhere in the documentation.
 
 <h3><a id="theconsumer" href="#theconsumer">4.5 The Consumer</a></h3>
 


Mime
View raw message