You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "LuciferYang (via GitHub)" <gi...@apache.org> on 2023/09/26 14:17:06 UTC
[GitHub] [spark] LuciferYang opened a new pull request, #43131: [SPARK-45341]Correct the title level in the comments of KVStore.java to make sbt doc run successfully with Java 17
LuciferYang opened a new pull request, #43131:
URL: https://github.com/apache/spark/pull/43131
<!--
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://spark.apache.org/contributing.html
2. Ensure you have added or run the appropriate tests for your PR: https://spark.apache.org/developer-tools.html
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP][SPARK-XXXX] Your PR title ...'.
4. Be sure to keep the PR description updated to reflect all changes.
5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a faster review.
7. If you want to add a new configuration, please read the guideline first for naming configurations in
'core/src/main/scala/org/apache/spark/internal/config/ConfigEntry.scala'.
8. If you want to add or modify an error type or message, please read the guideline first in
'core/src/main/resources/error/README.md'.
-->
### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster reviews in your PR. See the examples below.
1. If you refactor some codes with changing classes, showing the class hierarchy will help reviewers.
2. If you fix some SQL features, you can provide some references of other DBMSes.
3. If there is design documentation, please add the link.
4. If there is a discussion in the mailing list, please add the link.
-->
### Why are the changes needed?
<!--
Please clarify why the changes are needed. For instance,
1. If you propose a new API, clarify the use case for a new API.
2. If you fix a bug, you can clarify why it is a bug.
-->
### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such as the documentation fix.
If yes, please clarify the previous behavior and the change this PR proposes - provide the console output, description and/or an example to show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change compared to the released Spark versions or within the unreleased branches such as master.
If no, write 'No'.
-->
### How was this patch tested?
<!--
If tests were added, say they were added here. Please make sure to add some test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested step by step, ideally copy and paste-able, so that other reviewers can test and check, and descendants can verify in the future.
If tests were not added, please describe why they were not added and/or why it was difficult to add.
If benchmark tests were added, please run the benchmarks in GitHub Actions for the consistent environment, and the instructions could accord to: https://spark.apache.org/developer-tools.html#github-workflow-benchmarks.
-->
### Was this patch authored or co-authored using generative AI tooling?
<!--
If generative AI tooling has been used in the process of authoring this patch, please include the
phrase: 'Generated-by: ' followed by the name of the tool and its version.
If no, write 'No'.
Please refer to the [ASF Generative Tooling Guidance](https://www.apache.org/legal/generative-tooling.html) for details.
-->
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make sbt doc run successfully with Java 17
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43131:
URL: https://github.com/apache/spark/pull/43131#issuecomment-1736528395
@dongjoon-hyun we can test as follows
```
build/mvn javadoc:javadoc -pl common/kvstore -am
```
then we can see
```
[ERROR] Failed to execute goal org.apache.maven.plugins:maven-javadoc-plugin:3.5.0:javadoc (default-cli) on project spark-kvstore_2.13: An error has occurred in Javadoc report generation:
[ERROR] Exit code: 1
[ERROR] 正在加载程序包org.apache.spark.util.kvstore的源文件...
[ERROR] 正在构造 Javadoc 信息...
[ERROR] 正在构建所有程序包和类的索引...
[ERROR] 标准 Doclet 版本 17.0.8+7-LTS
[ERROR] 正在构建所有程序包和类的树...
[ERROR] /Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/src/main/java/org/apache/spark/util/kvstore/KVStore.java:32: 错误: 使用的标题超出序列：<H3>（与隐式前导标题相比：<H1>）
[ERROR] * <h3>Serialization</h3>
[ERROR] ^
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/InMemoryStore.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/KVIndex.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/KVStore.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/KVStoreIterator.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/KVStoreSerializer.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/KVStoreView.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/KVTypeInfo.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/LevelDB.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/LevelDB.TypeAliases.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/RocksDB.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/RocksDB.TypeAliases.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/UnsupportedStoreVersionException.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/package-summary.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/package-tree.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/constant-values.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/serialized-form.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/KVIndex.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/InMemoryStore.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/RocksDB.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/RocksDB.TypeAliases.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/UnsupportedStoreVersionException.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/LevelDB.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/LevelDB.TypeAliases.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/KVStoreIterator.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/KVStore.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/KVStoreView.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/KVTypeInfo.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/class-use/KVStoreSerializer.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/org/apache/spark/util/kvstore/package-use.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/overview-tree.html...
[ERROR] 正在构建所有类的索引...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/allclasses-index.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/allpackages-index.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/index-all.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/index.html...
[ERROR] 正在生成/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs/help-doc.html...
[ERROR] 注: 可能覆盖将来的标准标记的定制标记: @todo, @note, @tparam, @constructor, @groupname, @example, @group。为了避免出现可能的覆盖, 请在定制标记名称中至少使用一个句点字符 (.)。
[ERROR] 注: 找不到的定制标记: @todo, @note, @tparam, @constructor, @groupname, @example, @group
[ERROR] 1 个错误
[ERROR] Command line was: /Users/yangjie01/Tools/zulu17/zulu-17.jdk/Contents/Home/bin/javadoc -Xdoclint:all -Xdoclint:-missing @options @packages
[ERROR]
[ERROR] Refer to the generated Javadoc files in '/Users/yangjie01/SourceCode/git/spark-mine-13/common/kvstore/target/site/apidocs' dir.
[ERROR]
[ERROR] -> [Help 1]
[ERROR]
[ERROR] To see the full stack trace of the errors, re-run Maven with the -e switch.
[ERROR] Re-run Maven using the -X switch to enable full debug logging.
[ERROR]
[ERROR] For more information about the errors and possible solutions, please read the following articles:
[ERROR] [Help 1] http://cwiki.apache.org/confluence/display/MAVEN/MojoExecutionException
[ERROR]
[ERROR] After correcting the problems, you can resume the build with the command
[ERROR] mvn <args> -rf :spark-kvstore_2.13
```
Sorry, there are some non-English characters in the compilation log.
In GitHub Action, we run "mvn install", but the "mvn install" command does not execute "javadoc:javadoc" by default. This is because "javadoc:javadoc" belongs to the site lifecycle phase, and the install lifecycle phase comes before site. A simple fix would be to change the execution command to "mvn install javadoc:javadoc" for additional checks.
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make sbt doc run successfully with Java 17
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43131:
URL: https://github.com/apache/spark/pull/43131#issuecomment-1735657447
Since Github Action is checking `sbt unidoc`, this issue was not exposed. cc @srowen @HyukjinKwon @dongjoon-hyun FYI
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make sbt doc run successfully with Java 17
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43131:
URL: https://github.com/apache/spark/pull/43131#issuecomment-1736529252
I create a new jira SPARK-45348 and will give a pr later
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] srowen closed pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make `sbt doc` run successfully with Java 17
Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen closed pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make `sbt doc` run successfully with Java 17
URL: https://github.com/apache/spark/pull/43131
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] srowen commented on pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make `sbt doc` run successfully with Java 17
Posted by "srowen (via GitHub)" <gi...@apache.org>.
srowen commented on PR #43131:
URL: https://github.com/apache/spark/pull/43131#issuecomment-1737388105
Merged to master
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org
[GitHub] [spark] LuciferYang commented on pull request #43131: [SPARK-45341][CORE] Correct the title level in the comments of KVStore.java to make sbt doc run successfully with Java 17
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on PR #43131:
URL: https://github.com/apache/spark/pull/43131#issuecomment-1736503271
> I'm just curious why this is SBT issue?
>
> This javadoc issue should happen in Maven because we have the following.
>
> https://github.com/apache/spark/blob/ea3104fa71b0d7b6ac5e74292c28e40acb1e6537/pom.xml#L3187-L3188
An interesting question, the maven build indeed did not throw any errors, I can't provide an answer right now, need to investigate it for maven
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For queries about this service, please contact Infrastructure at:
users@infra.apache.org
---------------------------------------------------------------------
To unsubscribe, e-mail: reviews-unsubscribe@spark.apache.org
For additional commands, e-mail: reviews-help@spark.apache.org