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

8252537: Updated @exception with @throws #95

Closed
wants to merge 2 commits into from

Conversation

@Vipin-Sharma
Copy link
Contributor

@Vipin-Sharma Vipin-Sharma commented Sep 9, 2020

Updated @exception with @throws for core-libs, it fixes all open sub-tasks of JDK-8252536.

Open Subtasks part of this fix are:

  1. JDK-8252537
  2. JDK-8252539
  3. JDK-8252540
  4. JDK-8252541

Previous conversation on this:
https://mail.openjdk.java.net/pipermail/core-libs-dev/2020-September/068540.html


Progress

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

Issues

Reviewers

Download

$ git fetch https://git.openjdk.java.net/jdk pull/95/head:pull/95
$ git checkout pull/95

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Sep 9, 2020

👋 Welcome back vsharma! 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 label Sep 9, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Sep 9, 2020

@Vipin-Sharma The following labels will be automatically applied to this pull request: core-libs serviceability.

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 (add|remove) "label" command.

@Vipin-Sharma
Copy link
Contributor Author

@Vipin-Sharma Vipin-Sharma commented Sep 9, 2020

/issue 8252536,8252539,8252540,8252541

@openjdk
Copy link

@openjdk openjdk bot commented Sep 9, 2020

@Vipin-Sharma
Adding additional issue to issue list: 8252536: Replace @exception with @throws for core-libs.

Adding additional issue to issue list: 8252539: Replace @exception with @throws java.rmi.activation package.

Adding additional issue to issue list: 8252540: Replace @exception with @throws java.rmi.registry package.

Adding additional issue to issue list: 8252541: Replace @exception with @throws java.rmi.server package.

@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 9, 2020

Webrevs

@mlbridge
Copy link

@mlbridge mlbridge bot commented Sep 14, 2020

Mailing list message from serguei.spitsyn at oracle.com on serviceability-dev:

An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/serviceability-dev/attachments/20200914/45376ba9/attachment.htm>

Copy link
Contributor

@RogerRiggs RogerRiggs left a comment

Please re-indent the @throws lines to add 3 spaces after so that the comments are aligned as they were previously.

Copy link
Contributor

@sspitsyn sspitsyn left a comment

I've only looked at the management files. They look good in general.

src/java.management/share/classes/java/lang/management/ClassLoadingMXBean.java

108 * @throws java.lang.SecurityException if a security manager
109 * exists and the caller does not have
110 * ManagementPermission("control").

src/java.management/share/classes/java/lang/management/MemoryMXBean.java

286 * @throws java.lang.SecurityException if a security manager
287 * exists and the caller does not have
288 * ManagementPermission("control").

Could you, please, fix the indentation?

@Vipin-Sharma
Copy link
Contributor Author

@Vipin-Sharma Vipin-Sharma commented Sep 15, 2020

@RogerRiggs I understand your point and will update PR with correct indentation.
But I think adding 3 spaces after throws may not be right for all cases.
For example when

  1. Another tag in same method is using only 1 space.
  2. In some cases (e.g. free method of Blob.java) we had a mix of throws and exception in the same method both with one space after. Here after adding 3 spaces throws tags will have the different number of spaces and indentation will not be same as before.

I will update PR to make sure the indentation looks same as before and there is no change in javadoc.
Please tell me in case my understnding is not correct here.

@RogerRiggs
Copy link
Contributor

@RogerRiggs RogerRiggs commented Sep 15, 2020

@openjdk
Copy link

@openjdk openjdk bot commented Sep 19, 2020

⚠️ @Vipin-Sharma This pull request contains merges that bring in commits not present in the target repository. Since this is not a "merge style" pull request, these changes will be squashed when this pull request in integrated. If this is your intention, then please ignore this message. If you want to preserve the commit structure, you must change the title of this pull request to Merge <project>:<branch> where <project> is the name of another project in the OpenJDK organization (for example Merge jdk:master).

@Vipin-Sharma
Copy link
Contributor Author

@Vipin-Sharma Vipin-Sharma commented Sep 19, 2020

There was something wrong with the way I updated this PR, please ignore this. I will try to correct this or will close this PR and create a new one.

@Vipin-Sharma Vipin-Sharma marked this pull request as draft Sep 19, 2020
@openjdk openjdk bot removed the rfr label Sep 19, 2020
@Vipin-Sharma Vipin-Sharma marked this pull request as ready for review Sep 19, 2020
@openjdk openjdk bot added the rfr label Sep 19, 2020
Copy link
Contributor

@sspitsyn sspitsyn left a comment

I've reviewed the management files only. They look good.

@openjdk
Copy link

@openjdk openjdk bot commented Sep 20, 2020

@Vipin-Sharma 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 more details.

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

8252537: Updated @exception with @throws
8252536: Replace @exception with @throws for core-libs
8252539: Replace @exception with @throws java.rmi.activation package
8252540: Replace @exception with @throws java.rmi.registry package
8252541: Replace @exception with @throws java.rmi.server package

