Skip to content

8350137: After JDK-8348975, Linux builds contain man pages for windows only tools #23697

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
wants to merge 2 commits into from

Conversation

nizarbenalla
Copy link
Member

@nizarbenalla nizarbenalla commented Feb 19, 2025

This patch fixes a regression where the windows tools man pages appeared on the Linux and the MacOS builds

The man pages found using FindModuleManDirs were used in both Docs.gmk used to generate the documentation for the JDK as well as in LauncherCommon.gmk here

MAN_FILES_MD := $(wildcard $(addsuffix /*.md, $(call FindModuleManDirs, $(MODULE))))

I've separated the logic between generated the docs and the man pages. I've checked on a MacOs machine and the man pages no longer appear.


Progress

  • Change must be properly reviewed (1 review required, with at least 1 Reviewer)
  • Change must not contain extraneous whitespace
  • Commit message must refer to an issue

Issue

  • JDK-8350137: After JDK-8348975, Linux builds contain man pages for windows only tools (Bug - P4)

Reviewers

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/23697/head:pull/23697
$ git checkout pull/23697

Update a local copy of the PR:
$ git checkout pull/23697
$ git pull https://git.openjdk.org/jdk.git pull/23697/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 23697

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

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/23697.diff

Using Webrev

Link to Webrev Comment

@nizarbenalla nizarbenalla changed the title 8350137 After JDK-8348975, Linux builds contain man pages for windows only tools 8350137: After JDK-8348975, Linux builds contain man pages for windows only tools Feb 19, 2025
@bridgekeeper
Copy link

bridgekeeper bot commented Feb 19, 2025

👋 Welcome back nbenalla! 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
Copy link

openjdk bot commented Feb 19, 2025

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

8350137: After JDK-8348975, Linux builds contain man pages for windows only tools

Reviewed-by: erikj

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

  • 7631984: 8349923: Refactor StackMapTable constructor and StackMapReader
  • 3487f8c: 8350102: Decouple jpackage test-lib Executor.Result and Executor classes
  • 70a6c0b: 8346094: Harden X509CertImpl.getExtensionValue for NPE cases
  • efbad00: 8349688: G1: Wrong initial optional region index when selecting candidates from retained regions
  • c6e47fd: 8348171: Refactor GenerationCounters and its subclasses

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
Copy link

openjdk bot commented Feb 19, 2025

@nizarbenalla 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 Feb 19, 2025
@nizarbenalla nizarbenalla marked this pull request as ready for review February 19, 2025 15:10
@openjdk openjdk bot added the rfr Pull request is ready for review label Feb 19, 2025
@mlbridge
Copy link

mlbridge bot commented Feb 19, 2025

Webrevs

MAN_SUBDIRS += share/man windows/man
MAN_SUBDIRS += share/man $(TARGET_OS)/man

MAN_DOCS_SUBDIRS += share/man windows/man
Copy link
Member

Choose a reason for hiding this comment

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

I think this warrants a comment explaining why we need a separate list.

Suggested change
MAN_DOCS_SUBDIRS += share/man windows/man
# The docs should include the sum of all man pages for all platforms
MAN_DOCS_SUBDIRS += share/man windows/man

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Feb 19, 2025
@nizarbenalla
Copy link
Member Author

Thanks for reviewing Erik.

/integrate

@openjdk
Copy link

openjdk bot commented Feb 20, 2025

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

  • 10bf48a: 8350214: Test gtest/AsyncLogGtest.java fails after JDK-8349755
  • 960ad21: 8349620: Add VMProps for static JDK
  • 735805d: 8349727: [PPC] C1: Improve Class.isInstance intrinsic
  • 1e87ff0: 8348936: [Accessibility,macOS,VoiceOver] VoiceOver doesn't announce untick on toggling the checkbox with "space" key on macOS
  • 86d0616: 8350303: ARM32: StubCodeGenerator::verify_stub(StubGenStubId) failed after JDK-8343767
  • 0662e39: 8350267: Set mtune and mcpu settings in JDK native lib compilation on Linux ppc64(le)
  • c5c91a8: 8345285: [s390x] test failures: foreign/normalize/TestNormalize.java with C2
  • 26bf445: 8350049: [JMH] Float16OperationsBenchmark fails java.lang.NoClassDefFoundError
  • 00d4e4a: 8350051: [JMH] Several tests fails NPE
  • 0131c1b: 8349953: Avoid editing AOTConfiguration file in "make test JTREG=AOT_JDK=true"
  • ... and 10 more: https://git.openjdk.org/jdk/compare/577ff98a6733a99ea49510f15d631beff39c34a5...master

Your commit was automatically rebased without conflicts.

@openjdk openjdk bot added the integrated Pull request has been integrated label Feb 20, 2025
@openjdk openjdk bot closed this Feb 20, 2025
@openjdk openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Feb 20, 2025
@openjdk
Copy link

openjdk bot commented Feb 20, 2025

@nizarbenalla Pushed as commit 53db576.

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

@ianrichr
Copy link
Contributor

Thank you @nizarbenalla and @erikj79 for resolving this!

@nizarbenalla nizarbenalla deleted the 8350137 branch February 24, 2025 15:18
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