Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

ARROW-15959: [Java][Docs] Improve Java dev experience with IntelliJ #13017

Closed
wants to merge 3 commits into from

Conversation

lidavidm
Copy link
Member

Update os-maven-plugin to make it work with IntelliJ, and move a test file to the proper directory. Also add some more detailed instructions.

@github-actions
Copy link

Copy link
Contributor

@lwhite1 lwhite1 left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

One minor comment, otherwise the new doc looks good.

Can you add a link in contributing.rst to this page? (and also the java/developers.rst). There is a Language Specific section with links to docs for Python, R, etc. It seems like there should be a Java section as well.


* In the Files tool window, find the path ``vector/target/generated-sources``,
right click the directory, and select Mark Directory as > Generated Sources
Root.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does it make sense to say that there's no need to mark the other generated-sourced folders as Generated Sources Root? There are, I think, five folders (under tools, plasma, format, compression, and algorithm) that are generated, but they contain only empty "annotation" folders, at least in my current build.

@lidavidm
Copy link
Member Author

Thanks for the feedback.

Re-rendered:

image

@lidavidm
Copy link
Member Author

lidavidm commented May 2, 2022

CC @davisusanibar any comments?

Settings > Build, Execution, Deployment > Compiler > Java Compiler and disable
"Use '--release' option for cross-compilation (Java 9 and later)". Otherwise
you will get an error like "package sun.misc does not exist".
* You may need to disable the ``linux-netty-native`` profile in the Maven tool
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You may need to disable the linux-netty-native or mac-netty-native profile in the Maven tool

Comment on lines +178 to +181
* In the Files tool window, find the path ``vector/target/generated-sources``,
right click the directory, and select Mark Directory as > Generated Sources
Root. There is no need to mark other generated sources directories, as only
the ``vector`` module generates sources.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

If this is needed we need to enforce "to keep a directory marked as a source root after it has been deleted/recreated through": Preferences > Build, Execution, Deployment > Build Tools > Maven > Importing > Keep source and test folders on project reload

FYI, I am not able to test this step "Mark Directory as > Generated Sources Root" on my local machine, it finished without errors.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You won't get errors until you open a file that references one of the generated classes or do an IntelliJ build (not a Maven build)

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oh, ok, thank you.

@lidavidm lidavidm closed this in 6b32c30 May 3, 2022
@lidavidm lidavidm deleted the arrow-15959 branch May 3, 2022 18:41
@ursabot
Copy link

ursabot commented May 7, 2022

Benchmark runs are scheduled for baseline = d897716 and contender = 6b32c30. 6b32c30 is a master commit associated with this PR. Results will be available as each benchmark for each run completes.
Conbench compare runs links:
[Finished ⬇️0.0% ⬆️0.0%] ec2-t3-xlarge-us-east-2
[Finished ⬇️0.43% ⬆️0.19%] test-mac-arm
[Finished ⬇️0.0% ⬆️0.0%] ursa-i9-9960x
[Finished ⬇️0.2% ⬆️0.0%] ursa-thinkcentre-m75q
Buildkite builds:
[Finished] 6b32c300 ec2-t3-xlarge-us-east-2
[Finished] 6b32c300 test-mac-arm
[Finished] 6b32c300 ursa-i9-9960x
[Finished] 6b32c300 ursa-thinkcentre-m75q
[Finished] d8977165 ec2-t3-xlarge-us-east-2
[Finished] d8977165 test-mac-arm
[Finished] d8977165 ursa-i9-9960x
[Finished] d8977165 ursa-thinkcentre-m75q
Supported benchmarks:
ec2-t3-xlarge-us-east-2: Supported benchmark langs: Python, R. Runs only benchmarks with cloud = True
test-mac-arm: Supported benchmark langs: C++, Python, R
ursa-i9-9960x: Supported benchmark langs: Python, R, JavaScript
ursa-thinkcentre-m75q: Supported benchmark langs: C++, Java

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants