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

8263323: Debug Agent help output includes invalid URL #4352

Closed
wants to merge 2 commits into from

Conversation

plummercj
Copy link
Contributor

@plummercj plummercj commented Jun 4, 2021

Rather than embed a URL in the help output, which needs to be updated if the location of docs ever changes, just include a description of the document so it can be looked up. The output now looks like:

$ ./java -agentlib:jdwp=help
               Java Debugger JDWP Agent Library
               --------------------------------

  (See the "Oracle VM Invocation Options" section of the JPDA
   "Connection and Invocation Details" document for more information.)

jdwp usage: java -agentlib:jdwp=[help]|[<option>=<value>, ...]

Option Name and Value            Description                       Default
---------------------            -----------                       -------
suspend=y|n                      wait on startup?                  y
transport=<name>                 transport spec                    none
...

Progress

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

Issue

  • JDK-8263323: Debug Agent help output includes invalid URL

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 4352

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

Using diff file

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Jun 4, 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 4, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Jun 4, 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 4, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Jun 4, 2021

Webrevs

@@ -859,7 +859,8 @@ printUsage(void)
" Java Debugger JDWP Agent Library\n"
" --------------------------------\n"
"\n"
" (see http://java.sun.com/products/jpda for more information)\n"
" (See the \"Oracle VM Invocation Options\" section of the JPDA\n"
Copy link
Contributor

@AlanBateman AlanBateman Jun 5, 2021

Choose a reason for hiding this comment

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

I think you can reduce to "Invocation Options" to avoid having "Oracle VM" in the usage output.

Copy link

@kevinjwalls kevinjwalls left a comment

"jpda connection and invocation" got the correct document as the first search engine hit for me.

@plummercj
Copy link
Contributor Author

@plummercj plummercj commented Jun 8, 2021

I changed "Oracle VM" to just "VM" in the debug agent help message. I also filed JDK-8268370 to fix the "Oracle VM" references in the conninv.html document.

@openjdk
Copy link

@openjdk openjdk bot commented Jun 8, 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:

8263323: Debug Agent help output includes invalid URL

Reviewed-by: kevinw, alanb

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

  • 61ab4b9: 8267564: JDK-8252971 causes SPECjbb2015 socket exceptions on Windows when MKS is installed
  • 00c88f7: 8266918: merge_stack in check_code.c add NULL check
  • 8105478: 8268165: AsyncLogging will crash if rotate() fails
  • fd91b2a: 8265440: IGV: make node selection more visible
  • 81bad59: 8257774: G1: Trigger collect when free region count drops below threshold to prevent evacuation failures
  • 341f676: 8267908: linux: thread_native_entry can scribble on stack frame
  • f40c89e: 8267209: Child threads should defer logging to after child-parent handshake
  • ae986bc: 8266749: AArch64: Backtracing broken on PAC enabled systems
  • 36c4e5f: 8267187: Remove deprecated constructor for Log
  • fc08af5: 8174222: LambdaMetafactory: validate inputs and improve documentation
  • ... and 57 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 8, 2021
@plummercj
Copy link
Contributor Author

@plummercj plummercj commented Jun 9, 2021

/integrate

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

@openjdk openjdk bot commented Jun 9, 2021

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

Your commit was automatically rebased without conflicts.

Pushed as commit 33d34c6.

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

@plummercj plummercj deleted the 8263323_jdwp-help 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
3 participants