Skip to content
This repository has been archived by the owner. It is now read-only.

JDK-8270872: Final nroff manpage update for JDK 17 #303

Closed

Conversation

jonathan-gibbons
Copy link
Contributor

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

Please review a semi-automatic update of the nroff man pages from the upstream files.


Progress

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

Issue

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 303

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

Using diff file

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

@bridgekeeper
Copy link

@bridgekeeper bridgekeeper bot commented Aug 5, 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 label Aug 5, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Aug 5, 2021

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

  • compiler
  • core-libs
  • hotspot-jfr
  • javadoc
  • kulla
  • serviceability

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing lists. If you would like to change these labels, use the /label pull request command.

@openjdk openjdk bot added javadoc serviceability core-libs compiler kulla hotspot-jfr labels Aug 5, 2021
@mlbridge
Copy link

@mlbridge mlbridge bot commented Aug 5, 2021

Webrevs

jddarcy
jddarcy approved these changes Aug 5, 2021
@openjdk
Copy link

@openjdk openjdk bot commented Aug 5, 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:

8270872: Final nroff manpage update for JDK 17

Reviewed-by: darcy, mr, iris, naoto

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 label Aug 5, 2021
@@ -1,4 +1,4 @@
.\" Copyright (c) 2019, 2021, Oracle and/or its affiliates. All rights reserved.
.\" Copyright (c) 2019, 2020, Oracle and/or its affiliates. All rights reserved.
Copy link
Member

@naotoj naotoj Aug 5, 2021

Choose a reason for hiding this comment

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

This seems not correct?

Copy link
Contributor Author

@jonathan-gibbons jonathan-gibbons Aug 5, 2021

Choose a reason for hiding this comment

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

According to the comments in the makefile (closed/make/UpdateOpenManPages.gmk) the copyright line is taken from the original Markdown file, so if the year is wrong there, it will be wrong in the generated nroff file.

I think it would be incorrect to edit the dates locally in these files, because they'll just be overwritten when we generate the files again. Ideally, the dates should be fixed (if necessary) in the Markdown files, but that seems out of scope for this P1.

This is "just" an issue with copyright dates in source files ... and yes, while I know copyright dates are important, this problem is arguably part of an ongoing more general problem.

I note that the generated files do correctly identify themselves with 2021 in the visible output generated to the console by the man command.

Copy link
Member

@naotoj naotoj Aug 5, 2021

Choose a reason for hiding this comment

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

Thanks for the explanation, Jon. Fine by me.

Copy link
Member

@mbreinhold mbreinhold Aug 5, 2021

Choose a reason for hiding this comment

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

I agree that fixing this date is not necessary at this time.

naotoj
naotoj approved these changes Aug 5, 2021
@jonathan-gibbons
Copy link
Contributor Author

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

/integrate

@openjdk
Copy link

@openjdk openjdk bot commented Aug 5, 2021

Going to push as commit dfacda4.

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

@openjdk openjdk bot commented Aug 5, 2021

@jonathan-gibbons Pushed as commit dfacda4.

💡 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
compiler core-libs hotspot-jfr integrated javadoc kulla serviceability
5 participants