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

8274367: Re-indent stack-trace examples for Throwable.printStackTrace #5715

Closed
wants to merge 1 commit into from

Conversation

pavelrappo
Copy link
Member

@pavelrappo pavelrappo commented Sep 27, 2021

This PR fixes indentation in the examples in the doc comment for java.lang.Throwable#printStackTrace().

  1. Indentation in stack-trace output is significant. The cause of an exception is output on the same level of indentation as that of the exception. A suppressed exception is output at a deeper level of indentation than that of the containing exception. The last example for Throwable.printStackTrace violates this.

  2. Indentation in examples for Throwable.printStackTrace that relate to suppressed exceptions is inconsistent with that of cause exceptions.


Progress

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

Issue

  • JDK-8274367: Re-indent stack-trace examples for Throwable.printStackTrace

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5715

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Sep 27, 2021

👋 Welcome back prappo! 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 Sep 27, 2021
@openjdk
Copy link

openjdk bot commented Sep 27, 2021

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

  • core-libs

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 core-libs core-libs-dev@openjdk.org label Sep 27, 2021
@mlbridge
Copy link

mlbridge bot commented Sep 27, 2021

Webrevs

@openjdk
Copy link

openjdk bot commented Sep 27, 2021

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

8274367: Re-indent stack-trace examples for Throwable.printStackTrace

Reviewed-by: mchung, iris, darcy, bpb

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

  • c4b52c7: 8271303: jcmd VM.cds {static, dynamic}_dump should print more info
  • 5b660f3: 8274392: Suppress more warnings on non-serializable non-transient instance fields in java.sql.rowset
  • 0865120: 8274345: make build-test-lib is broken
  • 75404ea: 8267636: Bump minimum boot jdk to JDK 17
  • 14100d5: 8274170: Add hooks for custom makefiles to augment jtreg test execution
  • daaa47e: 8274311: Make build.tools.jigsaw.GenGraphs more configurable
  • 2cffe4c: 8274326: [macos] Ensure initialisation of sun/lwawt/macosx/CAccessibility in JavaComponentAccessibility.m
  • 172900d: 8274255: Update javac messages to use "enum class" rather than "enum type"
  • b0983df: 8274074: SIGFPE with C2 compiled code with -XX:+StressGCM
  • 7436a77: 8274317: Unnecessary reentrant synchronized block in java.awt.Cursor

Please see this link for an up-to-date comparison between the source branch of this pull request and the master branch.
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 Sep 27, 2021
bplb
bplb approved these changes Sep 27, 2021
@pavelrappo
Copy link
Member Author

pavelrappo commented Sep 27, 2021

/integrate

@openjdk
Copy link

openjdk bot commented Sep 27, 2021

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

  • c4b52c7: 8271303: jcmd VM.cds {static, dynamic}_dump should print more info
  • 5b660f3: 8274392: Suppress more warnings on non-serializable non-transient instance fields in java.sql.rowset
  • 0865120: 8274345: make build-test-lib is broken
  • 75404ea: 8267636: Bump minimum boot jdk to JDK 17
  • 14100d5: 8274170: Add hooks for custom makefiles to augment jtreg test execution
  • daaa47e: 8274311: Make build.tools.jigsaw.GenGraphs more configurable
  • 2cffe4c: 8274326: [macos] Ensure initialisation of sun/lwawt/macosx/CAccessibility in JavaComponentAccessibility.m
  • 172900d: 8274255: Update javac messages to use "enum class" rather than "enum type"
  • b0983df: 8274074: SIGFPE with C2 compiled code with -XX:+StressGCM
  • 7436a77: 8274317: Unnecessary reentrant synchronized block in java.awt.Cursor

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot closed this Sep 27, 2021
@openjdk openjdk bot added integrated Pull request has been integrated and removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 27, 2021
@openjdk
Copy link

openjdk bot commented Sep 27, 2021

@pavelrappo Pushed as commit c880b87.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
core-libs core-libs-dev@openjdk.org integrated Pull request has been integrated
5 participants