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

Refresh panama documents to reflect API changes #535

Closed
wants to merge 10 commits into from

Conversation

@mcimadamore
Copy link
Collaborator

@mcimadamore mcimadamore commented May 12, 2021

This patch tweaks the foreign memory access/linker documents to reflect the various changes in the API. Most notable changes are:

  • The name of many static factories (e.g. layouts) has changed
  • We dropped MemorySegment::allocate variants which do not accept a scope

I've also dropped the html version of said documents - since I believe the github rendering to be good enough (and, we refer to the github pages hosting these docs from other places anyway).


Progress

  • Change must not contain extraneous whitespace
  • Change must be properly reviewed

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/panama-foreign pull/535/head:pull/535
$ git checkout pull/535

Update a local copy of the PR:
$ git checkout pull/535
$ git pull https://git.openjdk.java.net/panama-foreign pull/535/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 535

View PR using the GUI difftool:
$ git pr show -t 535

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/panama-foreign/pull/535.diff

mcimadamore and others added 4 commits May 11, 2021
Fix footnote on memory access doc
* Fix parallel processing example
* drop html version of documents
@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented May 12, 2021

👋 Welcome back mcimadamore! A progress list of the required criteria for merging this PR into foreign-jextract will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

@openjdk openjdk bot added the rfr label May 12, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented May 12, 2021

Copy link
Member

@JornVernee JornVernee left a comment

LGTM

@openjdk
Copy link

@openjdk openjdk bot commented May 12, 2021

@mcimadamore This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

Refresh panama documents to reflect API changes

Reviewed-by: jvernee

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 foreign-jextract branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the foreign-jextract branch, type /integrate in a new comment.

@openjdk openjdk bot added the ready label May 12, 2021
@mcimadamore
Copy link
Collaborator Author

@mcimadamore mcimadamore commented May 12, 2021

/integrate

@openjdk openjdk bot closed this May 12, 2021
@openjdk openjdk bot added integrated and removed ready rfr labels May 12, 2021
@openjdk
Copy link

@openjdk openjdk bot commented May 12, 2021

@mcimadamore Pushed as commit 0d3f2f5.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
2 participants