From 490559cd84e2c6639497ec67ad3cdd64bb54a7a6 Mon Sep 17 00:00:00 2001 From: Paul Lin Date: Tue, 4 Apr 2023 15:41:58 +0800 Subject: [PATCH] [KYUUBI #1652] Update docs --- docs/deployment/settings.md | 2 +- .../src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala | 4 ++-- 2 files changed, 3 insertions(+), 3 deletions(-) diff --git a/docs/deployment/settings.md b/docs/deployment/settings.md index 34bac063257..ae33f28a991 100644 --- a/docs/deployment/settings.md +++ b/docs/deployment/settings.md @@ -136,7 +136,7 @@ You can configure the Kyuubi properties in `$KYUUBI_HOME/conf/kyuubi-defaults.co | kyuubi.engine.deregister.job.max.failures | 4 | Number of failures of job before deregistering the engine. | int | 1.2.0 | | kyuubi.engine.event.json.log.path | file:///tmp/kyuubi/events | The location where all the engine events go for the built-in JSON logger. | string | 1.3.0 | | kyuubi.engine.event.loggers | SPARK | A comma-separated list of engine history loggers, where engine/session/operation etc events go. Note that: Kyuubi supports custom event handlers with the Java SPI. To register a custom event handler, the user needs to implement a subclass of `org.apache.kyuubi.events.handler.CustomEventHandlerProvider` which has a zero-arg constructor. | seq | 1.3.0 | -| kyuubi.engine.flink.application.jars | <undefined> | A semicolon-separated list of the jars to be shipped with the job to the cluster.For example SQL UDF jars. Only effective in yarn application mode. | string | 1.8.0 | +| kyuubi.engine.flink.application.jars | <undefined> | A semicolon-separated list of the jars to be shipped with the job to the cluster. For example, SQL UDF jars. Only effective in yarn application mode. | string | 1.8.0 | | kyuubi.engine.flink.extra.classpath | <undefined> | The extra classpath for the Flink SQL engine, for configuring the location of hadoop client jars, etc. Only effective in yarn session mode. | string | 1.6.0 | | kyuubi.engine.flink.java.options | <undefined> | The extra Java options for the Flink SQL engine. Only effective in yarn session mode. | string | 1.6.0 | | kyuubi.engine.flink.memory | 1g | The heap memory for the Flink SQL engine. Only effective in yarn session mode. | string | 1.6.0 | diff --git a/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala b/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala index 1a109a8f6cc..def9fb36473 100644 --- a/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala +++ b/kyuubi-common/src/main/scala/org/apache/kyuubi/config/KyuubiConf.scala @@ -2380,8 +2380,8 @@ object KyuubiConf { val ENGINE_FLINK_APPLICATION_JARS: OptionalConfigEntry[String] = buildConf("kyuubi.engine.flink.application.jars") - .doc("A semicolon-separated list of the jars to be shipped with the job to the cluster." + - "For example SQL UDF jars. Only effective in yarn application mode.") + .doc("A semicolon-separated list of the jars to be shipped with the job to the cluster. " + + "For example, SQL UDF jars. Only effective in yarn application mode.") .version("1.8.0") .stringConf .createOptional