Reviewed-by: rriggs, sspitsyn, 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 178 new commits pushed to the master branch:

  • 4185ed3: 5078989: Null Pointer exception in SpinnerListMode
  • 6f40a41: 8253891: Debug x86_32 builds fail after JDK-8239090
  • b9505df: 8253118: Avoid unnecessary deopts when OSR nmethods of the same level are present.
  • 3c4e824: 8249783: Simplify DerValue and DerInputStream
  • 9230c2a: 8253747: tools/jpackage/share/AppImagePackageTest.java fails with InstalledPackageSize: 0
  • cfd41c0: 8232840: java/math/BigInteger/largeMemory/SymmetricRangeTests.java fails due to "OutOfMemoryError: Requested array size exceeds VM limit"
  • 8fda5b8: 8253904: Revert Tokenizer improvements JDK-8224225
  • 60ec2a5: 8253824: Revert JDK-8253089 since VS warning C4307 has been disabled
  • 90c131f: 8224225: Tokenizer improvements
  • 9670425: 8253822: Remove unused exception_address_is_unpack_entry
  • ... and 168 more: https://git.openjdk.java.net/jdk/compare/d27835b34e713a80ff6277432f830333d5c4ea17...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.

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 (@RogerRiggs, @sspitsyn, @LanceAndersen) but any other Committer may sponsor as well.

➡️ To flag this PR as ready for integration with the above commit message, type /integrate in a new comment. (Afterwards, your sponsor types /sponsor in a new comment to perform the integration).

@openjdk openjdk bot added the ready label Sep 20, 2020
Copy link
Contributor

@LanceAndersen LanceAndersen left a comment

Overall the changes look OK. in the java.sql set of classes, please updated the modified statements to also use {@code}

* if a database access error occurs or
* this method is called on a closed <code>CallableStatement</code>
* @exception SQLFeatureNotSupportedException if <code>sqlType</code> is
* @throws SQLFeatureNotSupportedException if <code>sqlType</code> is
* a <code>ARRAY</code>, <code>BLOB</code>, <code>CLOB</code>,
* <code>DATALINK</code>, <code>JAVA_OBJECT</code>, <code>NCHAR</code>,
* <code>NCLOB</code>, <code>NVARCHAR</code>, <code>LONGNVARCHAR</code>,
Copy link
Contributor

@LanceAndersen LanceAndersen Sep 24, 2020

Please change to use {@code) as part of the update

* if a database access error occurs or
* this method is called on a closed <code>CallableStatement</code>
* @exception SQLFeatureNotSupportedException if <code>sqlType</code> is
* @throws SQLFeatureNotSupportedException if <code>sqlType</code> is
* a <code>ARRAY</code>, <code>BLOB</code>, <code>CLOB</code>,
* <code>DATALINK</code>, <code>JAVA_OBJECT</code>, <code>NCHAR</code>,
* <code>NCLOB</code>, <code>NVARCHAR</code>, <code>LONGNVARCHAR</code>,
Copy link
Contributor

@LanceAndersen LanceAndersen Sep 24, 2020

Same comment regarding {@code}

@Vipin-Sharma
Copy link
Contributor Author

@Vipin-Sharma Vipin-Sharma commented Sep 24, 2020

Overall the changes look OK. in the java.sql set of classes, please updated the modified statements to also use {@code}

Hi @LanceAndersen, it was suggested by @RogerRiggs also. I have created a separate bug JDK-8253612 to fix this for all java.sql and all other core-libs classes.
Following is earlier discussion on this.
https://mail.openjdk.java.net/pipermail/core-libs-dev/2020-September/068510.html

@LanceAndersen
Copy link
Contributor

@LanceAndersen LanceAndersen commented Sep 24, 2020

Overall the changes look OK. in the java.sql set of classes, please updated the modified statements to also use {@code}

Hi @LanceAndersen, it was suggested by @RogerRiggs also. I have created a separate bug JDK-8253612 to fix this for all java.sql and all other core-libs classes.
Following is earlier discussion on this.
https://mail.openjdk.java.net/pipermail/core-libs-dev/2020-September/068510.html

Hi Vipin, I agree overall that to replace all of places in the JDK with {@code} where needed should be a separate task with an umbrella issue with a subtask for each module. Unless there are a large number of other exceptions that are being modified and require updates for {@code} I would prefer to have it done as part of this set of changes

Copy link
Contributor

@LanceAndersen LanceAndersen left a comment

The changes look good. Thank you for addressing this.

@openjdk openjdk bot removed the ready label Sep 28, 2020
@openjdk openjdk bot added the ready label Sep 30, 2020
@rwestberg rwestberg removed the recheck label Sep 30, 2020
@Vipin-Sharma
Copy link
Contributor Author

@Vipin-Sharma Vipin-Sharma commented Oct 2, 2020

/integrate

@openjdk openjdk bot added the sponsor label Oct 2, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Oct 2, 2020

@Vipin-Sharma
Your change (at version b9ed657) is now ready to be sponsored by a Committer.

@LanceAndersen
Copy link
Contributor

@LanceAndersen LanceAndersen commented Oct 2, 2020

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Oct 2, 2020

@LanceAndersen Only the author (@Vipin-Sharma) is allowed to issue the integrate command. As this PR is ready to be sponsored, and you are an eligible sponsor, did you mean to issue the /sponsor command?

@LanceAndersen
Copy link
Contributor

@LanceAndersen LanceAndersen commented Oct 2, 2020

/sponsor

@openjdk openjdk bot closed this Oct 2, 2020
@openjdk
Copy link

@openjdk openjdk bot commented Oct 2, 2020

@LanceAndersen @Vipin-Sharma Since your change was applied there have been 185 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

Pushed as commit dffe9db.

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

dankm pushed a commit to dankm/openjdk that referenced this issue Oct 27, 2020
* Use pthread_set_name_np to set the thread name on FreeBSD

Originally authored by:	bra@fsn.hu (openjdk8)
Forward ported by:	huanghwh
Issue openjdk#95
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
5 participants