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.

Sign up for GitHub

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

Jump to bottom

JDK-8281082: Improve javadoc references to JOSS #7315

Closed
wants to merge 2 commits into from
Closed

JDK-8281082: Improve javadoc references to JOSS #7315

wants to merge 2 commits into from

Conversation

jddarcy
Copy link
Member

@jddarcy jddarcy commented Feb 1, 2022 •
edited by openjdk bot
Loading

The references to JOSS, the Java Object Serialization Specification, are not done consistently in the API javadoc. This should be improved.

I'll update copyright years before pushing.

Progress

  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue
  • Change must be properly reviewed

Issue

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.java.net/jdk pull/7315/head:pull/7315
$ git checkout pull/7315

Update a local copy of the PR:
$ git checkout pull/7315
$ git pull https://git.openjdk.java.net/jdk pull/7315/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 7315

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.java.net/jdk/pull/7315.diff

@bridgekeeper
Copy link

bridgekeeper bot commented Feb 1, 2022

👋 Welcome back darcy! 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 Feb 1, 2022
@openjdk
Copy link

openjdk bot commented Feb 1, 2022

@jddarcy The following labels will be automatically applied to this pull request:

  • core-libs
  • security

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

@openjdk openjdk bot added security security-dev@openjdk.org core-libs core-libs-dev@openjdk.org labels Feb 1, 2022
@mlbridge
Copy link

mlbridge bot commented Feb 1, 2022 •
edited
Loading

Webrevs

@openjdk
Copy link

openjdk bot commented Feb 1, 2022 •
edited
Loading

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

8281082: Improve javadoc references to JOSS

Reviewed-by: iris, rriggs, naoto, lancea

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

  • c74b8f4: 8275914: SHA3: changing java implementation to help C2 create high-performance code
  • a18beb4: 8280867: Cpuid1Ecx feature parsing is incorrect for AMD CPUs
  • fdd9ca7: 8280642: ObjectInputStream.readObject should throw InvalidClassException instead of IllegalAccessError
  • d95de5c: 8255495: Support CDS Archived Heap for uncompressed oops
  • bde2b37: 8279954: java/lang/StringBuffer(StringBuilder)/HugeCapacity.java intermittently fails
  • d1cc5fd: 8280941: os::print_memory_mappings() prints segment preceeding the inclusion range
  • 4532c3a: 8280554: resourcehogs/serviceability/sa/ClhsdbRegionDetailsScanOopsForG1.java can fail if GC is triggered
  • 5080e81: 8280770: serviceability/sa/ClhsdbThreadContext.java sometimes fails with 'Thread "SteadyStateThread"' missing from stdout/stderr
  • 1f6fcbe: 8278475: G1 dirty card refinement by Java threads may get unnecessarily paused
  • c5a8612: 8280458: G1: Remove G1BlockOffsetTablePart::_next_offset_threshold
  • ... and 8 more: https://git.openjdk.java.net/jdk/compare/4dbebb62aa264adda8d96a06f608ef9d13155a26...master

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 Feb 1, 2022
@jddarcy
Copy link
Member Author

jddarcy commented Feb 1, 2022

/integrate

@openjdk
Copy link

openjdk bot commented Feb 1, 2022

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

  • c74b8f4: 8275914: SHA3: changing java implementation to help C2 create high-performance code
  • a18beb4: 8280867: Cpuid1Ecx feature parsing is incorrect for AMD CPUs
  • fdd9ca7: 8280642: ObjectInputStream.readObject should throw InvalidClassException instead of IllegalAccessError
  • d95de5c: 8255495: Support CDS Archived Heap for uncompressed oops
  • bde2b37: 8279954: java/lang/StringBuffer(StringBuilder)/HugeCapacity.java intermittently fails
  • d1cc5fd: 8280941: os::print_memory_mappings() prints segment preceeding the inclusion range
  • 4532c3a: 8280554: resourcehogs/serviceability/sa/ClhsdbRegionDetailsScanOopsForG1.java can fail if GC is triggered
  • 5080e81: 8280770: serviceability/sa/ClhsdbThreadContext.java sometimes fails with 'Thread "SteadyStateThread"' missing from stdout/stderr
  • 1f6fcbe: 8278475: G1 dirty card refinement by Java threads may get unnecessarily paused
  • c5a8612: 8280458: G1: Remove G1BlockOffsetTablePart::_next_offset_threshold
  • ... and 8 more: https://git.openjdk.java.net/jdk/compare/4dbebb62aa264adda8d96a06f608ef9d13155a26...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Feb 1, 2022

@jddarcy Pushed as commit 9ca7ff3.

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

AlanBateman
AlanBateman reviewed Feb 2, 2022
View reviewed changes
src/java.base/share/classes/java/io/ObjectOutputStream.java
@@ -656,10 +656,11 @@ protected void writeStreamHeader() throws IOException {
* stream. Subclasses of ObjectOutputStream may override this method to
* customize the way in which class descriptors are written to the
* serialization stream. The corresponding method in ObjectInputStream,
* {@code readClassDescriptor}, should then be overridden to
* {@link ObjectInputStream#readClassDescriptor readClassDescriptor}, should then be overridden to
Copy link
Contributor

Choose a reason for hiding this comment

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

This makes the line lengths in this paragraph a bit inconsistent, maybe it can be re-formatted so that this one line doesn't stick out so much.

@jddarcy jddarcy deleted the JDK-8281082 branch June 10, 2023 20:17
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@AlanBateman AlanBateman AlanBateman left review comments

@irisclark irisclark irisclark approved these changes

@LanceAndersen LanceAndersen LanceAndersen approved these changes

@naotoj naotoj naotoj approved these changes

@RogerRiggs RogerRiggs RogerRiggs approved these changes

Assignees
No one assigned
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated security security-dev@openjdk.org
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@jddarcy @RogerRiggs @naotoj @LanceAndersen @AlanBateman @irisclark