Skip to content
This repository has been archived by the owner on Sep 19, 2023. It is now read-only.
/ jdk21 Public archive

8309595: Allow javadoc to process unnamed classes #1

Closed

Conversation

JimLaskey
Copy link
Member

@JimLaskey JimLaskey commented Jun 8, 2023

Unnamed classes are rejected by javadoc because they are synthetic.


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-8309595: Allow javadoc to process unnamed classes (Bug - P3)

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 1

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk21/pull/1.diff

Webrev

Link to Webrev Comment

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 8, 2023

👋 Welcome back jlaskey! 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 changed the title Backport 0be39054a631f282acc7ea05b2d98878a2b250bf 8309595: Allow javadoc to process unnamed classes Jun 8, 2023
@openjdk
Copy link

openjdk bot commented Jun 8, 2023

This backport pull request has now been updated with issue from the original commit.

@openjdk openjdk bot added backport clean rfr Pull request is ready for review labels Jun 8, 2023
@openjdk
Copy link

openjdk bot commented Jun 8, 2023

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

  • javadoc

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 javadoc javadoc-dev@openjdk.org label Jun 8, 2023
@mlbridge
Copy link

mlbridge bot commented Jun 8, 2023

Webrevs

import javadoc.tester.JavadocTester;
import toolbox.ToolBox;

public class Unnamed extends JavadocTester {

Choose a reason for hiding this comment

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

As a matter of style, tests are typically in a class whose name begins Test in a directory whose name begins test.

Copy link
Member

Choose a reason for hiding this comment

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

Since this is a clean backport of a fix that went into JDK mainline, do you want it changed only in the Backport?

Copy link
Member Author

Choose a reason for hiding this comment

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

Would it be satisfactory to address this in mainline and also backport that change?

Copy link
Member

Choose a reason for hiding this comment

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

That seems best

@JimLaskey
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Jun 20, 2023

@JimLaskey This pull request has not yet been marked as ready for integration.

@@ -0,0 +1,82 @@
/*
* Copyright (c) 2017, Oracle and/or its affiliates. All rights reserved.
Copy link
Member

Choose a reason for hiding this comment

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

Is it really 2017 or an unfortunate copy-paste from some other test?

@openjdk
Copy link

openjdk bot commented Jun 20, 2023

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

8309595: Allow javadoc to process unnamed classes

Reviewed-by: prappo

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

  • ede16cd: 8310314: Misplaced "unnamed classes are a preview feature and are disabled by default" error
  • 08965e6: 8310259: Pin msys2/setup-msys2 github action to a specific commit
  • e0d3706: 8304835: jdk/jfr/event/oldobject/TestArrayInformation.java fails with "Could not find event with class ... as (leak) object"
  • 14c5091: 8310015: ZGC: Unbounded asynchronous unmapping can lead to running out of address space
  • 36e3fe9: 8309928: JFR: View issues
  • 4d81b89: 8309960: ParallelGC young collections very slow in DelayInducer
  • ace5623: 8308643: Incorrect value of 'used' jvmstat counter
  • 3698a02: 8309756: Occasional crashes with pipewire screen capture on Wayland
  • a1c1d97: 8309632: JDK 21 RDP1 L10n resource files update
  • aced114: 8310128: Switch with unnamed patterns erroneously non-exhaustive
  • ... and 17 more: https://git.openjdk.org/jdk21/compare/bb377b26730f3d9da7c76e0d171517e811cef3ce...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 Jun 20, 2023
@JimLaskey
Copy link
Member Author

/integrate

@openjdk
Copy link

openjdk bot commented Jun 20, 2023

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

  • ede16cd: 8310314: Misplaced "unnamed classes are a preview feature and are disabled by default" error
  • 08965e6: 8310259: Pin msys2/setup-msys2 github action to a specific commit
  • e0d3706: 8304835: jdk/jfr/event/oldobject/TestArrayInformation.java fails with "Could not find event with class ... as (leak) object"
  • 14c5091: 8310015: ZGC: Unbounded asynchronous unmapping can lead to running out of address space
  • 36e3fe9: 8309928: JFR: View issues
  • 4d81b89: 8309960: ParallelGC young collections very slow in DelayInducer
  • ace5623: 8308643: Incorrect value of 'used' jvmstat counter
  • 3698a02: 8309756: Occasional crashes with pipewire screen capture on Wayland
  • a1c1d97: 8309632: JDK 21 RDP1 L10n resource files update
  • aced114: 8310128: Switch with unnamed patterns erroneously non-exhaustive
  • ... and 17 more: https://git.openjdk.org/jdk21/compare/bb377b26730f3d9da7c76e0d171517e811cef3ce...master

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Jun 20, 2023

@JimLaskey Pushed as commit bfffd8b.

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

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
backport clean integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org
4 participants