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

8319607: FFM: Review the language in the FFM documentation #16536

Closed
wants to merge 3 commits into from

Conversation

minborg
Copy link
Contributor

@minborg minborg commented Nov 7, 2023

This PR proposes to improve the language used in the FFM specification. There is a relatively small number of corrections.

One peculiarity with the English language is the distinction between "that" (to be used in a restrictive clause) and "which" (to be used in a non-restrictive clause). Here is a reference: https://preply.com/en/blog/when-to-use-which-or-that-the-most-common-cases

Another source for updates is the difference between BE and AE where most of us Europeans were taught BE but we should use AE in the specifications.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8319607: FFM: Review the language in the FFM documentation (Sub-task - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/16536/head:pull/16536
$ git checkout pull/16536

Update a local copy of the PR:
$ git checkout pull/16536
$ git pull https://git.openjdk.org/jdk.git pull/16536/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 16536

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/16536.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Nov 7, 2023

👋 Welcome back pminborg! A progress list of the required criteria for merging this PR into master 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 Pull request is ready for review label Nov 7, 2023
@openjdk
Copy link

openjdk bot commented Nov 7, 2023

@minborg The following label will be automatically applied to this pull request:

  • core-libs

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added the core-libs core-libs-dev@openjdk.org label Nov 7, 2023
@mlbridge
Copy link

mlbridge bot commented Nov 7, 2023

Webrevs

@@ -246,7 +246,7 @@
*
* Linker implementations may optionally support additional layouts, such as <em>packed</em> struct layouts.
* A packed struct is a struct in which there is at least one member layout {@code L} that has an alignment
* constraint less strict than its natural alignment. This allows avoiding padding between member layouts,
* constraint less strict than its natural alignment. This allows for avoiding padding between member layouts,
Copy link
Contributor

Choose a reason for hiding this comment

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

IMHO this should be "allows to avoid" - it reads wrong like this :-)

@@ -343,7 +343,7 @@
* void *malloc(size_t size);
* }
*
* The {@code malloc} function allocates a region of memory of given size,
* The {@code malloc} function allocates a region of memory of a given size,
Copy link
Contributor

Choose a reason for hiding this comment

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

I'd suggest replacing "of a given size" with "with the given size"

@@ -185,12 +185,12 @@
* );
* }
*
* This layout is a struct layout which describe a rectangle. It contains a single field, namely {@code points},
* This layout is a struct layout that describe a rectangle. It contains a single field, namely {@code points},
Copy link
Contributor

Choose a reason for hiding this comment

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

"that describeS" ? Or, "describing"...

Copy link
Contributor

@mcimadamore mcimadamore left a comment

Choose a reason for hiding this comment

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

Looks good - left some minor comments

@openjdk
Copy link

openjdk bot commented Nov 7, 2023

@minborg 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:

8319607: FFM: Review the language in the FFM documentation

Reviewed-by: mcimadamore

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 6 new commits pushed to the master branch:

  • ac0ee20: 8319613: Complier error in benchmark TestLoadSegmentVarious
  • a7c0190: 8319238: JMX ThreadPoolAccTest.java is too verbose and should fail before timeout
  • 9ac6ac8: 8319559: [JVMCI] ensureLinked must be able to call Java
  • 1c0e7b7: 8319408: RISC-V: MaxVectorSize is not consistently checked in several situations
  • 74f1889: 8318678: Vector access on heap MemorySegments only works for byte[]
  • e1cae72: 8319197: Exclude hb-subset and hb-style from compilation

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

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

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 7, 2023
@minborg
Copy link
Contributor Author

minborg commented Nov 7, 2023

/integrate

@openjdk
Copy link

openjdk bot commented Nov 7, 2023

Going to push as commit ef8c840.
Since your change was applied there have been 14 commits pushed to the master branch:

  • bf9a93d: 8319204: G1: Change G1CMTask::_termination_time_ms to wallclock time
  • b2504a0: 8319525: RISC-V: Rename *_riscv64.ad files to *_riscv.ad under riscv/gc
  • bfafb27: 8319615: IGV incomplete gitignore
  • c760097: 8319541: G1: Inline G1RemoveSelfForwardsTask into RestoreRetainedRegionsTask
  • 85e4cde: 8319620: Parallel: Remove unused PSPromotionManager::*_is_full getters and setters
  • d22e368: 8319462: Signature.ClassTypeSig::classDesc() incorrect for inner class types
  • 541ff71: 8318144: Match on enum constants with body compiles but fails with MatchException
  • 42f43c5: 8319563: Reformat code in the FFM API
  • ac0ee20: 8319613: Complier error in benchmark TestLoadSegmentVarious
  • a7c0190: 8319238: JMX ThreadPoolAccTest.java is too verbose and should fail before timeout
  • ... and 4 more: https://git.openjdk.org/jdk/compare/419ed90770a13a728eae6f2317bdefe45281a461...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Nov 7, 2023
@openjdk openjdk bot closed this Nov 7, 2023
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Nov 7, 2023
@openjdk
Copy link

openjdk bot commented Nov 7, 2023

@minborg Pushed as commit ef8c840.

💡 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
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
2 participants