From 191d30e2ac642dc441979c61780a6de4417464e0 Mon Sep 17 00:00:00 2001
From: Cheng Pan <chengpan@apache.org>
Date: Tue, 28 Sep 2021 11:10:44 +0800
Subject: [PATCH] [KYUUBI #1167][FOLLOWUP] Refine ZorderCoreBenchmark doc

<!--
Thanks for sending a pull request!

Here are some tips for you:
  1. If this is your first time, please read our contributor guidelines: https://kyuubi.readthedocs.io/en/latest/community/contributions.html
  2. If the PR is related to an issue in https://github.com/apache/incubator-kyuubi/issues, add '[KYUUBI #XXXX]' in your PR title, e.g., '[KYUUBI #XXXX] Your PR title ...'.
  3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][KYUUBI #XXXX] Your PR title ...'.
-->

### _Why are the changes needed?_
<!--
Please clarify why the changes are needed. For instance,
  1. If you add a feature, you can talk about the use case of it.
  2. If you fix a bug, you can clarify why it is a bug.
-->
Minor change, update `ZorderCoreBenchmark` doc.

### _How was this patch tested?_
- [ ] Add some test cases that check the changes thoroughly including negative and positive cases if possible

- [ ] Add screenshots for manual tests if appropriate

- [ ] [Run test](https://kyuubi.readthedocs.io/en/latest/develop_tools/testing.html#running-tests) locally before make a pull request

Closes #1172 from pan3793/t.

Closes #1167

8372a3a7 [Cheng Pan] nit
1b6ee9da [Cheng Pan] typo
bd1817a7 [Cheng Pan] [KYUUBI #1167][FOLLOWUP] Refine ZorderCoreBenchmark doc

Authored-by: Cheng Pan <chengpan@apache.org>
Signed-off-by: ulysses-you <ulyssesyou@apache.org>
---
 .../org/apache/spark/sql/ZorderCoreBenchmark.scala    | 11 +++++++----
 1 file changed, 7 insertions(+), 4 deletions(-)

diff --git a/dev/kyuubi-extension-spark-3-1/src/test/scala/org/apache/spark/sql/ZorderCoreBenchmark.scala b/dev/kyuubi-extension-spark-3-1/src/test/scala/org/apache/spark/sql/ZorderCoreBenchmark.scala
index 265bd41ba..4d43ec613 100644
--- a/dev/kyuubi-extension-spark-3-1/src/test/scala/org/apache/spark/sql/ZorderCoreBenchmark.scala
+++ b/dev/kyuubi-extension-spark-3-1/src/test/scala/org/apache/spark/sql/ZorderCoreBenchmark.scala
@@ -22,16 +22,19 @@ import org.apache.spark.sql.benchmark.KyuubiBenchmarkBase
 
 import org.apache.kyuubi.sql.zorder.ZorderBytesUtils
 
-// scalastyle:off line.size.limit
 /**
  * Benchmark to measure performance with zorder core.
  *
- * To run this benchmark:
+ * To run this benchmark, temporarily change `ignore` to `test`, then run
  * {{{
- *   ./build/mvn -Dtest=none -pl '!externals/kyuubi-download,!dev/kyuubi-codecov,!kyuubi-assembly,!kyuubi-server,!kyuubi-zookeeper,!kyuubi-hive-jdbc,!kyuubi-ha,!externals/kyuubi-spark-monitor,!kyuubi-common,!externals/kyuubi-spark-sql-engine,!kyuubi-ctl,!kyuubi-metrics' -Pspark-3.1 -DwildcardSuites=org.apache.spark.sql.ZorderCoreBenchmark -Pkyuubi-extension-spark-3-1 test
+ *   ./build/mvn clean test \
+ *   -pl dev/kyuubi-extension-spark-3-1 -am \
+ *   -Pspark-3.1,kyuubi-extension-spark-3-1 \
+ *   -Dtest=none -DwildcardSuites=org.apache.spark.sql.ZorderCoreBenchmark
  * }}}
+ *
+ * Don't forgot to restore `test` to `ignore`, because we don't want to run it in CI.
  */
-// scalastyle:on line.size.limit
 class ZorderCoreBenchmark extends KyuubiSparkSQLExtensionTest with KyuubiBenchmarkBase {
   private val numRows = 1 * 1000 * 1000