Trunk

.gitignore

@@ -1,11 +1,13 @@
 dist
 *classes
 target/
+build/
+.gradle/
 lib_managed/
 src_managed/
 project/boot/
 project/plugins/project/
-project/sbt_project_definition.iml
+patch-process/*
 .idea
 .svn
 .classpath
@@ -14,3 +16,16 @@ project/sbt_project_definition.iml
 .#*
 rat.out
 TAGS
+*.iml
+.project
+.settings
+.gradle
+kafka.ipr
+kafka.iws
+.vagrant
+Vagrantfile.local
+
+config/server-*
+config/zookeeper-*
+core/data/*
+gradle/wrapper/*

LICENSE

@@ -200,34 +200,3 @@
    WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
    See the License for the specific language governing permissions and
    limitations under the License.
-
------------------------------------------------------------------------
-
-SBT LICENSE
-
-Copyright (c) 2008, 2009, 2010 Mark Harrah, Jason Zaugg
-All rights reserved.
-
-Redistribution and use in source and binary forms, with or without
-modification, are permitted provided that the following conditions
-are met:
-1. Redistributions of source code must retain the above copyright
-   notice, this list of conditions and the following disclaimer.
-2. Redistributions in binary form must reproduce the above copyright
-   notice, this list of conditions and the following disclaimer in the
-   documentation and/or other materials provided with the distribution.
-3. The name of the author may not be used to endorse or promote products
-   derived from this software without specific prior written permission.
-
-THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND ANY EXPRESS OR
-IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES
-OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE DISCLAIMED.
-IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY DIRECT, INDIRECT,
-INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT
-NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE,
-DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY
-THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT
-(INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE OF
-THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
-
------------------------------------------------------------------------

README.md

@@ -1,81 +1,117 @@
-# Licensed to the Apache Software Foundation (ASF) under one or more
-# contributor license agreements.  See the NOTICE file distributed with
-# this work for additional information regarding copyright ownership.
-# The ASF licenses this file to You under the Apache License, Version 2.0
-# (the "License"); you may not use this file except in compliance with
-# the License.  You may obtain a copy of the License at
-#
-#    http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-# Apache Kafka #
+Apache Kafka
+=================
 See our [web site](http://kafka.apache.org) for details on the project.
 
-## Building a jar and running it ##
-1. ./gradlew copyDependantLibs
-2. ./gradlew jar
-3. Follow instuctions in http://kafka.apache.org/documentation.html#quickstart
+You need to have [gradle](http://www.gradle.org/installation) installed.
 
-## Running unit tests ##
-./gradlew test
+### First bootstrap and download the wrapper ###
+    cd kafka_source_dir
+    gradle
 
-## Forcing re-running unit tests w/o code change ##
-./gradlew cleanTest test
+Now everything else will work
 
-## Running a particular unit test ##
-./gradlew -Dtest.single=RequestResponseSerializationTest core:test
+### Building a jar and running it ###
+    ./gradlew jar  
+
+Follow instuctions in http://kafka.apache.org/documentation.html#quickstart
+
+### Building source jar ###
+    ./gradlew srcJar
+
+### Building javadocs and scaladocs ###
+    ./gradlew javadoc
+    ./gradlew javadocJar # builds a jar from the javadocs
+    ./gradlew scaladoc
+    ./gradlew scaladocJar # builds a jar from the scaladocs
+    ./gradlew docsJar # builds both javadoc and scaladoc jar
+
+### Running unit tests ###
+    ./gradlew test
+
+### Forcing re-running unit tests w/o code change ###
+    ./gradlew cleanTest test
+
+### Running a particular unit test ###
+    ./gradlew -Dtest.single=RequestResponseSerializationTest core:test
+
+### Running a particular test method within a unit test ###
+    ./gradlew core:test --tests kafka.api.test.ProducerFailureHandlingTest.testCannotSendToInternalTopic
+    ./gradlew clients:test --tests org.apache.kafka.clients.producer.MetadataTest.testMetadataUpdateWaitTime
+
+
+### Running a particular unit test with log4j output ###
+    change the log4j setting in either clients/src/test/resources/log4j.properties or core/src/test/resources/log4j.properties
+    ./gradlew -i -Dtest.single=RequestResponseSerializationTest core:test
+
+### Building a binary release gzipped tar ball ###
+    ./gradlew clean
+    ./gradlew releaseTarGz  
+    The above command will fail if you haven't set up the signing key. To bypass signing the artifact, you can run
+    ./gradlew releaseTarGz -x signArchives
 
-## Building a binary release gzipped tar ball ##
-./gradlew clean
-./gradlew releaseTarGz
 The release file can be found inside ./core/build/distributions/.
 
-## Cleaning the build ##
-./gradlew clean
+### Cleaning the build ###
+    ./gradlew clean
+
+### Running a task on a particular version of Scala (either 2.9.1, 2.9.2, 2.10.5 or 2.11.7) ###
+#### (If building a jar with a version other than 2.10, need to set SCALA_BINARY_VERSION variable or change it in bin/kafka-run-class.sh to run quick start.) ####
+    ./gradlew -PscalaVersion=2.9.1 jar
+    ./gradlew -PscalaVersion=2.9.1 test
+    ./gradlew -PscalaVersion=2.9.1 releaseTarGz
+
+### Running a task for a specific project ###
+This is for 'core', 'contrib:hadoop-consumer', 'contrib:hadoop-producer', 'examples' and 'clients'
+    ./gradlew core:jar
+    ./gradlew core:test
+
+### Listing all gradle tasks ###
+    ./gradlew tasks
+
+### Building IDE project ####
+    ./gradlew eclipse
+    ./gradlew idea
+
+### Building the jar for all scala versions and for all projects ###
+    ./gradlew jarAll
 
-## Running a task on a particular version of Scala (either 2.8.0, 2.8.2, 2.9.1, 2.9.2 or 2.10.1) ##
-## (If building a jar with a version other than 2.8.0, the scala version variable in bin/kafka-run-class.sh needs to be changed to run quick start.) ##
-./gradlew -PscalaVersion=2.9.1 jar
-./gradlew -PscalaVersion=2.9.1 test
-./gradlew -PscalaVersion=2.9.1 releaseTarGz
+### Running unit tests for all scala versions and for all projects ###
+    ./gradlew testAll
 
-## Running a task for a specific project in 'core', 'perf', 'contrib:hadoop-consumer', 'contrib:hadoop-producer', 'examples', 'clients' ##
-./gradlew core:jar
-./gradlew core:test
+### Building a binary release gzipped tar ball for all scala versions ###
+    ./gradlew releaseTarGzAll
 
-## Listing all gradle tasks ##
-./gradlew tasks
+### Publishing the jar for all version of Scala and for all projects to maven ###
+    ./gradlew uploadArchivesAll
 
-# Building IDE project ##
-./gradlew eclipse
-./gradlew idea
+Please note for this to work you should create/update `~/.gradle/gradle.properties` and assign the following variables
 
-# Building the jar for all scala versions and for all projects ##
-./gradlew jarAll
+    mavenUrl=
+    mavenUsername=
+    mavenPassword=
+    signing.keyId=
+    signing.password=
+    signing.secretKeyRingFile=
 
-## Running unit tests for all scala versions and for all projects ##
-./gradlew testAll
+### Publishing the jars without signing to a local repository ###
+    ./gradlew -Dorg.gradle.project.skipSigning=true -Dorg.gradle.project.mavenUrl=file://path/to/repo uploadArchivesAll
 
-## Building a binary release gzipped tar ball for all scala versions ##
-./gradlew releaseTarGzAll
+### Building the test jar ###
+    ./gradlew testJar
 
-## Publishing the jar for all version of Scala and for all projects to maven (To test locally, change mavenUrl in gradle.properties to a local dir.) ##
-./gradlew uploadArchivesAll
+### Determining how transitive dependencies are added ###
+    ./gradlew core:dependencies --configuration runtime
+
+### Running checkstyle on the java code ###
+    ./gradlew checkstyleMain checkstyleTest
 
-## Building the test jar ##
-./gradlew testJar
+### Running in Vagrant ###
 
-## Determining how transitive dependencies are added ##
-./gradlew core:dependencies --configuration runtime
+See [vagrant/README.md](vagrant/README.md).
 
-## Contribution ##
+### Contribution ###
 
-Kafka is a new project, and we are interested in building the community; we would welcome any thoughts or [patches](https://issues.apache.org/jira/browse/KAFKA). You can reach us [on the Apache mailing lists](http://kafka.apache.org/contact.html).
+Apache Kafka is interested in building the community; we would welcome any thoughts or [patches](https://issues.apache.org/jira/browse/KAFKA). You can reach us [on the Apache mailing lists](http://kafka.apache.org/contact.html).
 
 To contribute follow the instructions here:
  * http://kafka.apache.org/contributing.html