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

8263203: jconsole Online User Guide has wrong URL #4399

Closed
wants to merge 3 commits into from

Conversation

plummercj
Copy link
Contributor

@plummercj plummercj commented Jun 7, 2021

The URL for the users guide, referenced from both the About dialog and from the "Help -> Online Users Guide" menu item, has not functioned for a few releases due the restructuring of the JDK online docs. This PR fixes the URL. Note I also filed JDK-8268351 to get rid of the URL, but for 17 I prefer to just fix the URL.

BTW, the change to MANAGE_HOTSPOT_MBEANS_IN_COLON_ is just my editor automatically getting rid of an extra space at the end of the line.


Progress

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

Issue

  • JDK-8263203: jconsole Online User Guide has wrong URL

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4399

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Jun 7, 2021

👋 Welcome back cjplummer! 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 Jun 7, 2021
@openjdk
Copy link

openjdk bot commented Jun 7, 2021

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

  • serviceability

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 serviceability label Jun 7, 2021
@mlbridge
Copy link

mlbridge bot commented Jun 7, 2021

Webrevs

@mlchung
Copy link
Member

mlchung commented Jun 7, 2021

Hi Chris,

It has been a while but I think this may intend to link to the User Guide (not the tool reference)
https://docs.oracle.com/en/java/javase/16/management/using-jconsole.html

@plummercj
Copy link
Contributor Author

plummercj commented Jun 7, 2021

Hi Chris,

It has been a while but I think this may intend to link to the User Guide (not the tool reference)
https://docs.oracle.com/en/java/javase/16/management/using-jconsole.html

I think you are right. And there is a reference to jconsole.html from using-jconsole.html, so you can still get to it. I'll make the switch.

@plummercj
Copy link
Contributor Author

plummercj commented Jun 7, 2021

...although I'm uncertain how to get to .../management/using-jconsole.html using the "lookup" syntax as was done for getting to jconsole.html. Will need to ask someone on the docs teame.

@mlbridge
Copy link

mlbridge bot commented Jun 7, 2021

Mailing list message from Mandy Chung on serviceability-dev:

Try "using_jconsole"

Mandy

On 6/7/21 2:09 PM, Chris Plummer wrote:

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/serviceability-dev/attachments/20210607/a8880aea/attachment-0001.htm>

1 similar comment
@mlbridge
Copy link

mlbridge bot commented Jun 7, 2021

Mailing list message from Mandy Chung on serviceability-dev:

Try "using_jconsole"

Mandy

On 6/7/21 2:09 PM, Chris Plummer wrote:

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/serviceability-dev/attachments/20210607/a8880aea/attachment-0001.htm>

@plummercj
Copy link
Contributor Author

plummercj commented Jun 7, 2021

Try "using_jconsole"

I already did. No luck.

@plummercj
Copy link
Contributor Author

plummercj commented Jun 7, 2021

Actually that does work. My URL was using 17, which doesn't exist yet, but it seems to work with 16.

mlchung
mlchung approved these changes Jun 7, 2021
Copy link
Member

@mlchung mlchung left a comment

Looks good.

@openjdk
Copy link

openjdk bot commented Jun 7, 2021

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

8263203: jconsole Online User Guide has wrong URL

Reviewed-by: mchung, dholmes

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

  • 1c3932f: 8264766: ClassCastException during template compilation (Variable cannot be cast to Param)
  • f6f82c3: 8266421: Deadlock in Sound System
  • bcaa2cb: 8264144: Add handling of "--about-url" CLI parameter for RPM/DEB packages
  • ae16052: 8268088: Clarify Method::clear_jmethod_ids() related comments in ClassLoaderData::~ClassLoaderData()
  • 5ad4a91: 8268127: Shenandoah: Heap size may be too small for region to align to large page size
  • 7a37816: 8264866: Remove unneeded WorkArounds.isAutomaticModule
  • 51e8201: 8267764: jpackage cannot handle window screensaver files when EXE renamed as SCR
  • f9b593d: 8266748: Move modifiers code to Signatures.java
  • 4dd0e7e: 8259806: Clean up terminology on the "All Classes" page
  • dc6c96b: 8263468: New page for "recent" new API
  • ... and 75 more: https://git.openjdk.java.net/jdk/compare/9f05c411e6d6bdf612cf0cf8b9fe4ca9ecde50d1...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 label Jun 7, 2021
@AlanBateman
Copy link
Contributor

AlanBateman commented Jun 8, 2021

No objection to this change but I think we should create a follow-on issue to drop this link from the About page. That will also avoid needing to periodically test that the link still works.

Update: I see JDK-8268351 is created - good.

@plummercj
Copy link
Contributor Author

plummercj commented Jun 9, 2021

Thanks Mandy!

Can I get one more review please?

Copy link
Member

@dholmes-ora dholmes-ora left a comment

LGTM!

Thanks,
David

@plummercj
Copy link
Contributor Author

plummercj commented Jun 9, 2021

/integrate

@openjdk openjdk bot closed this Jun 9, 2021
@openjdk openjdk bot added integrated and removed ready labels Jun 9, 2021
@openjdk
Copy link

openjdk bot commented Jun 9, 2021

@plummercj Since your change was applied there have been 105 commits pushed to the master branch:

Your commit was automatically rebased without conflicts.

Pushed as commit bbd0313.

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

@openjdk openjdk bot removed the rfr label Jun 9, 2021
@plummercj plummercj deleted the 8263203_jconsole-url branch Dec 13, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
integrated serviceability
4 participants