Update Readme with macOs specifics #10
Closed
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
macOs libclang location as well as build output differ enough to warrant specific information
|
👋 Welcome back bric3! A progress list of the required criteria for merging this PR into |
|
@bric3 This change now passes all automated pre-integration checks. After integration, the commit message for the final commit will be: You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed. At the time when this comment was updated there had been no new commits pushed to the As you do not have Committer status in this project an existing Committer must agree to sponsor your change. Possible candidates are the reviewers of this PR (@mcimadamore) but any other Committer may sponsor as well. ➡️ To flag this PR as ready for integration with the above commit message, type |
openjdk
bot
added
ready
Webrevs
|
bric3
commented
Mar 28, 2022
|
In general the changes look ok - but I wonder if this leaves things inconsistent. E.g. in the current document there's no specific description for any of the platforms involved. With your changes we go quite in a bit of details to explain how to fetch libclang for macOs users - but we leave e.g. Linux users in the dark. In general, the process of downloading an LLVM snapshot from the LLVM binary website works, I think, on every platform/OS (including macOs). The instruction you provide seem more to answer the question: what if I already have some LLVM installed (which can be true with macOs with Xcode or brew, but also on Linux e.g. with apt). |
JornVernee
reviewed
Mar 28, 2022
|
I'm also feeling a little split here. Providing many different instructions for different setups seems more likely to leave the documentation for some of them going out of date (this has been my experience with other projects). I think I'd prefer having 1 recommended way of installing LLVM, which is the LLVM release page, which we can also guarantee works. For now though, I don't mind listing the alternatives. But I'd suggest hiding them in a spoiler block (using |
|
I felt the same and wondered if a different file was needed, but the details block looks good for me. Regarding Linux (or else) I felt this was an opportunity to document these LLVM installs as well. And may improve usability. After reading your comment I think that if the build should prefer an actual download of LLVM it might be better to write a gradle task that performs the download and extraction. It should be quite ready and it might improve the deterministic aspect as the build. |
This is something we are considering, for both the JDK and libclang. |
bric3
commented
Mar 29, 2022
|
So I have enclosed the alternative local installation in a
EDIT I used an incorrect version of jtreg, I needed So now all of these pass
I don't quite know about
|
mcimadamore
reviewed
Mar 29, 2022
JornVernee
approved these changes
Mar 29, 2022
|
@JornVernee @mcimadamore If you're ok with the changes how should we proceed with this PR. I believe it needs sponsoring beforehand. |
|
Once you issue |
|
/integrate |
|
/sponsor |
|
Going to push as commit 07d81c7. |
openjdk
bot
removed
ready
|
@mcimadamore @bric3 Pushed as commit 07d81c7. 💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored. |
|
Thank you @mcimadamore @JornVernee |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
The macOs libclang location as well as build output differ enough to warrant specific information. In particular the use of the XCode based path to find the libclang is not an easy find. The output also makes use of jpackage with
app-imagetype, but the macOs .app layout different enough on macOs.Progress
Reviewers
Reviewing
Using
gitCheckout this PR locally:
$ git fetch https://git.openjdk.java.net/jextract pull/10/head:pull/10$ git checkout pull/10Update a local copy of the PR:
$ git checkout pull/10$ git pull https://git.openjdk.java.net/jextract pull/10/headUsing Skara CLI tools
Checkout this PR locally:
$ git pr checkout 10View PR using the GUI difftool:
$ git pr show -t 10Using diff file
Download this PR as a diff file:
https://git.openjdk.java.net/jextract/pull/10.diff