Skip to content

JDK-8272667: substandard error messages from the docs build #5175

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

Closed

Conversation

jonathan-gibbons
Copy link
Contributor

@jonathan-gibbons jonathan-gibbons commented Aug 18, 2021

Please review a small (delete one character) change to improve the error messages reported when bad HTML is detected when post-processing the output from pandoc to generate the docs.

The change is just to pass the filename as an argument to the command, instead of just piping the input to stdin. As a result, the name of any file containing bad input is reported in the message, instead of the message simply referring to <stdin>


Progress

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

Issue

  • JDK-8272667: substandard error messages from the docs build

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 5175

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

Using diff file

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

@bridgekeeper
Copy link

bridgekeeper bot commented Aug 18, 2021

👋 Welcome back jjg! 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 Aug 18, 2021
@openjdk
Copy link

openjdk bot commented Aug 18, 2021

@jonathan-gibbons The following label will be automatically applied to this pull request:

  • build

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 build build-dev@openjdk.org label Aug 18, 2021
@mlbridge
Copy link

mlbridge bot commented Aug 18, 2021

Webrevs

@openjdk
Copy link

openjdk bot commented Aug 18, 2021

@jonathan-gibbons 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:

8272667: substandard error messages from the docs build

Reviewed-by: darcy, iris

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 no new commits pushed to the master branch. If another commit should be pushed before you perform the /integrate command, your PR will be automatically rebased. If you prefer to avoid any potential 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 Aug 18, 2021
@jonathan-gibbons
Copy link
Contributor Author

/integrate

@openjdk
Copy link

openjdk bot commented Aug 18, 2021

Going to push as commit 6d3d479.

@openjdk openjdk bot closed this Aug 18, 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 Aug 18, 2021
@openjdk
Copy link

openjdk bot commented Aug 18, 2021

@jonathan-gibbons Pushed as commit 6d3d479.

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

@jonathan-gibbons jonathan-gibbons deleted the 8272667.docs-build branch November 18, 2022 19:04
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
build build-dev@openjdk.org integrated Pull request has been integrated
Development

Successfully merging this pull request may close these issues.

3 participants