Skip to content

Commit 2a40a55

Browse files
committed
update README.kafka from kafka trunk
1 parent 67f4859 commit 2a40a55

File tree

1 file changed

+28
-4
lines changed

1 file changed

+28
-4
lines changed

README.kafka.md

Lines changed: 28 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -69,10 +69,6 @@ Generate coverage for a single module, i.e.:
6969
### Building a binary release gzipped tar ball ###
7070
./gradlew clean releaseTarGz
7171

72-
The above command will fail if you haven't set up the signing key. To bypass signing the artifact, you can run:
73-
74-
./gradlew clean releaseTarGz -x signArchives
75-
7672
The release file can be found inside `./core/build/distributions/`.
7773

7874
### Building auto generated messages ###
@@ -81,6 +77,15 @@ fail due to code changes. You can just run:
8177

8278
./gradlew processMessages processTestMessages
8379

80+
### Running a Kafka broker with ZooKeeper
81+
82+
./bin/zookeeper-server-start.sh config/zookeeper.properties
83+
./bin/kafka-server-start.sh config/server.properties
84+
85+
### Running a Kafka broker in self-managed mode
86+
87+
See [config/self-managed/README.md](https://github.com/apache/kafka/blob/trunk/config/self-managed/README.md).
88+
8489
### Cleaning the build ###
8590
./gradlew clean
8691

@@ -125,6 +130,12 @@ build directory (`${project_dir}/bin`) clashes with Kafka's scripts directory an
125130
to avoid known issues with this configuration.
126131

127132
### Publishing the jar for all version of Scala and for all projects to maven ###
133+
The recommended command is:
134+
135+
./gradlewAll publish
136+
137+
For backwards compatibility, the following also works:
138+
128139
./gradlewAll uploadArchives
129140

130141
Please note for this to work you should create/update `${GRADLE_USER_HOME}/gradle.properties` (typically, `~/.gradle/gradle.properties`) and assign the following variables
@@ -167,6 +178,12 @@ Please note for this to work you should create/update user maven settings (typic
167178

168179

169180
### Installing the jars to the local Maven repository ###
181+
The recommended command is:
182+
183+
./gradlewAll publishToMavenLocal
184+
185+
For backwards compatibility, the following also works:
186+
170187
./gradlewAll install
171188

172189
### Building the test jar ###
@@ -221,6 +238,13 @@ The following options should be set with a `-P` switch, for example `./gradlew -
221238
* `enableTestCoverage`: enables test coverage plugins and tasks, including bytecode enhancement of classes required to track said
222239
coverage. Note that this introduces some overhead when running tests and hence why it's disabled by default (the overhead
223240
varies, but 15-20% is a reasonable estimate).
241+
* `scalaOptimizerMode`: configures the optimizing behavior of the scala compiler, the value should be one of `none`, `method`, `inline-kafka` or
242+
`inline-scala` (the default is `inline-kafka`). `none` is the scala compiler default, which only eliminates unreachable code. `method` also
243+
includes method-local optimizations. `inline-kafka` adds inlining of methods within the kafka packages. Finally, `inline-scala` also
244+
includes inlining of methods within the scala library (which avoids lambda allocations for methods like `Option.exists`). `inline-scala` is
245+
only safe if the Scala library version is the same at compile time and runtime. Since we cannot guarantee this for all cases (for example, users
246+
may depend on the kafka jar for integration tests where they may include a scala library with a different version), we don't enable it by
247+
default. See https://www.lightbend.com/blog/scala-inliner-optimizer for more details.
224248

225249
### Dependency Analysis ###
226250

0 commit comments

Comments
 (0)