You are viewing a plain text version of this content. The canonical link for it is here.
Posted to reviews@spark.apache.org by "Hisoka-X (via GitHub)" <gi...@apache.org> on 2023/03/08 04:09:57 UTC
[GitHub] [spark] Hisoka-X opened a new pull request, #40326: [SPARK-42708] [Docs] Improve doc about protobuf java file can't be indexed.
Hisoka-X opened a new pull request, #40326:
URL: https://github.com/apache/spark/pull/40326
<!--
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?
Improve README doc for developers about protobuf java file can't be indexed.
<!--
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?
To make sure developers to start spark easier.
<!--
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?
NO
<!--
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?
No
<!--
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.
-->
--
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] Hisoka-X commented on a diff in pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X commented on code in PR #40326:
URL: https://github.com/apache/spark/pull/40326#discussion_r1135456039
##########
connector/protobuf/README.md:
##########
@@ -34,3 +34,17 @@ export SPARK_PROTOC_EXEC_PATH=/path-to-protoc-exe
The user-defined `protoc` binary files can be produced in the user's compilation environment by source code compilation,
for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf).
+
+### Work with IDE
+
+#### IntelliJ IDEA
+
+If you encounter the problem that the JAVA files generated by protobuf are not indexed by IDEA,
Review Comment:
How? Should I close this PR or modify it for this?
--
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] Hisoka-X commented on pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X commented on PR #40326:
URL: https://github.com/apache/spark/pull/40326#issuecomment-1501325172
It seems that this PR change is not necessary, I will close it, thank @LuciferYang @HyukjinKwon for your review
--
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] Hisoka-X commented on a diff in pull request #40326: [SPARK-42708] [Docs] Improve doc about protobuf java file can't be indexed.
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X commented on code in PR #40326:
URL: https://github.com/apache/spark/pull/40326#discussion_r1130922230
##########
connector/protobuf/README.md:
##########
@@ -34,3 +34,17 @@ export SPARK_PROTOC_EXEC_PATH=/path-to-protoc-exe
The user-defined `protoc` binary files can be produced in the user's compilation environment by source code compilation,
for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf).
+
+### Work with IDE
Review Comment:
> On the other hand, there are many modules that use protobuf, such as core (in fact, the StoreTypes generated in the core module have exceeded the default limit of IntelliJ), connect-common, so if we need to add this one, should put it in a more general place instead of in protobuf module.
Yes, the reason why I want to add this because I find `StoreTypes` can't be indexed by default. At first I want add this in to core's README.md (but core doesn't have one), so I think add this in protobuf module not bad choice. If put this into core's README.md, I would create new README.md in core module and only describe some protobuf problems. it's weird.
--
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] HyukjinKwon commented on a diff in pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #40326:
URL: https://github.com/apache/spark/pull/40326#discussion_r1135373698
##########
connector/protobuf/README.md:
##########
@@ -34,3 +34,17 @@ export SPARK_PROTOC_EXEC_PATH=/path-to-protoc-exe
The user-defined `protoc` binary files can be produced in the user's compilation environment by source code compilation,
for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf).
+
+### Work with IDE
+
+#### IntelliJ IDEA
+
+If you encounter the problem that the JAVA files generated by protobuf are not indexed by IDEA,
Review Comment:
Hm, you could make it working by explicitly running protobuf generation step via Maven Tools dialog.
--
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] Hisoka-X commented on a diff in pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X commented on code in PR #40326:
URL: https://github.com/apache/spark/pull/40326#discussion_r1136560365
##########
connector/protobuf/README.md:
##########
@@ -34,3 +34,17 @@ export SPARK_PROTOC_EXEC_PATH=/path-to-protoc-exe
The user-defined `protoc` binary files can be produced in the user's compilation environment by source code compilation,
for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf).
+
+### Work with IDE
+
+#### IntelliJ IDEA
+
+If you encounter the problem that the JAVA files generated by protobuf are not indexed by IDEA,
Review Comment:
hi, it can generate protobuf java file, but the file also can't be indexed if not change idea setting. As @LuciferYang say, `the StoreTypes generated in the core module have exceeded the default limit of IntelliJ`. The `Spark Protobuf` module can't do anything for it.
--
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] Hisoka-X closed pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
Posted by "Hisoka-X (via GitHub)" <gi...@apache.org>.
Hisoka-X closed pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
URL: https://github.com/apache/spark/pull/40326
--
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 a diff in pull request #40326: [SPARK-42708] [Docs] Improve doc about protobuf java file can't be indexed.
Posted by "LuciferYang (via GitHub)" <gi...@apache.org>.
LuciferYang commented on code in PR #40326:
URL: https://github.com/apache/spark/pull/40326#discussion_r1130573900
##########
connector/protobuf/README.md:
##########
@@ -34,3 +34,17 @@ export SPARK_PROTOC_EXEC_PATH=/path-to-protoc-exe
The user-defined `protoc` binary files can be produced in the user's compilation environment by source code compilation,
for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf).
+
+### Work with IDE
Review Comment:
1. I'm not sure whether this item should be added.
2. On the other hand, there are many modules that use protobuf, such as `core` (in fact, the `StoreTypes `generated in the `core` module have exceeded the default limit of IntelliJ), `connect-common`, so if we need to add this one, should put it in a more general place instead of in `protobuf` module.
--
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] HyukjinKwon commented on a diff in pull request #40326: [SPARK-42708][DOCS] Improve doc about protobuf java file can't be indexed.
Posted by "HyukjinKwon (via GitHub)" <gi...@apache.org>.
HyukjinKwon commented on code in PR #40326:
URL: https://github.com/apache/spark/pull/40326#discussion_r1136365666
##########
connector/protobuf/README.md:
##########
@@ -34,3 +34,17 @@ export SPARK_PROTOC_EXEC_PATH=/path-to-protoc-exe
The user-defined `protoc` binary files can be produced in the user's compilation environment by source code compilation,
for compilation steps, please refer to [protobuf](https://github.com/protocolbuffers/protobuf).
+
+### Work with IDE
+
+#### IntelliJ IDEA
+
+If you encounter the problem that the JAVA files generated by protobuf are not indexed by IDEA,
Review Comment:
Maven Tools view. You can select the step and execute what you need to do.
--
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