From hannesw at openjdk.org Mon Dec 2 08:42:43 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 2 Dec 2024 08:42:43 GMT Subject: Integrated: 8344041: Re-enable external specs page In-Reply-To: References: Message-ID: <_3uWOSbgyI6kn5cXbBEW70L2NP5atmkqRd9ogApFhdA=.d8061cd8-2584-4121-a7d8-c9e0e0828bb2@github.com> On Tue, 19 Nov 2024 15:45:18 GMT, Hannes Walln?fer wrote: > Please review a change to enable the External Specifications page in API docs. The page was disabled because of missing `@spec` tags in OpenJDK sources. This is a straightforward undo of of #13127 / [JDK-8304689], which means the hidden ad-hoc `--no-external-specs-page` option is also removed. > > [JDK-8304689]: https://bugs.openjdk.org/browse/JDK-8304689 > > [This is what the External Specifications page looks like.](https://cr.openjdk.org/~hannesw/8344041/api.00/external-specs.html) This pull request has now been integrated. Changeset: ac2fede1 Author: Hannes Walln?fer URL: https://git.openjdk.org/jdk/commit/ac2fede165e0ecbfa51f5cc75a3218c51e3528be Stats: 47 lines in 4 files changed: 0 ins; 42 del; 5 mod 8344041: Re-enable external specs page Reviewed-by: erikj, nbenalla, liach ------------- PR: https://git.openjdk.org/jdk/pull/22240 From hannesw at openjdk.org Mon Dec 2 15:52:39 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 2 Dec 2024 15:52:39 GMT Subject: RFR: 8331873: Improve/expand info in `New API In` on Help page In-Reply-To: References: Message-ID: On Mon, 13 May 2024 23:08:51 GMT, Jonathan Gibbons wrote: > Please review a relatively simple update to the generated Help page, as part of the ongoing campaign to improve the documentation around the overall use of `@since` tags. Sorry for losing sight of this PR. I propose a slight change of wording. It would be nice if we could still get this into 24. ------------- PR Comment: https://git.openjdk.org/jdk/pull/19222#issuecomment-2511898946 From hannesw at openjdk.org Mon Dec 2 15:52:41 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 2 Dec 2024 15:52:41 GMT Subject: RFR: 8331873: Improve/expand info in `New API In` on Help page In-Reply-To: <4yDlhVebDfeIj4de2w42HJlo0JEmbbuoqmkjxakkC-I=.94e4a59b-28b9-4085-a8ff-7e9c7567bf52@github.com> References: <4yDlhVebDfeIj4de2w42HJlo0JEmbbuoqmkjxakkC-I=.94e4a59b-28b9-4085-a8ff-7e9c7567bf52@github.com> Message-ID: On Tue, 28 May 2024 19:57:32 GMT, Jonathan Gibbons wrote: >> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 389: >> >>> 387: include the release in which the member was introduced, in those situations \ >>> 388: where the member was added after the initial introduction of the \ >>> 389: enclosing class or interface. >> >> I think "normally" is confusing here, because a member being added in a later release is not necessary the "normal" case. How about reversing the sentence to make it immediately clear what we're talking about? >> >>> In those situations where a member was added after the initial introduction of the enclosing class or interface, the detail of the member includes the release in which it was introduced. > > Yeah, I agree the use of `normally` here could be seen as ambiguous. The comma on line 387 doesn't help. I still think that reversing the sentence as proposed in my comment above would make the intent clearer. I think the "normally" is ok in that order, so I re-added it: "In those situations where a member was added after the initial introduction of the enclosing class or interface, the detail of the member normally includes the release in which it was introduced." >> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 392: >> >>> 390: doclet.help.releases.body.refer=\ >>> 391: Some summary pages allow you to filter the contents of the page according to \ >>> 392: the release in which the declaration was introduced or deprecated. >> >> We already have help sections for New and Deprecated API, and the paragraph is somewhat vague. I think we should at least mention the summary pages by name ("New API", "Deprecated API"). Maybe link to the pages or help sections? > > The hard bit is that those pages may not always be present, depending on the command-line options... I still think this is not ideal ("Some summary pages" then followed by "introduced or deprecated"), but it shouldn't be a show-stopper either. It's better to have this covered, even if the wording is not perfect. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/19222#discussion_r1866082523 PR Review Comment: https://git.openjdk.org/jdk/pull/19222#discussion_r1866086631 From hannesw at openjdk.org Mon Dec 2 15:57:48 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 2 Dec 2024 15:57:48 GMT Subject: RFR: 8331873: Improve/expand info in `New API In` on Help page In-Reply-To: <4yDlhVebDfeIj4de2w42HJlo0JEmbbuoqmkjxakkC-I=.94e4a59b-28b9-4085-a8ff-7e9c7567bf52@github.com> References: <4yDlhVebDfeIj4de2w42HJlo0JEmbbuoqmkjxakkC-I=.94e4a59b-28b9-4085-a8ff-7e9c7567bf52@github.com> Message-ID: On Tue, 28 May 2024 19:58:42 GMT, Jonathan Gibbons wrote: >> src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/resources/standard.properties line 381: >> >>> 379: # The title for the Javadoc Search Specification >>> 380: doclet.help.search.spec.title=Javadoc Search Specification >>> 381: doclet.help.releases.head=Release Details >> >> The subtitle "Release Details" surprised me, because it seems to suggest "details about releases", while it is more like "release information (contained in API details)". > > I'll look to see what I can improve Sorry, revisiting this now I think "Release Details" is absolutely fine. I must have been overly nit-picky that day. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/19222#discussion_r1866106074 From nbenalla at openjdk.org Mon Dec 2 18:19:32 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Mon, 2 Dec 2024 18:19:32 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v2] In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains five additional commits since the last revision: - add file with all vetted links - improve some parts based on review comments - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Convert parts of doccheck into tests ------------- Changes: - all: https://git.openjdk.org/jdk/pull/21879/files - new: https://git.openjdk.org/jdk/pull/21879/files/de69f9b8..8174c67f Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=01 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=00-01 Stats: 399603 lines in 5477 files changed: 219322 ins; 141764 del; 38517 mod Patch: https://git.openjdk.org/jdk/pull/21879.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/21879/head:pull/21879 PR: https://git.openjdk.org/jdk/pull/21879 From nbenalla at openjdk.org Mon Dec 2 18:19:33 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Mon, 2 Dec 2024 18:19:33 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Mon, 4 Nov 2024 15:43:40 GMT, Nizar Benalla wrote: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Small update (besides the large file with external links), not yet done updating the tests based on review comments. FYI after [JDK-8342836](https://bugs.openjdk.org/browse/JDK-8342836) the tests call be run with a simple `make test-docs`, it is the same as using `make test-docs_all TEST_DEPS=docs-jdk` ------------- PR Comment: https://git.openjdk.org/jdk/pull/21879#issuecomment-2512334449 From liach at openjdk.org Thu Dec 5 20:44:59 2024 From: liach at openjdk.org (Chen Liang) Date: Thu, 5 Dec 2024 20:44:59 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: > Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. > > To reviewers, there are some redundant changes and notes: > > - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. > - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: > - `BoundAttribute::payloadLen` for javac attribute tests > - Annotation reading/writing for javac annotation tests > - Line number changes to: > - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java > - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java > - Move from legacy jdk.internal.classfile to java.lang.classfile in: > - test/langtools/tools/javac/NoStringToLower.java and > - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java > - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java > > - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. > > Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 ------------- Changes: https://git.openjdk.org/jdk/pull/22420/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22420&range=01 Stats: 634 lines in 360 files changed: 2 ins; 555 del; 77 mod Patch: https://git.openjdk.org/jdk/pull/22420.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22420/head:pull/22420 PR: https://git.openjdk.org/jdk/pull/22420 From mchung at openjdk.org Thu Dec 5 22:02:40 2024 From: mchung at openjdk.org (Mandy Chung) Date: Thu, 5 Dec 2024 22:02:40 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: On Thu, 5 Dec 2024 20:44:59 GMT, Chen Liang wrote: >> Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. >> >> To reviewers, there are some redundant changes and notes: >> >> - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. >> - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: >> - `BoundAttribute::payloadLen` for javac attribute tests >> - Annotation reading/writing for javac annotation tests >> - Line number changes to: >> - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java >> - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java >> - Move from legacy jdk.internal.classfile to java.lang.classfile in: >> - test/langtools/tools/javac/NoStringToLower.java and >> - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java >> - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java >> >> - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. >> >> Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. > > Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: > > - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview > - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 The change looks okay to me except `ParameterAnnotations.java`. This task is part of JEP 484 and test-only. It seems good to backport to 24. test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java line 643: > 641: > 642: Task.Result result = new JavacTask(tb) > 643: .processors(new TestAP()) I assume this fix does not require this change, right? If so, better to keep the original code and do this cleanup as a separate issue. ------------- PR Review: https://git.openjdk.org/jdk/pull/22420#pullrequestreview-2483057967 PR Review Comment: https://git.openjdk.org/jdk/pull/22420#discussion_r1872207964 From liach at openjdk.org Thu Dec 5 22:29:40 2024 From: liach at openjdk.org (Chen Liang) Date: Thu, 5 Dec 2024 22:29:40 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: <0UU_yVYVqg3FQpCHy7i7hQYidoMigQtXKbTJdNIUMbQ=.d46b4331-cd85-4199-bac3-9b48454e9add@github.com> On Thu, 5 Dec 2024 21:54:19 GMT, Mandy Chung wrote: >> Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: >> >> - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview >> - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 > > test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java line 643: > >> 641: >> 642: Task.Result result = new JavacTask(tb) >> 643: .processors(new TestAP()) > > I assume this fix does not require this change, right? If so, better to keep the original code and do this cleanup as a separate issue. It is required. If we use the command line and FQN to specify a processor like in the current code without preview, this test fails with some classpath error. > Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java >Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. I should attach the exact error message: test: testInnerClass [DIRECT]: - compiler.err.proc.processor.not.found: ParameterAnnotations$TestAP - compiler.err.proc.no.explicit.annotation.processing.requested: T$I 2 errors Exception running test testInnerClass: toolbox.Task$TaskError: Task javac failed: rc=1 toolbox.Task$TaskError: Task javac failed: rc=1 at toolbox.AbstractTask.checkExit(AbstractTask.java:154) at toolbox.JavacTask.run(JavacTask.java:381) at toolbox.AbstractTask.run(AbstractTask.java:102) at toolbox.JavacTask.run(JavacTask.java:52) at toolbox.JavacTask.run(JavacTask.java:321) at ParameterAnnotations.doTest(ParameterAnnotations.java:650) at ParameterAnnotations.testInnerClass(ParameterAnnotations.java:151) at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104) at java.base/java.lang.reflect.Method.invoke(Method.java:565) at toolbox.TestRunner.runTests(TestRunner.java:91) at ParameterAnnotations.runTests(ParameterAnnotations.java:82) at ParameterAnnotations.main(ParameterAnnotations.java:73) at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104) at java.base/java.lang.reflect.Method.invoke(Method.java:565) at com.sun.javatest.regtest.agent.MainActionHelper$AgentVMRunnable.run(MainActionHelper.java:333) at java.base/java.lang.Thread.run(Thread.java:1447) Same for all 5 tests in this file. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22420#discussion_r1872240998 From liach at openjdk.org Thu Dec 5 22:39:38 2024 From: liach at openjdk.org (Chen Liang) Date: Thu, 5 Dec 2024 22:39:38 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: <0UU_yVYVqg3FQpCHy7i7hQYidoMigQtXKbTJdNIUMbQ=.d46b4331-cd85-4199-bac3-9b48454e9add@github.com> References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> <0UU_yVYVqg3FQpCHy7i7hQYidoMigQtXKbTJdNIUMbQ=.d46b4331-cd85-4199-bac3-9b48454e9add@github.com> Message-ID: On Thu, 5 Dec 2024 22:26:31 GMT, Chen Liang wrote: >> test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java line 643: >> >>> 641: >>> 642: Task.Result result = new JavacTask(tb) >>> 643: .processors(new TestAP()) >> >> I assume this fix does not require this change, right? If so, better to keep the original code and do this cleanup as a separate issue. > > It is required. If we use the command line and FQN to specify a processor like in the current code without preview, this test fails with some classpath error. > >> Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java > >>Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. > > I should attach the exact error message: > > > test: testInnerClass > [DIRECT]: > - compiler.err.proc.processor.not.found: ParameterAnnotations$TestAP > - compiler.err.proc.no.explicit.annotation.processing.requested: T$I > 2 errors > Exception running test testInnerClass: toolbox.Task$TaskError: Task javac failed: rc=1 > toolbox.Task$TaskError: Task javac failed: rc=1 > at toolbox.AbstractTask.checkExit(AbstractTask.java:154) > at toolbox.JavacTask.run(JavacTask.java:381) > at toolbox.AbstractTask.run(AbstractTask.java:102) > at toolbox.JavacTask.run(JavacTask.java:52) > at toolbox.JavacTask.run(JavacTask.java:321) > at ParameterAnnotations.doTest(ParameterAnnotations.java:650) > at ParameterAnnotations.testInnerClass(ParameterAnnotations.java:151) > at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104) > at java.base/java.lang.reflect.Method.invoke(Method.java:565) > at toolbox.TestRunner.runTests(TestRunner.java:91) > at ParameterAnnotations.runTests(ParameterAnnotations.java:82) > at ParameterAnnotations.main(ParameterAnnotations.java:73) > at java.base/jdk.internal.reflect.DirectMethodHandleAccessor.invoke(DirectMethodHandleAccessor.java:104) > at java.base/java.lang.reflect.Method.invoke(Method.java:565) > at com.sun.javatest.regtest.agent.MainActionHelper$AgentVMRunnable.run(MainActionHelper.java:333) > at java.base/java.lang.Thread.run(Thread.java:1447) > > > Same for all 5 tests in this file. Filed https://bugs.openjdk.org/browse/JDK-8345622. There is no similar issues that happen as a conjunction of preview and annotation processing. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22420#discussion_r1872252558 From jlu at openjdk.org Thu Dec 5 22:40:59 2024 From: jlu at openjdk.org (Justin Lu) Date: Thu, 5 Dec 2024 22:40:59 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update Message-ID: Please review this PR which contains the open L10n drop changes for RDP1. I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. ------------- Commit messages: - remove quotes around 'Ablehnen' - init Changes: https://git.openjdk.org/jdk/pull/22588/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22588&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345327 Stats: 404 lines in 45 files changed: 165 ins; 123 del; 116 mod Patch: https://git.openjdk.org/jdk/pull/22588.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22588/head:pull/22588 PR: https://git.openjdk.org/jdk/pull/22588 From mchung at openjdk.org Thu Dec 5 23:04:40 2024 From: mchung at openjdk.org (Mandy Chung) Date: Thu, 5 Dec 2024 23:04:40 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: On Thu, 5 Dec 2024 20:44:59 GMT, Chen Liang wrote: >> Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. >> >> To reviewers, there are some redundant changes and notes: >> >> - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. >> - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: >> - `BoundAttribute::payloadLen` for javac attribute tests >> - Annotation reading/writing for javac annotation tests >> - Line number changes to: >> - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java >> - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java >> - Move from legacy jdk.internal.classfile to java.lang.classfile in: >> - test/langtools/tools/javac/NoStringToLower.java and >> - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java >> - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java >> >> - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. >> >> Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. > > Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: > > - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview > - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 Thanks for filing the issue to follow up. ------------- Marked as reviewed by mchung (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22420#pullrequestreview-2483183112 From dnguyen at openjdk.org Fri Dec 6 00:26:38 2024 From: dnguyen at openjdk.org (Damon Nguyen) Date: Fri, 6 Dec 2024 00:26:38 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. Looks generally fine overall. But, looking at the URL for the differences in each file per language, I see changes for `src/jdk.compiler/share/classes/com/sun/tools/javac/resources/launcher`. I don't see any changes for this file in the actual file changes for this PR though. Was there actually a change here? Or some mistake with what was picked up by the diff tool? src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac_zh_CN.properties line 190: > 188: javac.opt.Xdoclint.package.args = [-](,[-])* > 189: > 190: javac.opt.Xdoclint.package.desc=?????????????????? ?\n??????????????????? ''.*''\n??????????????????????? \n???? ''-'' ???????????? Looks like single-quotes are being changed to double single-quotes for some instances. Is this intentional? Or an issue with how the translation process reads this text? ------------- PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2483331030 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1872379231 From dnguyen at openjdk.org Fri Dec 6 00:32:38 2024 From: dnguyen at openjdk.org (Damon Nguyen) Date: Fri, 6 Dec 2024 00:32:38 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: <9TIMWt3fO2KwB3iB6EbAbkEqmZ6f055jt9Ldrp4Mdes=.3ff0da2e-9f0b-4762-82e2-99a0f99b04e3@github.com> On Fri, 6 Dec 2024 00:24:27 GMT, Damon Nguyen wrote: > Looks generally fine overall. But, looking at the URL for the differences in each file per language, I see changes for `src/jdk.compiler/share/classes/com/sun/tools/javac/resources/launcher`. I don't see any changes for this file in the actual file changes for this PR though. Was there actually a change here? Or some mistake with what was picked up by the diff tool? Just noticed you mentioned there are some keys that weren't caught here but will be in RDP2. Maybe this is one of them? If so, that's fine. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22588#issuecomment-2521811145 From jlu at openjdk.org Fri Dec 6 00:32:39 2024 From: jlu at openjdk.org (Justin Lu) Date: Fri, 6 Dec 2024 00:32:39 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: <9TIMWt3fO2KwB3iB6EbAbkEqmZ6f055jt9Ldrp4Mdes=.3ff0da2e-9f0b-4762-82e2-99a0f99b04e3@github.com> References: <9TIMWt3fO2KwB3iB6EbAbkEqmZ6f055jt9Ldrp4Mdes=.3ff0da2e-9f0b-4762-82e2-99a0f99b04e3@github.com> Message-ID: On Fri, 6 Dec 2024 00:27:36 GMT, Damon Nguyen wrote: > > Looks generally fine overall. But, looking at the URL for the differences in each file per language, I see changes for `src/jdk.compiler/share/classes/com/sun/tools/javac/resources/launcher`. I don't see any changes for this file in the actual file changes for this PR though. Was there actually a change here? Or some mistake with what was picked up by the diff tool? > > Just noticed you mentioned there are some keys that weren't caught here but will be in RDP2. Maybe this is one of them? If so, that's fine. Yup, that change came in 12/5. We submitted for translations a few days ago. We can address it in the second L10n drop. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22588#issuecomment-2521812370 From jlu at openjdk.org Fri Dec 6 00:32:40 2024 From: jlu at openjdk.org (Justin Lu) Date: Fri, 6 Dec 2024 00:32:40 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: <63vcWFd5fwCuIIAMsbD2q62_YVzviMzRFGt9qdg5CD0=.406630d5-ee2b-4f2e-af21-984770227578@github.com> On Fri, 6 Dec 2024 00:21:34 GMT, Damon Nguyen wrote: >> Please review this PR which contains the open L10n drop changes for RDP1. >> >> I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. >> >> Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. > > src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac_zh_CN.properties line 190: > >> 188: javac.opt.Xdoclint.package.args = [-](,[-])* >> 189: >> 190: javac.opt.Xdoclint.package.desc=?????????????????? ?\n??????????????????? ''.*''\n??????????????????????? \n???? ''-'' ???????????? > > Looks like single-quotes are being changed to double single-quotes for some instances. Is this intentional? Or an issue with how the translation process reads this text? That's because the English source file had an update to introduce those double single quotes. (See https://cr.openjdk.org/~jlu/output/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.html). It's just being updated to match. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1872384728 From dnguyen at openjdk.org Fri Dec 6 00:46:37 2024 From: dnguyen at openjdk.org (Damon Nguyen) Date: Fri, 6 Dec 2024 00:46:37 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: <6t9NSz5O0tFxmb-pYaTUTThJMnReoS-PuWpwOPRCa_M=.4c65900d-ced5-45d8-a941-3e718f643695@github.com> On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. Marked as reviewed by dnguyen (Committer). ------------- PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2483359819 From dnguyen at openjdk.org Fri Dec 6 00:46:38 2024 From: dnguyen at openjdk.org (Damon Nguyen) Date: Fri, 6 Dec 2024 00:46:38 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: <63vcWFd5fwCuIIAMsbD2q62_YVzviMzRFGt9qdg5CD0=.406630d5-ee2b-4f2e-af21-984770227578@github.com> References: <63vcWFd5fwCuIIAMsbD2q62_YVzviMzRFGt9qdg5CD0=.406630d5-ee2b-4f2e-af21-984770227578@github.com> Message-ID: On Fri, 6 Dec 2024 00:30:03 GMT, Justin Lu wrote: >> src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac_zh_CN.properties line 190: >> >>> 188: javac.opt.Xdoclint.package.args = [-](,[-])* >>> 189: >>> 190: javac.opt.Xdoclint.package.desc=?????????????????? ?\n??????????????????? ''.*''\n??????????????????????? \n???? ''-'' ???????????? >> >> Looks like single-quotes are being changed to double single-quotes for some instances. Is this intentional? Or an issue with how the translation process reads this text? > > That's because the English source file had an update to introduce those double single quotes. (See https://cr.openjdk.org/~jlu/output/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.html). It's just being updated to match. Oh you're right. That's odd though. But the translations aren't wrong then. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1872398739 From asotona at openjdk.org Fri Dec 6 07:01:45 2024 From: asotona at openjdk.org (Adam Sotona) Date: Fri, 6 Dec 2024 07:01:45 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: On Thu, 5 Dec 2024 20:44:59 GMT, Chen Liang wrote: >> Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. >> >> To reviewers, there are some redundant changes and notes: >> >> - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. >> - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: >> - `BoundAttribute::payloadLen` for javac attribute tests >> - Annotation reading/writing for javac annotation tests >> - Line number changes to: >> - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java >> - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java >> - Move from legacy jdk.internal.classfile to java.lang.classfile in: >> - test/langtools/tools/javac/NoStringToLower.java and >> - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java >> - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java >> >> - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. >> >> Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. > > Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: > > - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview > - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 Looks good to me, thanks. ------------- Marked as reviewed by asotona (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22420#pullrequestreview-2483795644 From liach at openjdk.org Fri Dec 6 14:27:46 2024 From: liach at openjdk.org (Chen Liang) Date: Fri, 6 Dec 2024 14:27:46 GMT Subject: Integrated: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 In-Reply-To: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: On Wed, 27 Nov 2024 23:10:15 GMT, Chen Liang wrote: > Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. > > To reviewers, there are some redundant changes and notes: > > - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. > - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: > - `BoundAttribute::payloadLen` for javac attribute tests > - Annotation reading/writing for javac annotation tests > - Line number changes to: > - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java > - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java > - Move from legacy jdk.internal.classfile to java.lang.classfile in: > - test/langtools/tools/javac/NoStringToLower.java and > - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java > - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java > > - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. > > Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. This pull request has now been integrated. Changeset: 49664195 Author: Chen Liang URL: https://git.openjdk.org/jdk/commit/496641955041c5e48359e6256a4a61812653d900 Stats: 634 lines in 360 files changed: 2 ins; 555 del; 77 mod 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 Reviewed-by: mchung, asotona ------------- PR: https://git.openjdk.org/jdk/pull/22420 From liach at openjdk.org Fri Dec 6 14:27:45 2024 From: liach at openjdk.org (Chen Liang) Date: Fri, 6 Dec 2024 14:27:45 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: On Thu, 5 Dec 2024 20:44:59 GMT, Chen Liang wrote: >> Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. >> >> To reviewers, there are some redundant changes and notes: >> >> - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. >> - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: >> - `BoundAttribute::payloadLen` for javac attribute tests >> - Annotation reading/writing for javac annotation tests >> - Line number changes to: >> - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java >> - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java >> - Move from legacy jdk.internal.classfile to java.lang.classfile in: >> - test/langtools/tools/javac/NoStringToLower.java and >> - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java >> - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java >> >> - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. >> >> Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. > > Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: > > - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview > - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 Thanks for the reviews! ------------- PR Comment: https://git.openjdk.org/jdk/pull/22420#issuecomment-2523362333 From liach at openjdk.org Fri Dec 6 15:08:47 2024 From: liach at openjdk.org (Chen Liang) Date: Fri, 6 Dec 2024 15:08:47 GMT Subject: RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 [v2] In-Reply-To: References: <3FonQjV3pn1bynQC4dT-Mo2ttwRkmxuAkY0y9TbB0u8=.5ea6d9ce-068b-4d1d-81e1-548f59761641@github.com> Message-ID: On Thu, 5 Dec 2024 20:44:59 GMT, Chen Liang wrote: >> Remove the redundant `@enablePreview` and `--enable-preview` flags for enabling ClassFile API in the tests. The remainder of these flags in all tests seem to serve preview APIs (such as ScopedValue) or language features (primitive pattern, module imports, etc.), or testing the enable preview flag itself. Now there is fewer than 100 `@enablePreview` in the `test` directory. >> >> To reviewers, there are some redundant changes and notes: >> >> - There's one security test that used `ModuleInfoWriter` that depends on ClassFile API. >> - Removed unnecessary exports of `jdk.internal.classfile.impl`. Remaining uses are: >> - `BoundAttribute::payloadLen` for javac attribute tests >> - Annotation reading/writing for javac annotation tests >> - Line number changes to: >> - test/langtools/tools/javac/linenumbers/NestedLineNumberTest.java >> - test/langtools/tools/javac/linenumbers/NullCheckLineNumberTest.java >> - Move from legacy jdk.internal.classfile to java.lang.classfile in: >> - test/langtools/tools/javac/NoStringToLower.java and >> - test/langtools/tools/javac/T8003967/DetectMutableStaticFields.java >> - Weird annotation processor behavior in test/langtools/tools/javac/annotations/parameter/ParameterAnnotations.java >> >> - Without preview and using explicit file name, the javac task fails; using the builder live AP object works both with and without preview. >> >> Testing: tier 1-5. Please inform me if any of these tests belong to higher tiers. > > Chen Liang has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains two commits: > > - Merge branch 'master' of https://github.com/openjdk/jdk into cleanup/cf-preview > - 8334733: Remove obsolete @enablePreview from tests after JDK-83324714 >From internal discussion, this task is logically associated with the finalization of ClassFile API and is best done for the same release 24. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22420#issuecomment-2523450991 From liach at openjdk.org Fri Dec 6 15:17:26 2024 From: liach at openjdk.org (Chen Liang) Date: Fri, 6 Dec 2024 15:17:26 GMT Subject: [jdk24] RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 Message-ID: Hi all, This pull request contains a backport of commit [49664195](https://github.com/openjdk/jdk/commit/496641955041c5e48359e6256a4a61812653d900) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. This is a test-only change so it is eligible for backport; in addition, this change is logically part of the Class-File API finalized in JDK 24. The commit being backported was authored by Chen Liang on 6 Dec 2024 and was reviewed by Mandy Chung and Adam Sotona. Thanks! ------------- Commit messages: - Backport 496641955041c5e48359e6256a4a61812653d900 Changes: https://git.openjdk.org/jdk/pull/22607/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22607&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8334733 Stats: 634 lines in 360 files changed: 2 ins; 555 del; 77 mod Patch: https://git.openjdk.org/jdk/pull/22607.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22607/head:pull/22607 PR: https://git.openjdk.org/jdk/pull/22607 From hannesw at openjdk.org Fri Dec 6 15:32:18 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Fri, 6 Dec 2024 15:32:18 GMT Subject: RFR: 8345664: Use simple parameter type names in @link and @see tags Message-ID: Please review a change to use simple raw parameter type names in method signatures generated by `@link` and `@see` tags. This is the same signature format we use for methods in the table of contents sidebar. The change only applies if the method reference doesn't contain a signature (i.e. method name only as in `{@link #set}`). If the reference in the tag includes a signature, that signature continues to be used in the link label (i.e. `{@link #set(Object)}` or `{@link #set(java.lang.Object)}`). The argument for using simple and raw type names is: - The purpose of a method link label is to make the user understand which method we're talking about, and that requires recognizing the number and type names of parameters. Using fully qualified type names and possibly type parameters with bounded wildcards makes both much harder and is not required at this stage. - If information about package names or type parameters of parameter types is required, that's what the link to the method details is for (possibly clicking through to the parameter type). Here is a before/after comparison of a rather typical case in `MethodHandles.collectArguments`: methodhandles-full methodhandles-simple Here's a before/after comparison that shows the effect on fully qualified type names with bounded wildcards in `CompletionStage.exceptionallyAsync`: completionhandler-full completionhandler-simple ------------- Commit messages: - 8345664: Use simple parameter type names in @link and @see tags Changes: https://git.openjdk.org/jdk/pull/22608/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22608&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345664 Stats: 29 lines in 6 files changed: 13 ins; 1 del; 15 mod Patch: https://git.openjdk.org/jdk/pull/22608.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22608/head:pull/22608 PR: https://git.openjdk.org/jdk/pull/22608 From liach at openjdk.org Fri Dec 6 16:23:38 2024 From: liach at openjdk.org (Chen Liang) Date: Fri, 6 Dec 2024 16:23:38 GMT Subject: RFR: 8345664: Use simple parameter type names in @link and @see tags In-Reply-To: References: Message-ID: <8xlFsdWAGMTUaIonrwcJ4bB37IECuargZyBN_zZ0LiI=.cdab1ba8-e369-48c9-82ad-48dced6bd27a@github.com> On Fri, 6 Dec 2024 15:25:47 GMT, Hannes Walln?fer wrote: > Please review a change to use simple raw parameter type names in method signatures generated by `@link` and `@see` tags. This is the same signature format we use for methods in the table of contents sidebar. > > The change only applies if the method reference doesn't contain a signature (i.e. method name only as in `{@link #set}`). If the reference in the tag includes a signature, that signature continues to be used in the link label (i.e. `{@link #set(Object)}` or `{@link #set(java.lang.Object)}`). > > The argument for using simple and raw type names is: > > - The purpose of a method link label is to make the user understand which method we're talking about, and that requires recognizing the number and type names of parameters. Using fully qualified type names and possibly type parameters with bounded wildcards makes both much harder and is not useful at this stage. > - If information about package names or type parameters of parameter types is required, that's what the link to the method details is for (possibly clicking through to the parameter type). > > Here is a before/after comparison of a rather typical case in `MethodHandles.collectArguments`: > > methodhandles-full > > methodhandles-simple > > Here's a before/after comparison that shows the effect on fully qualified type names with bounded wildcards in `CompletionStage.exceptionallyAsync`: > > completionhandler-full > > completionhandler-simple Magnificent! ------------- Marked as reviewed by liach (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22608#pullrequestreview-2485328604 From hannesw at openjdk.org Fri Dec 6 16:41:41 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Fri, 6 Dec 2024 16:41:41 GMT Subject: RFR: 8345664: Use simple parameter type names in @link and @see tags In-Reply-To: References: Message-ID: On Fri, 6 Dec 2024 15:25:47 GMT, Hannes Walln?fer wrote: > Please review a change to use simple raw parameter type names in method signatures generated by `@link` and `@see` tags. This is the same signature format we use for methods in the table of contents sidebar. > > The change only applies if the method reference doesn't contain a signature (i.e. method name only as in `{@link #set}`). If the reference in the tag includes a signature, that signature continues to be used in the link label (i.e. `{@link #set(Object)}` or `{@link #set(java.lang.Object)}`). > > The argument for using simple and raw type names is: > > - The purpose of a method link label is to make the user understand which method we're talking about, and that requires recognizing the number and type names of parameters. Using fully qualified type names and possibly type parameters with bounded wildcards makes both much harder and is not useful at this stage. > - If information about package names or type parameters of parameter types is required, that's what the link to the method details is for (possibly clicking through to the parameter type). > > Here is a before/after comparison of a rather typical case in `MethodHandles.collectArguments`: > > methodhandles-full > > methodhandles-simple > > Here's a before/after comparison that shows the effect on fully qualified type names with bounded wildcards in `CompletionStage.exceptionallyAsync`: > > completionhandler-full > > completionhandler-simple Thanks! ------------- PR Comment: https://git.openjdk.org/jdk/pull/22608#issuecomment-2523700689 From hannesw at openjdk.org Fri Dec 6 16:41:42 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Fri, 6 Dec 2024 16:41:42 GMT Subject: Integrated: 8345664: Use simple parameter type names in @link and @see tags In-Reply-To: References: Message-ID: On Fri, 6 Dec 2024 15:25:47 GMT, Hannes Walln?fer wrote: > Please review a change to use simple raw parameter type names in method signatures generated by `@link` and `@see` tags. This is the same signature format we use for methods in the table of contents sidebar. > > The change only applies if the method reference doesn't contain a signature (i.e. method name only as in `{@link #set}`). If the reference in the tag includes a signature, that signature continues to be used in the link label (i.e. `{@link #set(Object)}` or `{@link #set(java.lang.Object)}`). > > The argument for using simple and raw type names is: > > - The purpose of a method link label is to make the user understand which method we're talking about, and that requires recognizing the number and type names of parameters. Using fully qualified type names and possibly type parameters with bounded wildcards makes both much harder and is not useful at this stage. > - If information about package names or type parameters of parameter types is required, that's what the link to the method details is for (possibly clicking through to the parameter type). > > Here is a before/after comparison of a rather typical case in `MethodHandles.collectArguments`: > > methodhandles-full > > methodhandles-simple > > Here's a before/after comparison that shows the effect on fully qualified type names with bounded wildcards in `CompletionStage.exceptionallyAsync`: > > completionhandler-full > > completionhandler-simple This pull request has now been integrated. Changeset: 573bcb61 Author: Hannes Walln?fer URL: https://git.openjdk.org/jdk/commit/573bcb61809cbd98ec52d159d0c8e030e4a8e3f5 Stats: 29 lines in 6 files changed: 13 ins; 1 del; 15 mod 8345664: Use simple parameter type names in @link and @see tags Reviewed-by: liach ------------- PR: https://git.openjdk.org/jdk/pull/22608 From joehw at openjdk.org Fri Dec 6 18:47:37 2024 From: joehw at openjdk.org (Joe Wang) Date: Fri, 6 Dec 2024 18:47:37 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. The java.xml changes look good. Thanks. ------------- Marked as reviewed by joehw (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2485626636 From ihse at openjdk.org Mon Dec 9 13:01:55 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Mon, 9 Dec 2024 13:01:55 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed Message-ID: Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. I have located these modified files using: git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list and then run a script to update the copyright year to 2024 on these files. I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. ------------- Commit messages: - 8345804: Update copyright year to 2024 for langtools in files where it was missed Changes: https://git.openjdk.org/jdk/pull/22643/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22643&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345804 Stats: 400 lines in 424 files changed: 0 ins; 0 del; 400 mod Patch: https://git.openjdk.org/jdk/pull/22643.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22643/head:pull/22643 PR: https://git.openjdk.org/jdk/pull/22643 From liach at openjdk.org Mon Dec 9 14:08:38 2024 From: liach at openjdk.org (Chen Liang) Date: Mon, 9 Dec 2024 14:08:38 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 12:55:53 GMT, Magnus Ihse Bursie wrote: > Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. > > I have located these modified files using: > > git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list > > and then run a script to update the copyright year to 2024 on these files. > > I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. Do we intend to update tests? Some tests have trivial changes as a removal of `@enablePreview` when the ClassFile API is finalized. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22643#issuecomment-2528059231 From ihse at openjdk.org Mon Dec 9 15:52:36 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Mon, 9 Dec 2024 15:52:36 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 12:55:53 GMT, Magnus Ihse Bursie wrote: > Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. > > I have located these modified files using: > > git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list > > and then run a script to update the copyright year to 2024 on these files. > > I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. Yes, all files should be updated. I'm continuing this discussion off-line. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22643#issuecomment-2528470989 From hannesw at openjdk.org Mon Dec 9 17:45:49 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 9 Dec 2024 17:45:49 GMT Subject: RFR: 8345777: Improve sections for inherited members Message-ID: Please review a set of changes to make the sections for inherited members in API docs more usable. - Link to the relevant member summary in the parent type instead of the top of the page in headings for inherited members - Omit parent type's package name in headings for inherited members - Add method signature as title attribute (tooltip) in links to inherited methods - Omit type bounds and do not create separate links for type parameters in links to inherited nested classes Before/after comparisons for methods and nested classes (the first two items also apply to other kinds of members): java.util.TreeMap: - inherited nested classes [before][1], [after][2] - inherited methods [before][3], [after][4] java.util.Spliterator.OfInt: - inherited nested classes [before][5], [after][6] - inherited methods [before][7], [after][8] [1]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#nested-class-summary [2]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#nested-class-summary [3]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap [4]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap [5]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#nested-class-summary [6]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#nested-class-summary [7]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator [8]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator ------------- Commit messages: - 8345777: Improve sections for inherited members Changes: https://git.openjdk.org/jdk/pull/22651/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22651&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345777 Stats: 203 lines in 16 files changed: 72 ins; 46 del; 85 mod Patch: https://git.openjdk.org/jdk/pull/22651.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22651/head:pull/22651 PR: https://git.openjdk.org/jdk/pull/22651 From mchung at openjdk.org Mon Dec 9 18:01:37 2024 From: mchung at openjdk.org (Mandy Chung) Date: Mon, 9 Dec 2024 18:01:37 GMT Subject: [jdk24] RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 In-Reply-To: References: Message-ID: On Fri, 6 Dec 2024 15:11:20 GMT, Chen Liang wrote: > Hi all, > > This pull request contains a backport of commit [49664195](https://github.com/openjdk/jdk/commit/496641955041c5e48359e6256a4a61812653d900) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > This is a test-only change so it is eligible for backport; in addition, this change is logically part of the Class-File API finalized in JDK 24. > > The commit being backported was authored by Chen Liang on 6 Dec 2024 and was reviewed by Mandy Chung and Adam Sotona. > > Thanks! Marked as reviewed by mchung (Reviewer). ------------- PR Review: https://git.openjdk.org/jdk/pull/22607#pullrequestreview-2489586744 From hannesw at openjdk.org Mon Dec 9 18:12:15 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 9 Dec 2024 18:12:15 GMT Subject: RFR: 8345777: Improve sections for inherited members [v2] In-Reply-To: References: Message-ID: > Please review a set of changes to make the sections for inherited members in API docs more usable. > > - Link to the relevant member summary in the parent type instead of the top of the page in headings for inherited members > - Omit parent type's package name in headings for inherited members > - Add method signature as title attribute (tooltip) in links to inherited methods > - Omit type bounds and do not create separate links for type parameters in links to inherited nested classes > > Before/after comparisons for methods and nested classes (the first two items also apply to other kinds of members): > > java.util.TreeMap: > - inherited nested classes [before][1], [after][2] > - inherited methods [before][3], [after][4] > > java.util.Spliterator.OfInt: > - inherited nested classes [before][5], [after][6] > - inherited methods [before][7], [after][8] > > [1]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#nested-class-summary > [2]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#nested-class-summary > > [3]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap > [4]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap > > [5]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#nested-class-summary > [6]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#nested-class-summary > > [7]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator > [8]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator Hannes Walln?fer has updated the pull request incrementally with one additional commit since the last revision: Render signature of inherited method in context of the local type. ------------- Changes: - all: https://git.openjdk.org/jdk/pull/22651/files - new: https://git.openjdk.org/jdk/pull/22651/files/10814b6d..f455d7c6 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=22651&range=01 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=22651&range=00-01 Stats: 2 lines in 2 files changed: 0 ins; 0 del; 2 mod Patch: https://git.openjdk.org/jdk/pull/22651.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22651/head:pull/22651 PR: https://git.openjdk.org/jdk/pull/22651 From liach at openjdk.org Mon Dec 9 18:37:42 2024 From: liach at openjdk.org (Chen Liang) Date: Mon, 9 Dec 2024 18:37:42 GMT Subject: [jdk24] RFR: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 In-Reply-To: References: Message-ID: <-vHUTV6ABJZEaxVGeZ2FytzgMEIx-Cdcgm_I5TIuxo4=.5f76bd21-9378-4e52-949b-06ad59192bab@github.com> On Fri, 6 Dec 2024 15:11:20 GMT, Chen Liang wrote: > Hi all, > > This pull request contains a backport of commit [49664195](https://github.com/openjdk/jdk/commit/496641955041c5e48359e6256a4a61812653d900) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > This is a test-only change so it is eligible for backport; in addition, this change is logically part of the Class-File API finalized in JDK 24. > > The commit being backported was authored by Chen Liang on 6 Dec 2024 and was reviewed by Mandy Chung and Adam Sotona. > > Thanks! Thanks for the review! ------------- PR Comment: https://git.openjdk.org/jdk/pull/22607#issuecomment-2529047739 From liach at openjdk.org Mon Dec 9 18:37:43 2024 From: liach at openjdk.org (Chen Liang) Date: Mon, 9 Dec 2024 18:37:43 GMT Subject: [jdk24] Integrated: 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 In-Reply-To: References: Message-ID: On Fri, 6 Dec 2024 15:11:20 GMT, Chen Liang wrote: > Hi all, > > This pull request contains a backport of commit [49664195](https://github.com/openjdk/jdk/commit/496641955041c5e48359e6256a4a61812653d900) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > This is a test-only change so it is eligible for backport; in addition, this change is logically part of the Class-File API finalized in JDK 24. > > The commit being backported was authored by Chen Liang on 6 Dec 2024 and was reviewed by Mandy Chung and Adam Sotona. > > Thanks! This pull request has now been integrated. Changeset: a8132543 Author: Chen Liang URL: https://git.openjdk.org/jdk/commit/a81325433d7da6b73abb37ea3e33489d0a3afbae Stats: 634 lines in 360 files changed: 2 ins; 555 del; 77 mod 8334733: Remove obsolete @enablePreview from tests after JDK-8334714 Reviewed-by: mchung Backport-of: 496641955041c5e48359e6256a4a61812653d900 ------------- PR: https://git.openjdk.org/jdk/pull/22607 From ihse at openjdk.org Mon Dec 9 21:05:30 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Mon, 9 Dec 2024 21:05:30 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed [v2] In-Reply-To: References: Message-ID: > Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. > > I have located these modified files using: > > git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list > > and then run a script to update the copyright year to 2024 on these files. > > I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision: Revert mistaken changes to binary files ------------- Changes: - all: https://git.openjdk.org/jdk/pull/22643/files - new: https://git.openjdk.org/jdk/pull/22643/files/114fd977..5eda7858 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=22643&range=01 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=22643&range=00-01 Stats: 0 lines in 24 files changed: 0 ins; 0 del; 0 mod Patch: https://git.openjdk.org/jdk/pull/22643.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22643/head:pull/22643 PR: https://git.openjdk.org/jdk/pull/22643 From almatvee at openjdk.org Mon Dec 9 23:37:37 2024 From: almatvee at openjdk.org (Alexander Matveev) Date: Mon, 9 Dec 2024 23:37:37 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: <7v84rQl0BjuUvn8npxHoWUgiJE58li_T3gH52wg9ql4=.c9815e11-fb0a-43f2-8a82-30e8c9e53d59@github.com> On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. "jdk.jpackage" changes looks good. ------------- Marked as reviewed by almatvee (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2490361583 From henryjen at openjdk.org Tue Dec 10 00:47:38 2024 From: henryjen at openjdk.org (Henry Jen) Date: Tue, 10 Dec 2024 00:47:38 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: <63vcWFd5fwCuIIAMsbD2q62_YVzviMzRFGt9qdg5CD0=.406630d5-ee2b-4f2e-af21-984770227578@github.com> Message-ID: On Fri, 6 Dec 2024 00:43:29 GMT, Damon Nguyen wrote: >> That's because the English source file had an update to introduce those double single quotes. (See https://cr.openjdk.org/~jlu/output/src/jdk.compiler/share/classes/com/sun/tools/javac/resources/javac.html). It's just being updated to match. > > Oh you're right. That's odd though. But the translations aren't wrong then. `?? ?\n????????.` We use here, but the args format is using Chinese translation,`= [-](,[-])*` Should that be consistent? ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1876949210 From henryjen at openjdk.org Tue Dec 10 00:47:41 2024 From: henryjen at openjdk.org (Henry Jen) Date: Tue, 10 Dec 2024 00:47:41 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. src/jdk.jlink/share/classes/jdk/tools/jmod/resources/jmod_zh_CN.properties line 100: > 98: err.date.out.of.range=--date {0} ?? 1980-01-01T00:00:02Z ? 2099-12-31T23:59:59Z ??????? > 99: err.compress.incorrect=--compress ????{0} > 100: err.compress.wrong.mode=--??????????? compress ??????????? --compress src/jdk.jpackage/windows/classes/jdk/jpackage/internal/resources/WinResources_zh_CN.properties line 43: > 41: resource.installdirnotemptydlg-wix-file=??????? WiX ?????? > 42: resource.launcher-as-service-wix-file=?????? WiX ???? > 43: resource.wix-src-conv=? WiX ?? WiX v3 ????? WiX v4 ??? XSLT ??? Nitpick: The sources here means source code, I would think ?? is more appropriate. ? WiX ?? WiX v3 ????? WiX v4 ??? XSLT ??? ? WiX ??? WiX v3 ????? WiX v4 ??? XSLT ??? ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1876975815 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1876981882 From duke at openjdk.org Tue Dec 10 08:36:39 2024 From: duke at openjdk.org (Jonathan =?UTF-8?B?TGFtcMOpcnRo?=) Date: Tue, 10 Dec 2024 08:36:39 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. The `javap` changes in `jdk.jdeps` look good. Thanks. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22588#issuecomment-2530801024 From sgehwolf at openjdk.org Tue Dec 10 09:32:41 2024 From: sgehwolf at openjdk.org (Severin Gehwolf) Date: Tue, 10 Dec 2024 09:32:41 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. I've only looked at the `jlink` resources and added my suggestions for German. src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 68: > 66: main.runtime.image.linking.cap.disabled=deaktiviert > 67: main.runtime.image.linking.cap.sect.header=Funktionen: > 68: main.runtime.image.linking.cap.msg=\ Verkn?pfung von Laufzeitimage {0} Suggestion: main.runtime.image.linking.cap.msg=\ Assemblierung von Laufzeitimage {0} src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 73: > 71: warn.prefix=Warnung: > 72: > 73: err.runtime.link.not.linkable.runtime=Dieses JDK unterst?tzt keine Verkn?pfung vom aktuellen Laufzeitimage Suggestion: err.runtime.link.not.linkable.runtime=Dieses JDK unterst?tzt keine Assemblierung vom aktuellen Laufzeitimage src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 74: > 72: > 73: err.runtime.link.not.linkable.runtime=Dieses JDK unterst?tzt keine Verkn?pfung vom aktuellen Laufzeitimage > 74: err.runtime.link.jdk.jlink.prohibited=Dieses JDK enth?lt keine als Package integrierten Module und kann nicht verwendet werden, um ein anderes Image mit dem Modul jdk.jlink zu erstellen Suggestion: err.runtime.link.jdk.jlink.prohibited=Dieses JDK enth?lt keine als Pakete verpackten Module und kann nicht verwendet werden, um ein anderes Image mit dem Modul jdk.jlink zu erstellen src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 75: > 73: err.runtime.link.not.linkable.runtime=Dieses JDK unterst?tzt keine Verkn?pfung vom aktuellen Laufzeitimage > 74: err.runtime.link.jdk.jlink.prohibited=Dieses JDK enth?lt keine als Package integrierten Module und kann nicht verwendet werden, um ein anderes Image mit dem Modul jdk.jlink zu erstellen > 75: err.runtime.link.packaged.mods=Dieses JDK enth?lt keine als Package integrierten Module. "--keep-packaged-modules" wird nicht unterst?tzt Suggestion: err.runtime.link.packaged.mods=Dieses JDK enth?lt keine als Pakete verpackten Module. "--keep-packaged-modules" wird nicht unterst?tzt src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 76: > 74: err.runtime.link.jdk.jlink.prohibited=Dieses JDK enth?lt keine als Package integrierten Module und kann nicht verwendet werden, um ein anderes Image mit dem Modul jdk.jlink zu erstellen > 75: err.runtime.link.packaged.mods=Dieses JDK enth?lt keine als Package integrierten Module. "--keep-packaged-modules" wird nicht unterst?tzt > 76: err.runtime.link.modified.file={0} wurde ge?ndert Suggestion: err.runtime.link.modified.file={0} wurde modifiziert src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 77: > 75: err.runtime.link.packaged.mods=Dieses JDK enth?lt keine als Package integrierten Module. "--keep-packaged-modules" wird nicht unterst?tzt > 76: err.runtime.link.modified.file={0} wurde ge?ndert > 77: err.runtime.link.patched.module=Datei {0} nicht im Modulimage gefunden. "--patch-module" wird beim Verkn?pfen aus dem Laufzeitimage nicht unterst?tzt This is an old translation. This has changed with https://bugs.openjdk.org/browse/JDK-8343839. My suggested translation would be: Suggestion: err.runtime.link.patched.module=jlink Assemblierung vom Laufzeitimage wird nicht unterst?tzt wenn das Laufzeitimage mit "--patch-module" ver?ndert ist. src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 119: > 117: providers.header=Provider > 118: > 119: runtime.link.info=Verkn?pfung basierend auf dem aktuellen Laufzeitimage Suggestion: runtime.link.info=Assemblierung basierend auf dem aktuellen Laufzeitimage ------------- PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2491567949 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877669257 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877670922 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877679928 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877681883 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877683732 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877700959 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877703007 From jlahoda at openjdk.org Tue Dec 10 10:53:40 2024 From: jlahoda at openjdk.org (Jan Lahoda) Date: Tue, 10 Dec 2024 10:53:40 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: <63vcWFd5fwCuIIAMsbD2q62_YVzviMzRFGt9qdg5CD0=.406630d5-ee2b-4f2e-af21-984770227578@github.com> Message-ID: On Tue, 10 Dec 2024 00:05:45 GMT, Henry Jen wrote: >> Oh you're right. That's odd though. But the translations aren't wrong then. > > `?? ?\n????????.` > We use here, but the args format is using Chinese translation,`= [-](,[-])*` > > Should that be consistent? Regarding `''` - please see https://bugs.openjdk.org/browse/JDK-8343412. I believe this is intentional. (`'` needs to be "quoted" in `MessageFormat`.) ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877719268 From jlahoda at openjdk.org Tue Dec 10 10:53:39 2024 From: jlahoda at openjdk.org (Jan Lahoda) Date: Tue, 10 Dec 2024 10:53:39 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. I don't speak any of the languages changed here, but I have looked at: - the new concise helps for the `java` launcher, added some comments mostly on alignment - in the `javac` message `transitive modifier for java.base`, `transitive` is a literal modifier appearing in the source, so possibly it should not be translated (we can enhance the English bundle to say that). There's also a comment inline on this. - for JShell bundles, I note there's no update for Japanese - that's OK, just making sure its intentional. There was also a relatively late change to the JShell bundles: https://github.com/openjdk/jdk/commit/bcebb0c53c1e4629ebde534e237a86c161130fff#diff-fd30aa079239d0b535a6eb014ee0bc8d16709969c87cc9f6c652f91d75aec769 I assume that change was too late for this drop. Overall, I think the parts I checked are OK (to the degree I can understand it), with possible (future) improvements for consideration. src/java.base/share/classes/sun/launcher/resources/launcher_de.properties line 44: > 42: > 43: # Translators please note do not translate the options themselves > 44: java.launcher.opt.concise.header = Verwendung: java [Java-Optionen...] [Anwendungsargumente...]\n\nDabei ist einer der folgenden Werte:\n Zum Ausf?hren der Hauptmethode einer kompilierten Hauptklasse\n -jar .jar Zum Ausf?hren der Hauptklasse eines JAR-Archivs\n -m [/] Zum Ausf?hren der Hauptklasse eines Moduls\n .java Zum Kompilieren und Ausf?hren eines Quelldateiprogramms\n\nDabei sind die folgenden wichtigen Java-Optionen verf?gbar:\n --class-path \n ist eine durch "{0}" getrennte Liste der Verzeichnisse und JAR-Archive, in denen nach Klassendateien gesucht werden soll\n --module-path \n ist eine durch "{0}" getrennte Liste der Verzeichnisse und JAR-Archive, in denen nach Modulen gesucht werden soll\n -version\n Zum Ausgeben der Produktversion in den Fehlerstream und Beenden des Vorgangs\n\nF?r weitere Verwendungshilfe: java --help\nF?r eine interaktive Java-Umgebung: jshell This gives the following output: Verwendung: java [Java-Optionen...] [Anwendungsargumente...] Dabei ist einer der folgenden Werte: Zum Ausf?hren der Hauptmethode einer kompilierten Hauptklasse -jar .jar Zum Ausf?hren der Hauptklasse eines JAR-Archivs -m [/] Zum Ausf?hren der Hauptklasse eines Moduls .java Zum Kompilieren und Ausf?hren eines Quelldateiprogramms Dabei sind die folgenden wichtigen Java-Optionen verf?gbar: --class-path ist eine durch ":" getrennte Liste der Verzeichnisse und JAR-Archive, in denen nach Klassendateien gesucht werden soll --module-path ist eine durch ":" getrennte Liste der Verzeichnisse und JAR-Archive, in denen nach Modulen gesucht werden soll -version Zum Ausgeben der Produktversion in den Fehlerstream und Beenden des Vorgangs F?r weitere Verwendungshilfe: java --help F?r eine interaktive Java-Umgebung: jshell It would be nicer if the `Zum ...` texts would be aligned, and the `java` and `jshell` at the end would be aligned. I.e.: Verwendung: java [Java-Optionen...] [Anwendungsargumente...] Dabei ist einer der folgenden Werte: Zum Ausf?hren der Hauptmethode einer kompilierten Hauptklasse -jar .jar Zum Ausf?hren der Hauptklasse eines JAR-Archivs -m [/] Zum Ausf?hren der Hauptklasse eines Moduls .java Zum Kompilieren und Ausf?hren eines Quelldateiprogramms Dabei sind die folgenden wichtigen Java-Optionen verf?gbar: --class-path ist eine durch ":" getrennte Liste der Verzeichnisse und JAR-Archive, in denen nach Klassendateien gesucht werden soll --module-path ist eine durch ":" getrennte Liste der Verzeichnisse und JAR-Archive, in denen nach Modulen gesucht werden soll -version Zum Ausgeben der Produktversion in den Fehlerstream und Beenden des Vorgangs F?r weitere Verwendungshilfe: java --help F?r eine interaktive Java-Umgebung: jshell src/java.base/share/classes/sun/launcher/resources/launcher_ja.properties line 46: > 44: > 45: # Translators please note do not translate the options themselves > 46: java.launcher.opt.concise.header = ????: java [java options...] [application arguments...]\n\n?????????:\n ??????????????????????????????\n -jar .jar JAR???????????????????\n -m [/] ???????????????????\n .java ???????????????????????????\n\n???java??????????????:\n --class-path \n ???????????????????????????JAR?????????????"{0}"???????\n --module-path \n ????????????????????????JAR????????????? "{0}"???????\n -version\n ??????????????????????????\n\n??????????????????: java --help\n????Java?????: jshell Similarly to the German version, the currently of `java` and `jshell` are not aligned: ????: java [java options...] [application arguments...] ?????????: ?????????????????????????????? -jar .jar JAR??????????????????? -m [/] ??????????????????? .java ??????????????????????????? ???java??????????????: --class-path ???????????????????????????JAR?????????????":"??????? --module-path ????????????????????????JAR?????????????":"??????? -version ?????????????????????????? ??????????????????: java --help ????Java?????: jshell It would be nicer if they did (assuming it is doable): ????: java [java options...] [application arguments...] ?????????: ?????????????????????????????? -jar .jar JAR??????????????????? -m [/] ??????????????????? .java ??????????????????????????? ???java??????????????: --class-path ???????????????????????????JAR?????????????":"??????? --module-path ????????????????????????JAR?????????????":"??????? -version ?????????????????????????? ??????????????????: java --help ????Java?????: jshell src/java.base/share/classes/sun/launcher/resources/launcher_zh_CN.properties line 44: > 42: > 43: # Translators please note do not translate the options themselves > 44: java.launcher.opt.concise.header = ???java [java options...] [application arguments...]\n\n??? ???????\n ???????? main ??\n -jar .jar ?? JAR ?????\n -m [/] ???????\n .java ??????????\n\n?????? java ?????\n --class-path \n ??? ???????????? JAR ?????? "{0}" ???\n --module-path \n ??? ??????????? JAR ?????? "{0}" ???\n -version\n ??????????????\n\n???????????? java --help\n????? Java ??? jshell It would be nicer if the `java` and `jshell` could be aligned in the last section, but maybe it is not possible? ???java [java options...] [application arguments...] ??? ??????? ???????? main ?? -jar .jar ?? JAR ????? -m [/] ??????? .java ?????????? ?????? java ????? --class-path ??? ???????????? JAR ?????? ":" ??? --module-path ??? ??????????? JAR ?????? ":" ??? -version ?????????????? ???????????? java --help ????? Java ??? jshell src/jdk.compiler/share/classes/com/sun/tools/javac/resources/compiler_de.properties line 2302: > 2300: compiler.misc.feature.module.imports=Modulimporte > 2301: > 2302: compiler.misc.feature.java.base.transitive=Transitiver Modifikator f?r java.base Here (and in other languages as well), maybe the `transitive` should remain intact? `transitive` is what literally appears in the source code - similar to e.g. `static` or `private`. ------------- Marked as reviewed by jlahoda (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2491653435 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877841057 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877847825 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877854317 PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1877712280 From weijun at openjdk.org Tue Dec 10 14:23:40 2024 From: weijun at openjdk.org (Weijun Wang) Date: Tue, 10 Dec 2024 14:23:40 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: <_clBego0M3HtmxdP78pVQtPZlnS0zpsIYd_BrdIrA2s=.dbce28a2-ae9c-402a-a79e-b35270d9ce5d@github.com> On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. The 3 zh_TW translations have not included the updated text. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22588#issuecomment-2531772251 From hannesw at openjdk.org Tue Dec 10 14:41:14 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Tue, 10 Dec 2024 14:41:14 GMT Subject: RFR: 8345908: Class links should be properly spaced Message-ID: <7I4878bgiOSeIc1jqeE1NUszJgSBLhvBLAeKxgkfNyE=.81f04634-21d6-4238-9d19-49a8e37036a8@github.com> Please review a trivial change to apply monospace font not just to the class links at the top of class and interface pages, but also to the comma and space characters between them. The comma-space separators currently use proportional font, which results in very narrow spacing that does not match the class name font. Using the same monospace font for everything makes individual class names more discernible, and makes it easier to pick out individual class names. This is especially true for multiline class lists such as the subinterfaces of `java.lang.Autoclosable` below. Before: class-links-old After: class-links-new ------------- Commit messages: - 8345908: Class links should be properly spaced Changes: https://git.openjdk.org/jdk/pull/22662/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22662&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345908 Stats: 27 lines in 6 files changed: 0 ins; 3 del; 24 mod Patch: https://git.openjdk.org/jdk/pull/22662.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22662/head:pull/22662 PR: https://git.openjdk.org/jdk/pull/22662 From prappo at openjdk.org Tue Dec 10 15:46:38 2024 From: prappo at openjdk.org (Pavel Rappo) Date: Tue, 10 Dec 2024 15:46:38 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. I cannot verify correctness of translation, but I can review this PR generally for `jdk.javadoc`. >From what I can see, the changes are only to the property files, which is expected from the PR title. The keys from English files 1-1 match the keys from non-English files: there are no missing or extra keys. >From that point of view, the changes to `jdk.javadoc` look good. ------------- Marked as reviewed by prappo (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2492753063 From asemenyuk at openjdk.org Tue Dec 10 16:11:39 2024 From: asemenyuk at openjdk.org (Alexey Semenyuk) Date: Tue, 10 Dec 2024 16:11:39 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. jpackage changes look good ------------- Marked as reviewed by asemenyuk (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2492824562 From weijun at openjdk.org Tue Dec 10 18:06:43 2024 From: weijun at openjdk.org (Weijun Wang) Date: Tue, 10 Dec 2024 18:06:43 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. src/jdk.jartool/share/classes/sun/security/tools/jarsigner/Resources_zh_CN.java line 167: > 165: {"history.with.ts", "- \u7531 \"%1$s\" \u7B7E\u540D\n \u6458\u8981\u7B97\u6CD5: %2$s\n \u7B7E\u540D\u7B97\u6CD5: %3$s, %4$s\n \u7531 \"%6$s\" \u4E8E %5$tc \u52A0\u65F6\u95F4\u6233\n \u65F6\u95F4\u6233\u6458\u8981\u7B97\u6CD5: %7$s\n \u65F6\u95F4\u6233\u7B7E\u540D\u7B97\u6CD5: %8$s, %9$s"}, > 166: {"history.without.ts", "- \u7531 \"%1$s\" \u7B7E\u540D\n \u6458\u8981\u7B97\u6CD5: %2$s\n \u7B7E\u540D\u7B97\u6CD5: %3$s, %4$s"}, > 167: {"history.nonexistent.entries", " \u8B66\u544A\uFF1A\u7B7E\u540D\u6761\u76EE\u4E0D\u5B58\u5728\uFF1A"}, This string will be followed by a list of entry names, so the translation should be "????????: ". ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1878576305 From jlu at openjdk.org Tue Dec 10 19:35:21 2024 From: jlu at openjdk.org (Justin Lu) Date: Tue, 10 Dec 2024 19:35:21 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. Justin Lu has updated the pull request incrementally with four additional commits since the last revision: - implement Severin's review Co-authored-by: Severin Gehwolf - implement Jan's review - implement Henry's review - implement Weijun's review ------------- Changes: - all: https://git.openjdk.org/jdk/pull/22588/files - new: https://git.openjdk.org/jdk/pull/22588/files/6472552b..143e22ea Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=22588&range=01 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=22588&range=00-01 Stats: 15 lines in 9 files changed: 4 ins; 0 del; 11 mod Patch: https://git.openjdk.org/jdk/pull/22588.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22588/head:pull/22588 PR: https://git.openjdk.org/jdk/pull/22588 From jlu at openjdk.org Tue Dec 10 19:35:21 2024 From: jlu at openjdk.org (Justin Lu) Date: Tue, 10 Dec 2024 19:35:21 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: On Tue, 10 Dec 2024 18:04:30 GMT, Weijun Wang wrote: >> Justin Lu has updated the pull request incrementally with four additional commits since the last revision: >> >> - implement Severin's review >> >> Co-authored-by: Severin Gehwolf >> - implement Jan's review >> - implement Henry's review >> - implement Weijun's review > > src/jdk.jartool/share/classes/sun/security/tools/jarsigner/Resources_zh_CN.java line 167: > >> 165: {"history.with.ts", "- \u7531 \"%1$s\" \u7B7E\u540D\n \u6458\u8981\u7B97\u6CD5: %2$s\n \u7B7E\u540D\u7B97\u6CD5: %3$s, %4$s\n \u7531 \"%6$s\" \u4E8E %5$tc \u52A0\u65F6\u95F4\u6233\n \u65F6\u95F4\u6233\u6458\u8981\u7B97\u6CD5: %7$s\n \u65F6\u95F4\u6233\u7B7E\u540D\u7B97\u6CD5: %8$s, %9$s"}, >> 166: {"history.without.ts", "- \u7531 \"%1$s\" \u7B7E\u540D\n \u6458\u8981\u7B97\u6CD5: %2$s\n \u7B7E\u540D\u7B97\u6CD5: %3$s, %4$s"}, >> 167: {"history.nonexistent.entries", " \u8B66\u544A\uFF1A\u7B7E\u540D\u6761\u76EE\u4E0D\u5B58\u5728\uFF1A"}, > > This string will be followed by a list of entry names, so the translation should be "????????????". Fixed in https://github.com/openjdk/jdk/pull/22588/commits/ba7732db04b966ff49d4b7f779d5120674443a6c ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1878709957 From jlu at openjdk.org Tue Dec 10 19:35:22 2024 From: jlu at openjdk.org (Justin Lu) Date: Tue, 10 Dec 2024 19:35:22 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: On Tue, 10 Dec 2024 00:40:23 GMT, Henry Jen wrote: >> Justin Lu has updated the pull request incrementally with four additional commits since the last revision: >> >> - implement Severin's review >> >> Co-authored-by: Severin Gehwolf >> - implement Jan's review >> - implement Henry's review >> - implement Weijun's review > > src/jdk.jpackage/windows/classes/jdk/jpackage/internal/resources/WinResources_zh_CN.properties line 43: > >> 41: resource.installdirnotemptydlg-wix-file=??????? WiX ?????? >> 42: resource.launcher-as-service-wix-file=?????? WiX ???? >> 43: resource.wix-src-conv=? WiX ?? WiX v3 ????? WiX v4 ??? XSLT ??? > > Nitpick: The sources here means source code, I would think ?? is more appropriate. > ? WiX ?? WiX v3 ????? WiX v4 ??? XSLT ??? > ? WiX ??? WiX v3 ????? WiX v4 ??? XSLT ??? This and your other comments fixed in https://github.com/openjdk/jdk/pull/22588/commits/2d9653259d828d5899a1ffeb6af1c05fb5f4d10f. Regarding `"?? ?\n????????."`, yes we should follow the args format, that is, do not translate the contents within < >. I'll speak to the translation team about your comments to get them fixed on their side. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1878712996 From sgehwolf at openjdk.org Tue Dec 10 19:40:38 2024 From: sgehwolf at openjdk.org (Severin Gehwolf) Date: Tue, 10 Dec 2024 19:40:38 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: <7hfBIWh_GjV2lTDKsikRmcrxWeIX7iy5fpEFOky6kGM=.5e7f8ea8-c6da-4a06-83e7-05d0a5703353@github.com> On Tue, 10 Dec 2024 19:35:21 GMT, Justin Lu wrote: >> Please review this PR which contains the open L10n drop changes for RDP1. >> >> I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. >> >> Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. > > Justin Lu has updated the pull request incrementally with four additional commits since the last revision: > > - implement Severin's review > > Co-authored-by: Severin Gehwolf > - implement Jan's review > - implement Henry's review > - implement Weijun's review jlink l10n update looks fine. ------------- Marked as reviewed by sgehwolf (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2493399735 From jlu at openjdk.org Tue Dec 10 19:40:39 2024 From: jlu at openjdk.org (Justin Lu) Date: Tue, 10 Dec 2024 19:40:39 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: <3fgQkAcXuGlUTxRYAsumcS8TM5ZKn9BqJOKnRC2BBrE=.1df0a2b4-d759-452c-810c-b6f4e1c79ceb@github.com> On Tue, 10 Dec 2024 09:31:57 GMT, Jan Lahoda wrote: >> Justin Lu has updated the pull request incrementally with four additional commits since the last revision: >> >> - implement Severin's review >> >> Co-authored-by: Severin Gehwolf >> - implement Jan's review >> - implement Henry's review >> - implement Weijun's review > > src/jdk.compiler/share/classes/com/sun/tools/javac/resources/compiler_de.properties line 2302: > >> 2300: compiler.misc.feature.module.imports=Modulimporte >> 2301: >> 2302: compiler.misc.feature.java.base.transitive=Transitiver Modifikator f?r java.base > > Here (and in other languages as well), maybe the `transitive` should remain intact? `transitive` is what literally appears in the source code - similar to e.g. `static` or `private`. Fixed in https://github.com/openjdk/jdk/pull/22588/commits/c7bd52950eeb85581aa7dc2c6fbbb02a4f4cff11. I'll check in with the translation team to ask for it not to be translated, I also left a comment for translators. I only provided the fix for _de_, since it is not obvious to me how to correct it for _ja_ or _zh_CN_. Regarding the jshell changes in this PR, they are a result of translation fixes we filed with the translation team from previous drops. You are correct that https://github.com/openjdk/jdk/commit/bcebb0c53c1e4629ebde534e237a86c161130fff did not make it in this PR because it was too late. The localized changes for that commit will come in the RDP2 drop. Regarding the alignment issues in the translated versions, I don't think the translation team would adapt those changes because they are aesthetic, not functional, and this spacing is likely consistent with their l10n language/punctuation rules. If I made this change, we would have to manually adjust these on our side every drop which I don't think would be ideal. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1878716896 From jlu at openjdk.org Tue Dec 10 19:40:41 2024 From: jlu at openjdk.org (Justin Lu) Date: Tue, 10 Dec 2024 19:40:41 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: On Tue, 10 Dec 2024 09:27:42 GMT, Severin Gehwolf wrote: >> Justin Lu has updated the pull request incrementally with four additional commits since the last revision: >> >> - implement Severin's review >> >> Co-authored-by: Severin Gehwolf >> - implement Jan's review >> - implement Henry's review >> - implement Weijun's review > > src/jdk.jlink/share/classes/jdk/tools/jlink/resources/jlink_de.properties line 77: > >> 75: err.runtime.link.packaged.mods=Dieses JDK enth?lt keine als Package integrierten Module. "--keep-packaged-modules" wird nicht unterst?tzt >> 76: err.runtime.link.modified.file={0} wurde ge?ndert >> 77: err.runtime.link.patched.module=Datei {0} nicht im Modulimage gefunden. "--patch-module" wird beim Verkn?pfen aus dem Laufzeitimage nicht unterst?tzt > > This is an old translation. This has changed with https://bugs.openjdk.org/browse/JDK-8343839. My suggested translation would be: > > Suggestion: > > err.runtime.link.patched.module=jlink Assemblierung vom Laufzeitimage wird nicht unterst?tzt wenn das Laufzeitimage mit "--patch-module" ver?ndert ist. Excluding as we discussed on the JBS issue. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/22588#discussion_r1878719899 From ihse at openjdk.org Wed Dec 11 21:31:37 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Wed, 11 Dec 2024 21:31:37 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed [v2] In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 21:05:30 GMT, Magnus Ihse Bursie wrote: >> Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. >> >> I have located these modified files using: >> >> git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list >> >> and then run a script to update the copyright year to 2024 on these files. >> >> I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. > > Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision: > > Revert mistaken changes to binary files Any reviewers on this? ------------- PR Comment: https://git.openjdk.org/jdk/pull/22643#issuecomment-2537230906 From prappo at openjdk.org Thu Dec 12 10:27:36 2024 From: prappo at openjdk.org (Pavel Rappo) Date: Thu, 12 Dec 2024 10:27:36 GMT Subject: RFR: 8345777: Improve sections for inherited members [v2] In-Reply-To: References: Message-ID: <5cKJde-8h3UDHK8NLdEcOS9uD-SpUm2DDJEf90NPAno=.afa4be40-8764-4b58-8e9a-6f45c7818b24@github.com> On Mon, 9 Dec 2024 18:12:15 GMT, Hannes Walln?fer wrote: >> Please review a set of changes to make the sections for inherited members in API docs more usable. >> >> - Link to the relevant member summary in the parent type instead of the top of the page in headings for inherited members >> - Omit parent type's package name in headings for inherited members >> - Add method signature as title attribute (tooltip) in links to inherited methods >> - Omit type bounds and do not create separate links for type parameters in links to inherited nested classes >> >> Before/after comparisons for methods and nested classes (the first two items also apply to other kinds of members): >> >> java.util.TreeMap: >> - inherited nested classes [before][1], [after][2] >> - inherited methods [before][3], [after][4] >> >> java.util.Spliterator.OfInt: >> - inherited nested classes [before][5], [after][6] >> - inherited methods [before][7], [after][8] >> >> [1]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#nested-class-summary >> [2]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#nested-class-summary >> >> [3]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap >> [4]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap >> >> [5]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#nested-class-summary >> [6]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#nested-class-summary >> >> [7]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator >> [8]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator > > Hannes Walln?fer has updated the pull request incrementally with one additional commit since the last revision: > > Render signature of inherited method in context of the local type. I see this: > Omit type bounds and do not create separate links for type parameters in links to inherited nested classes But I also wonder if the below is acceptable information loss. Before: Spliterator.OfPrimitive> After: Spliterator.OfPrimitive ------------- PR Comment: https://git.openjdk.org/jdk/pull/22651#issuecomment-2538478657 From prappo at openjdk.org Thu Dec 12 10:30:35 2024 From: prappo at openjdk.org (Pavel Rappo) Date: Thu, 12 Dec 2024 10:30:35 GMT Subject: RFR: 8345908: Class links should be properly spaced In-Reply-To: <7I4878bgiOSeIc1jqeE1NUszJgSBLhvBLAeKxgkfNyE=.81f04634-21d6-4238-9d19-49a8e37036a8@github.com> References: <7I4878bgiOSeIc1jqeE1NUszJgSBLhvBLAeKxgkfNyE=.81f04634-21d6-4238-9d19-49a8e37036a8@github.com> Message-ID: On Tue, 10 Dec 2024 14:36:12 GMT, Hannes Walln?fer wrote: > Please review a trivial change to apply monospace font not just to the class links at the top of class and interface pages, but also to the comma and space characters between them. The comma-space separators currently use proportional font, which results in very narrow spacing that does not match the class name font. > > Using the same monospace font for everything makes individual class names more discernible, and makes it easier to pick out individual class names. This is especially true for multiline class lists such as the subinterfaces of `java.lang.Autoclosable` below. > > Before: > > class-links-old > > After: > > class-links-new Marked as reviewed by prappo (Reviewer). ------------- PR Review: https://git.openjdk.org/jdk/pull/22662#pullrequestreview-2498832118 From rgiulietti at openjdk.org Thu Dec 12 11:43:38 2024 From: rgiulietti at openjdk.org (Raffaello Giulietti) Date: Thu, 12 Dec 2024 11:43:38 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed [v2] In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 21:05:30 GMT, Magnus Ihse Bursie wrote: >> Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. >> >> I have located these modified files using: >> >> git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list >> >> and then run a script to update the copyright year to 2024 on these files. >> >> I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. > > Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision: > > Revert mistaken changes to binary files LGTM ------------- Marked as reviewed by rgiulietti (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22643#pullrequestreview-2499124132 From hannesw at openjdk.org Thu Dec 12 11:43:39 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Thu, 12 Dec 2024 11:43:39 GMT Subject: RFR: 8345777: Improve sections for inherited members [v2] In-Reply-To: <5cKJde-8h3UDHK8NLdEcOS9uD-SpUm2DDJEf90NPAno=.afa4be40-8764-4b58-8e9a-6f45c7818b24@github.com> References: <5cKJde-8h3UDHK8NLdEcOS9uD-SpUm2DDJEf90NPAno=.afa4be40-8764-4b58-8e9a-6f45c7818b24@github.com> Message-ID: On Thu, 12 Dec 2024 10:24:41 GMT, Pavel Rappo wrote: > > > Omit type bounds and do not create separate links for type parameters in links to inherited nested classes > > But I also wonder if the below is acceptable information loss. > In my opinion, it is not just acceptable but a clear improvement. Consider the benefits of the additional links for type parameters and bounds: - The type parameter links are almost completely redundant with the link to the encosing type, as type parameters are documented prominently at the top of the type documentation. - The bound on the last type parameter in this particular case doubles all the links again, leading to 8 links to basically the same resource (except for highlighting individual type parameters). I admit that the recursive bound is a special case, and a link would make more sense if it was a different type. But even in that case I would argue that it's not at the link level that we have to provide these details, and in fact we don't do that in other similar places (e.g. lists of super/implementing/extending types etc). As to the cost of providing these additional links in this context: there is a cost with every link we add in terms of demanding attention for the user, but in this case it's particularly bad, because the context (list of inherited nested classes) and the content (linked signature of generic class) both basically use the same format (a comma-separated list of links). Which is how we end up with a hairball of largely redundant links when we really wanted to provide a link to one nested class. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22651#issuecomment-2538653319 From prappo at openjdk.org Thu Dec 12 12:05:39 2024 From: prappo at openjdk.org (Pavel Rappo) Date: Thu, 12 Dec 2024 12:05:39 GMT Subject: RFR: 8345777: Improve sections for inherited members [v2] In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 18:12:15 GMT, Hannes Walln?fer wrote: >> Please review a set of changes to make the sections for inherited members in API docs more usable. >> >> - Link to the relevant member summary in the parent type instead of the top of the page in headings for inherited members >> - Omit parent type's package name in headings for inherited members >> - Add method signature as title attribute (tooltip) in links to inherited methods >> - Omit type bounds and do not create separate links for type parameters in links to inherited nested classes >> >> Before/after comparisons for methods and nested classes (the first two items also apply to other kinds of members): >> >> java.util.TreeMap: >> - inherited nested classes [before][1], [after][2] >> - inherited methods [before][3], [after][4] >> >> java.util.Spliterator.OfInt: >> - inherited nested classes [before][5], [after][6] >> - inherited methods [before][7], [after][8] >> >> [1]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#nested-class-summary >> [2]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#nested-class-summary >> >> [3]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap >> [4]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap >> >> [5]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#nested-class-summary >> [6]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#nested-class-summary >> >> [7]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator >> [8]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator > > Hannes Walln?fer has updated the pull request incrementally with one additional commit since the last revision: > > Render signature of inherited method in context of the local type. Marked as reviewed by prappo (Reviewer). ------------- PR Review: https://git.openjdk.org/jdk/pull/22651#pullrequestreview-2499213558 From jlahoda at openjdk.org Thu Dec 12 12:05:42 2024 From: jlahoda at openjdk.org (Jan Lahoda) Date: Thu, 12 Dec 2024 12:05:42 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed [v2] In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 21:05:30 GMT, Magnus Ihse Bursie wrote: >> Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. >> >> I have located these modified files using: >> >> git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list >> >> and then run a script to update the copyright year to 2024 on these files. >> >> I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. > > Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision: > > Revert mistaken changes to binary files Looks sensible to me. ------------- Marked as reviewed by jlahoda (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22643#pullrequestreview-2499212215 From prappo at openjdk.org Thu Dec 12 12:05:41 2024 From: prappo at openjdk.org (Pavel Rappo) Date: Thu, 12 Dec 2024 12:05:41 GMT Subject: RFR: 8345777: Improve sections for inherited members [v2] In-Reply-To: References: <5cKJde-8h3UDHK8NLdEcOS9uD-SpUm2DDJEf90NPAno=.afa4be40-8764-4b58-8e9a-6f45c7818b24@github.com> Message-ID: On Thu, 12 Dec 2024 11:41:26 GMT, Hannes Walln?fer wrote: > > > Omit type bounds and do not create separate links for type parameters in links to inherited nested classes > > > > > > But I also wonder if the below is acceptable information loss. > > In my opinion, it is not just acceptable but a clear improvement. Consider the benefits of the additional links for type parameters and bounds: > > * The type parameter links are almost completely redundant with the link to the encosing type, as type parameters are documented prominently at the top of the type documentation. > * The bound on the last type parameter in this particular case doubles all the links again, leading to 8 links to basically the same resource (except for highlighting individual type parameters). > > I admit that the recursive bound is a special case, and a link would make more sense if it was a different type. But even in that case I would argue that it's not at the link level that we have to provide these details, and in fact we don't do that in other similar places (e.g. lists of super/implementing/extending types etc). > > As to the cost of providing these additional links in this context: there is a cost with every link we add in terms of demanding attention for the user, but in this case it's particularly bad, because the context (list of inherited nested classes) and the content (linked signature of generic class) both basically use the same format (a comma-separated list of links). Which is how we end up with a hairball of largely redundant links when we really wanted to provide a link to one nested class. Alternatively, we can indicate that the class or interface declaration has more interesting to it by maybe placing … (`…`). ------------- PR Comment: https://git.openjdk.org/jdk/pull/22651#issuecomment-2538713103 From ihse at openjdk.org Thu Dec 12 12:09:40 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Thu, 12 Dec 2024 12:09:40 GMT Subject: RFR: 8345804: Update copyright year to 2024 for langtools in files where it was missed [v2] In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 21:05:30 GMT, Magnus Ihse Bursie wrote: >> Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. >> >> I have located these modified files using: >> >> git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list >> >> and then run a script to update the copyright year to 2024 on these files. >> >> I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. > > Magnus Ihse Bursie has updated the pull request incrementally with one additional commit since the last revision: > > Revert mistaken changes to binary files Thanks for the reviews! ------------- PR Comment: https://git.openjdk.org/jdk/pull/22643#issuecomment-2538720181 From ihse at openjdk.org Thu Dec 12 12:09:41 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Thu, 12 Dec 2024 12:09:41 GMT Subject: Integrated: 8345804: Update copyright year to 2024 for langtools in files where it was missed In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 12:55:53 GMT, Magnus Ihse Bursie wrote: > Some files have been modified in 2024, but the copyright year has not been properly updated. This should be fixed. > > I have located these modified files using: > > git log --since="Jan 1" --name-only --pretty=format: | sort -u > file.list > > and then run a script to update the copyright year to 2024 on these files. > > I have made a manual sampling of files in the list to verify that they have indeed been modified in 2024. This pull request has now been integrated. Changeset: f7f07b94 Author: Magnus Ihse Bursie URL: https://git.openjdk.org/jdk/commit/f7f07b94c57d7ac5406d78be47800cf578d1c32f Stats: 400 lines in 400 files changed: 0 ins; 0 del; 400 mod 8345804: Update copyright year to 2024 for langtools in files where it was missed Reviewed-by: rgiulietti, jlahoda ------------- PR: https://git.openjdk.org/jdk/pull/22643 From hannesw at openjdk.org Thu Dec 12 13:17:42 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Thu, 12 Dec 2024 13:17:42 GMT Subject: Integrated: 8345908: Class links should be properly spaced In-Reply-To: <7I4878bgiOSeIc1jqeE1NUszJgSBLhvBLAeKxgkfNyE=.81f04634-21d6-4238-9d19-49a8e37036a8@github.com> References: <7I4878bgiOSeIc1jqeE1NUszJgSBLhvBLAeKxgkfNyE=.81f04634-21d6-4238-9d19-49a8e37036a8@github.com> Message-ID: On Tue, 10 Dec 2024 14:36:12 GMT, Hannes Walln?fer wrote: > Please review a trivial change to apply monospace font not just to the class links at the top of class and interface pages, but also to the comma and space characters between them. The comma-space separators currently use proportional font, which results in very narrow spacing that does not match the class name font. > > Using the same monospace font for everything makes individual class names more discernible, and makes it easier to pick out individual class names. This is especially true for multiline class lists such as the subinterfaces of `java.lang.Autoclosable` below. > > Before: > > class-links-old > > After: > > class-links-new This pull request has now been integrated. Changeset: b8bb51e1 Author: Hannes Walln?fer URL: https://git.openjdk.org/jdk/commit/b8bb51e1f334c84a34e02e65e2e2789231465ab9 Stats: 27 lines in 6 files changed: 0 ins; 3 del; 24 mod 8345908: Class links should be properly spaced Reviewed-by: prappo ------------- PR: https://git.openjdk.org/jdk/pull/22662 From hannesw at openjdk.org Thu Dec 12 13:31:41 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Thu, 12 Dec 2024 13:31:41 GMT Subject: RFR: 8345777: Improve sections for inherited members [v2] In-Reply-To: References: <5cKJde-8h3UDHK8NLdEcOS9uD-SpUm2DDJEf90NPAno=.afa4be40-8764-4b58-8e9a-6f45c7818b24@github.com> Message-ID: <-nkIibuIHt--9jIoOC4RZFTmwab5ZJtlCQtEwI4zaho=.f1caeb9f-a110-4c09-b66c-a5cc19f5bb4a@github.com> On Thu, 12 Dec 2024 12:02:46 GMT, Pavel Rappo wrote: > > Alternatively, we can indicate that the class or interface declaration has more interesting to it by maybe placing ? (`…`). We could do that, but that would introduce a new way of presenting generic types where we already have different levels of type parameter details that are used throughout the documentation. Thanks for the approval! ------------- PR Comment: https://git.openjdk.org/jdk/pull/22651#issuecomment-2538922403 From hannesw at openjdk.org Thu Dec 12 13:31:42 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Thu, 12 Dec 2024 13:31:42 GMT Subject: Integrated: 8345777: Improve sections for inherited members In-Reply-To: References: Message-ID: On Mon, 9 Dec 2024 17:40:48 GMT, Hannes Walln?fer wrote: > Please review a set of changes to make the sections for inherited members in API docs more usable. > > - Link to the relevant member summary in the parent type instead of the top of the page in headings for inherited members > - Omit parent type's package name in headings for inherited members > - Add method signature as title attribute (tooltip) in links to inherited methods > - Omit type bounds and do not create separate links for type parameters in links to inherited nested classes > > Before/after comparisons for methods and nested classes (the first two items also apply to other kinds of members): > > java.util.TreeMap: > - inherited nested classes [before][1], [after][2] > - inherited methods [before][3], [after][4] > > java.util.Spliterator.OfInt: > - inherited nested classes [before][5], [after][6] > - inherited methods [before][7], [after][8] > > [1]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#nested-class-summary > [2]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#nested-class-summary > > [3]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap > [4]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/TreeMap.html#methods-inherited-from-class-java.util.AbstractMap > > [5]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#nested-class-summary > [6]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#nested-class-summary > > [7]: https://download.java.net/java/early_access/jdk25/docs/api/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator > [8]: https://cr.openjdk.org/~hannesw/8345777/api.00/java.base/java/util/Spliterator.OfInt.html#methods-inherited-from-class-java.util.Spliterator This pull request has now been integrated. Changeset: f71d5150 Author: Hannes Walln?fer URL: https://git.openjdk.org/jdk/commit/f71d51502673bc95d66aa568e98e4801613497a5 Stats: 199 lines in 16 files changed: 72 ins; 46 del; 81 mod 8345777: Improve sections for inherited members Reviewed-by: prappo ------------- PR: https://git.openjdk.org/jdk/pull/22651 From dnguyen at openjdk.org Thu Dec 12 22:38:39 2024 From: dnguyen at openjdk.org (Damon Nguyen) Date: Thu, 12 Dec 2024 22:38:39 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v2] In-Reply-To: References: Message-ID: On Tue, 10 Dec 2024 19:35:21 GMT, Justin Lu wrote: >> Please review this PR which contains the open L10n drop changes for RDP1. >> >> I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. >> >> Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. > > Justin Lu has updated the pull request incrementally with four additional commits since the last revision: > > - implement Severin's review > > Co-authored-by: Severin Gehwolf > - implement Jan's review > - implement Henry's review > - implement Weijun's review Looks like there were additional changes. Good to catch all of these and re-updating each of these spots. Hopefully the translation team can differentiate content between `<>` since similar occurred before. LGTM ------------- Marked as reviewed by dnguyen (Committer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2500910380 From hannesw at openjdk.org Fri Dec 13 11:11:08 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Fri, 13 Dec 2024 11:11:08 GMT Subject: RFR: 8345770: javadoc: API documentation builds are not always reproducible Message-ID: Please review a fix for a bug that could cause non-reproducible documentation builds and the wrong link label being used in summary pages. We used to rely on field `HtmlConfiguration.currentTypeElement` to decide whether to include the type name in member links generated from `{@link}` or `@see` tags. However, that field was only set by the `ClassWriter` and `ClassUseWriter` classes, but never unset by any other writer class, so effectively it contained the *last* instead of the *current* type element. This resulted in summary pages using non-qualified member links, depending on the last previously executing class writer. The fix is to use `HtmlDocletWriter.getCurrentTypeElement()` (previously called `getCurrentPageElement()`) instead. Note that this method returns `null` for `ClassUseWriter`, so it changes the generated documentation for class-use pages. The new behavior is preferable, because class-use pages are primarily about other classes using the class, so links to members of the used class should be qualified by the class name. A good example for this are the links to the `FALSE` and `TRUE` fields in the [class use page for java.lang.Boolean][1] which should include the class name. [1]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/class-use/Boolean.html#java.lang.constant As mentioned above I also renamed `getCurrentPageElement()` method to `getCurrentTypeElement()` and made the doc comments a bit more precise. ------------- Commit messages: - Remove unused currentTimeElement field - 8345770: javadoc: API documentation builds are not always reproducible Changes: https://git.openjdk.org/jdk/pull/22732/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22732&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345770 Stats: 42 lines in 13 files changed: 7 ins; 10 del; 25 mod Patch: https://git.openjdk.org/jdk/pull/22732.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22732/head:pull/22732 PR: https://git.openjdk.org/jdk/pull/22732 From nbenalla at openjdk.org Fri Dec 13 12:02:35 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 13 Dec 2024 12:02:35 GMT Subject: RFR: 8345770: javadoc: API documentation builds are not always reproducible In-Reply-To: References: Message-ID: <68cm-4oHodqS2QtJY9tgMExMWthSFApmtbFiy30wHOQ=.637621d7-21f7-4233-b6db-7d7c2baf6b40@github.com> On Fri, 13 Dec 2024 11:01:51 GMT, Hannes Walln?fer wrote: > Please review a fix for a bug that could cause non-reproducible documentation builds and the wrong link label being used in summary pages. > > We used to rely on field `HtmlConfiguration.currentTypeElement` to decide whether to include the type name in member links generated from `{@link}` or `@see` tags. However, that field was only set by the `ClassWriter` and `ClassUseWriter` classes, but never unset by any other writer class, so effectively it contained the *last* instead of the *current* type element. This resulted in summary pages using non-qualified member links, depending on the last previously executing class writer. > > The fix is to use `HtmlDocletWriter.getCurrentTypeElement()` (previously called `getCurrentPageElement()`) instead. Note that this method returns `null` for `ClassUseWriter`, so it changes the generated documentation for class-use pages. The new behavior is preferable, because class-use pages are primarily about other classes using the class, so links to members of the used class should be qualified by the class name. A good example for this are the links to the `FALSE` and `TRUE` fields in the [class use page for java.lang.Boolean][1] which should include the class name. > > [1]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/class-use/Boolean.html#java.lang.constant > > As mentioned above I also renamed `getCurrentPageElement()` method to `getCurrentTypeElement()` and made the doc comments a bit more precise. Great change! I compared the generated docs before/after the change and the changes are all in the`class-use` pages, where the qualified name is now used instead. List of changed files java.base/java/nio/file/attribute/class-use/AclEntryPermission.html java.base/java/math/class-use/BigDecimal.html java.base/java/lang/class-use/Boolean.html java.base/java/lang/class-use/Character.UnicodeBlock.html java.desktop/java/awt/class-use/ComponentOrientation.html java.base/java/util/concurrent/class-use/CountedCompleter.html java.desktop/java/awt/class-use/Cursor.html java.datatransfer/java/awt/datatransfer/class-use/DataFlavor.html java.base/java/net/class-use/DatagramSocket.html java.base/java/util/concurrent/class-use/ForkJoinTask.html java.desktop/javax/swing/class-use/JLayer.html java.base/java/lang/classfile/instruction/LabelTarget.html jdk.dynalink/jdk/dynalink/linker/class-use/LinkerServices.html java.base/java/util/concurrent/locks/class-use/Lock.html java.base/java/lang/invoke/class-use/MethodHandle.html java.base/java/lang/invoke/class-use/MethodHandles.Lookup.html java.base/java/lang/class-use/Object.html java.base/java/util/class-use/Optional.html java.prefs/java/util/prefs/class-use/Preferences.html java.base/java/util/concurrent/locks/class-use/ReadWriteLock.html java.base/java/net/class-use/ServerSocket.html java.base/java/net/class-use/Socket.html java.base/java/lang/class-use/String.html java.base/java/net/class-use/URL.html java.base/java/util/class-use/UUID.html java.xml/javax/xml/stream/class-use/XMLEventFactory.html java.xml/javax/xml/stream/class-use/XMLInputFactory.html java.xml/javax/xml/stream/class-use/XMLOutputFactory.html java.xml/javax/xml/xpath/class-use/XPathFactory.html ------------- Marked as reviewed by nbenalla (Committer). PR Review: https://git.openjdk.org/jdk/pull/22732#pullrequestreview-2502133175 From nbenalla at openjdk.org Fri Dec 13 16:45:42 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 13 Dec 2024 16:45:42 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v2] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Thu, 14 Nov 2024 08:01:12 GMT, Hannes Walln?fer wrote: >> Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains five additional commits since the last revision: >> >> - add file with all vetted links >> - improve some parts based on review comments >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Convert parts of doccheck into tests > > test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/BadCharacterChecker.java line 122: > >> 120: return Charset.forName(m2.group(1)); >> 121: } >> 122: return html5 ? StandardCharsets.UTF_8 : StandardCharsets.ISO_8859_1; > > What is the basis for assuming ISO-8859-1 for non-HTML5 files? I assumed text would be written in latin characters, but I guess this can be removed and we can simply use UTF8? ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1884202549 From nbenalla at openjdk.org Fri Dec 13 17:07:23 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 13 Dec 2024 17:07:23 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v3] In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains eight additional commits since the last revision: - Add a test for external links separate checks into different jtreg tests fix typos - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - add file with all vetted links - improve some parts based on review comments - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Convert parts of doccheck into tests ------------- Changes: - all: https://git.openjdk.org/jdk/pull/21879/files - new: https://git.openjdk.org/jdk/pull/21879/files/8174c67f..a5efb313 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=02 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=01-02 Stats: 68435 lines in 3533 files changed: 51634 ins; 9139 del; 7662 mod Patch: https://git.openjdk.org/jdk/pull/21879.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/21879/head:pull/21879 PR: https://git.openjdk.org/jdk/pull/21879 From nbenalla at openjdk.org Fri Dec 13 17:07:27 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 13 Dec 2024 17:07:27 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v2] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Mon, 2 Dec 2024 18:19:32 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains five additional commits since the last revision: > > - add file with all vetted links > - improve some parts based on review comments > - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit > - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit > - Convert parts of doccheck into tests I think I'd like to go for warnings instead of errors for external links, at least for a little while to avoid unnecessary failures in CI. Maybe until we let people know that they should add the external resources to the whitelist, or we setup GHA for doc tests. I split the test categories into separate jtreg tests, I think we may get away with one test per category even if it's testing all modules + specs. ------------- PR Comment: https://git.openjdk.org/jdk/pull/21879#issuecomment-2541876121 From nbenalla at openjdk.org Fri Dec 13 17:15:38 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 13 Dec 2024 17:15:38 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v3] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 13 Dec 2024 16:43:10 GMT, Nizar Benalla wrote: >> test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/BadCharacterChecker.java line 122: >> >>> 120: return Charset.forName(m2.group(1)); >>> 121: } >>> 122: return html5 ? StandardCharsets.UTF_8 : StandardCharsets.ISO_8859_1; >> >> What is the basis for assuming ISO-8859-1 for non-HTML5 files? > > I assumed text would be written in latin characters, but I guess this can be removed and we can simply use UTF8? Unicode has some characters such as bidi characters which I don't want to allow but this test should only check for bistrot and character encoding, so UTF_8 could work as a default. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1884240869 From nbenalla at openjdk.org Sat Dec 14 21:04:42 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Sat, 14 Dec 2024 21:04:42 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v3] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Thu, 14 Nov 2024 08:21:51 GMT, Hannes Walln?fer wrote: >> Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains eight additional commits since the last revision: >> >> - Add a test for external links >> separate checks into different jtreg tests >> fix typos >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - add file with all vetted links >> - improve some parts based on review comments >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Convert parts of doccheck into tests > > test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/DocTypeChecker.java line 77: > >> 75: + "\\s+([a-z]+)" >> 76: + "\\s+\"([^\"]+)\"" >> 77: + "(?:\\s+\"([^\"]+)\")?" > > Where is this part of the doctype specified? It can match the string `:legacy-compat` in `` or `` ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1885388066 From jjg at openjdk.org Sat Dec 14 21:13:36 2024 From: jjg at openjdk.org (Jonathan Gibbons) Date: Sat, 14 Dec 2024 21:13:36 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v3] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 13 Dec 2024 17:12:56 GMT, Nizar Benalla wrote: >> I assumed text would be written in latin characters, but I guess this can be removed and we can simply use UTF8? > > Unicode has some characters such as bidi characters which I don't want to allow but this test should only check for bistrot and character encoding, so UTF_8 could work as a default. Note that JDK source code is inconsistent. The makefile commands for `javac` specify just ASCII (since forever) but the `javadoc` commands allow ISO-8859-1, which was popular before the widespread acceptance of UTF-8. Ideally, all should be self-consistent -- JDK policy, `javac` commands, `javadoc` commands, DocCheck, etc. Note that resource files might use different encodings to `*.java` source files. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1885390363 From nbenalla at openjdk.org Sun Dec 15 21:26:50 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Sun, 15 Dec 2024 21:26:50 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v4] In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Nizar Benalla has updated the pull request incrementally with two additional commits since the last revision: - Rename method and usage to be more concise - make regex more rebust in case of single quote in legacy doctype ------------- Changes: - all: https://git.openjdk.org/jdk/pull/21879/files - new: https://git.openjdk.org/jdk/pull/21879/files/a5efb313..964ca5e2 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=03 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=02-03 Stats: 11 lines in 4 files changed: 0 ins; 0 del; 11 mod Patch: https://git.openjdk.org/jdk/pull/21879.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/21879/head:pull/21879 PR: https://git.openjdk.org/jdk/pull/21879 From liach at openjdk.org Sun Dec 15 23:13:36 2024 From: liach at openjdk.org (Chen Liang) Date: Sun, 15 Dec 2024 23:13:36 GMT Subject: RFR: 8345770: javadoc: API documentation builds are not always reproducible In-Reply-To: References: Message-ID: On Fri, 13 Dec 2024 11:01:51 GMT, Hannes Walln?fer wrote: > Please review a fix for a bug that could cause non-reproducible documentation builds and the wrong link label being used in summary pages. > > We used to rely on field `HtmlConfiguration.currentTypeElement` to decide whether to include the type name in member links generated from `{@link}` or `@see` tags. However, that field was only set by the `ClassWriter` and `ClassUseWriter` classes, but never unset by any other writer class, so effectively it contained the *last* instead of the *current* type element. This resulted in summary pages using non-qualified member links, depending on the last previously executing class writer. > > The fix is to use `HtmlDocletWriter.getCurrentTypeElement()` (previously called `getCurrentPageElement()`) instead. Note that this method returns `null` for `ClassUseWriter`, so it changes the generated documentation for class-use pages. The new behavior is preferable, because class-use pages are primarily about other classes using the class, so links to members of the used class should be qualified by the class name. A good example for this are the links to the `FALSE` and `TRUE` fields in the [class use page for java.lang.Boolean][1] which should include the class name. > > [1]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/class-use/Boolean.html#java.lang.constant > > As mentioned above I also renamed `getCurrentPageElement()` method to `getCurrentTypeElement()` and made the doc comments a bit more precise. Code change makes sense. ------------- Marked as reviewed by liach (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22732#pullrequestreview-2504799473 From hannesw at openjdk.org Mon Dec 16 08:12:40 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 16 Dec 2024 08:12:40 GMT Subject: Integrated: 8345770: javadoc: API documentation builds are not always reproducible In-Reply-To: References: Message-ID: <0xSsxRA9v2fLzu0I6LcOxxe-kp1gjYy5gTDU5FTF4ZU=.c6be798d-6b06-43d8-8626-efcb421d202a@github.com> On Fri, 13 Dec 2024 11:01:51 GMT, Hannes Walln?fer wrote: > Please review a fix for a bug that could cause non-reproducible documentation builds and the wrong link label being used in summary pages. > > We used to rely on field `HtmlConfiguration.currentTypeElement` to decide whether to include the type name in member links generated from `{@link}` or `@see` tags. However, that field was only set by the `ClassWriter` and `ClassUseWriter` classes, but never unset by any other writer class, so effectively it contained the *last* instead of the *current* type element. This resulted in summary pages using non-qualified member links, depending on the last previously executing class writer. > > The fix is to use `HtmlDocletWriter.getCurrentTypeElement()` (previously called `getCurrentPageElement()`) instead. Note that this method returns `null` for `ClassUseWriter`, so it changes the generated documentation for class-use pages. The new behavior is preferable, because class-use pages are primarily about other classes using the class, so links to members of the used class should be qualified by the class name. A good example for this are the links to the `FALSE` and `TRUE` fields in the [class use page for java.lang.Boolean][1] which should include the class name. > > [1]: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/lang/class-use/Boolean.html#java.lang.constant > > As mentioned above I also renamed `getCurrentPageElement()` method to `getCurrentTypeElement()` and made the doc comments a bit more precise. This pull request has now been integrated. Changeset: 4fc43b0b Author: Hannes Walln?fer URL: https://git.openjdk.org/jdk/commit/4fc43b0b49c3d7c4351646f2580860495d8a0d67 Stats: 42 lines in 13 files changed: 7 ins; 10 del; 25 mod 8345770: javadoc: API documentation builds are not always reproducible Reviewed-by: nbenalla, liach ------------- PR: https://git.openjdk.org/jdk/pull/22732 From jlu at openjdk.org Mon Dec 16 19:23:55 2024 From: jlu at openjdk.org (Justin Lu) Date: Mon, 16 Dec 2024 19:23:55 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v3] In-Reply-To: References: Message-ID: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. Justin Lu has updated the pull request incrementally with two additional commits since the last revision: - Merge remote-tracking branch 'origin/JDK-8345327-L10N' into JDK-8345327-L10N - implement Naoto's review ------------- Changes: - all: https://git.openjdk.org/jdk/pull/22588/files - new: https://git.openjdk.org/jdk/pull/22588/files/143e22ea..463ef9fc Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=22588&range=02 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=22588&range=01-02 Stats: 1 line in 1 file changed: 0 ins; 0 del; 1 mod Patch: https://git.openjdk.org/jdk/pull/22588.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22588/head:pull/22588 PR: https://git.openjdk.org/jdk/pull/22588 From naoto at openjdk.org Mon Dec 16 19:23:55 2024 From: naoto at openjdk.org (Naoto Sato) Date: Mon, 16 Dec 2024 19:23:55 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v3] In-Reply-To: References: Message-ID: On Mon, 16 Dec 2024 19:20:54 GMT, Justin Lu wrote: >> Please review this PR which contains the open L10n drop changes for RDP1. >> >> I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. >> >> Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. > > Justin Lu has updated the pull request incrementally with two additional commits since the last revision: > > - Merge remote-tracking branch 'origin/JDK-8345327-L10N' into JDK-8345327-L10N > - implement Naoto's review LGTM ------------- Marked as reviewed by naoto (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22588#pullrequestreview-2507065268 From jlu at openjdk.org Mon Dec 16 21:03:43 2024 From: jlu at openjdk.org (Justin Lu) Date: Mon, 16 Dec 2024 21:03:43 GMT Subject: RFR: 8345327: JDK 24 RDP1 L10n resource files update [v3] In-Reply-To: References: Message-ID: <8dpjCH8cnuHNOyKchKDhnPunFlgWE4TtuWgyOUbP1mM=.19052704-1cad-472d-9546-60f908a143a6@github.com> On Mon, 16 Dec 2024 19:23:55 GMT, Justin Lu wrote: >> Please review this PR which contains the open L10n drop changes for RDP1. >> >> I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. >> >> Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. > > Justin Lu has updated the pull request incrementally with two additional commits since the last revision: > > - Merge remote-tracking branch 'origin/JDK-8345327-L10N' into JDK-8345327-L10N > - implement Naoto's review Thank you all for the reviews. ------------- PR Comment: https://git.openjdk.org/jdk/pull/22588#issuecomment-2546751576 From jlu at openjdk.org Mon Dec 16 21:03:44 2024 From: jlu at openjdk.org (Justin Lu) Date: Mon, 16 Dec 2024 21:03:44 GMT Subject: Integrated: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Thu, 5 Dec 2024 22:36:12 GMT, Justin Lu wrote: > Please review this PR which contains the open L10n drop changes for RDP1. > > I recommend viewing the improved diffs which are built out by Jon's tool here: https://cr.openjdk.org/~jlu/output/. As always, I can not confirm the correctness on the quality of the translations themselves. > > Generally speaking, observed differences in punctuation can be attributed to language rules. Any keys requiring localization that came in after the JDK was submitted for translations will be handled in the RDP2 L10n drop. This pull request has now been integrated. Changeset: fd0207d5 Author: Justin Lu URL: https://git.openjdk.org/jdk/commit/fd0207d59309ae1af9539580f5bfcbc7627789cb Stats: 402 lines in 46 files changed: 169 ins; 123 del; 110 mod 8345327: JDK 24 RDP1 L10n resource files update Reviewed-by: naoto, dnguyen, joehw, almatvee, sgehwolf, jlahoda, prappo, asemenyuk ------------- PR: https://git.openjdk.org/jdk/pull/22588 From jlu at openjdk.org Mon Dec 16 23:20:47 2024 From: jlu at openjdk.org (Justin Lu) Date: Mon, 16 Dec 2024 23:20:47 GMT Subject: [jdk24] RFR: 8345327: JDK 24 RDP1 L10n resource files update Message-ID: Hi all, This pull request contains a backport of commit [fd0207d5](https://github.com/openjdk/jdk/commit/fd0207d59309ae1af9539580f5bfcbc7627789cb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. The commit being backported was authored by Justin Lu on 16 Dec 2024 and was reviewed by Naoto Sato, Damon Nguyen, Joe Wang, Alexander Matveev, Severin Gehwolf, Jan Lahoda, Pavel Rappo and Alexey Semenyuk. Thanks! ------------- Commit messages: - Backport fd0207d59309ae1af9539580f5bfcbc7627789cb Changes: https://git.openjdk.org/jdk/pull/22775/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22775&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8345327 Stats: 402 lines in 46 files changed: 169 ins; 123 del; 110 mod Patch: https://git.openjdk.org/jdk/pull/22775.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22775/head:pull/22775 PR: https://git.openjdk.org/jdk/pull/22775 From naoto at openjdk.org Tue Dec 17 17:12:49 2024 From: naoto at openjdk.org (Naoto Sato) Date: Tue, 17 Dec 2024 17:12:49 GMT Subject: [jdk24] RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Mon, 16 Dec 2024 23:15:11 GMT, Justin Lu wrote: > Hi all, > > This pull request contains a backport of commit [fd0207d5](https://github.com/openjdk/jdk/commit/fd0207d59309ae1af9539580f5bfcbc7627789cb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > The commit being backported was authored by Justin Lu on 16 Dec 2024 and was reviewed by Naoto Sato, Damon Nguyen, Joe Wang, Alexander Matveev, Severin Gehwolf, Jan Lahoda, Pavel Rappo and Alexey Semenyuk. > > Thanks! Backport LGTM ------------- Marked as reviewed by naoto (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22775#pullrequestreview-2509542756 From dnguyen at openjdk.org Tue Dec 17 23:22:36 2024 From: dnguyen at openjdk.org (Damon Nguyen) Date: Tue, 17 Dec 2024 23:22:36 GMT Subject: [jdk24] RFR: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Mon, 16 Dec 2024 23:15:11 GMT, Justin Lu wrote: > Hi all, > > This pull request contains a backport of commit [fd0207d5](https://github.com/openjdk/jdk/commit/fd0207d59309ae1af9539580f5bfcbc7627789cb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > The commit being backported was authored by Justin Lu on 16 Dec 2024 and was reviewed by Naoto Sato, Damon Nguyen, Joe Wang, Alexander Matveev, Severin Gehwolf, Jan Lahoda, Pavel Rappo and Alexey Semenyuk. > > Thanks! Backports look good. ------------- Marked as reviewed by dnguyen (Committer). PR Review: https://git.openjdk.org/jdk/pull/22775#pullrequestreview-2510380836 From ihse at openjdk.org Wed Dec 18 17:06:02 2024 From: ihse at openjdk.org (Magnus Ihse Bursie) Date: Wed, 18 Dec 2024 17:06:02 GMT Subject: RFR: 8344191: Build code should not have classpath exception [v2] In-Reply-To: References: Message-ID: > In several (most? all?) of the build system files, the copyright header includes the classpath exception. This makes no sense, and should be removed. > > I have removed the classpath exception from makefiles, autoconf, shell scripts, properties files, configuration files, IDE support files, build tools and data. > > The only places where the classpath exception is still kept in the make directory is as text strings in some build tools, which generate source code that is bundled with `src.zip`, and thus *must* have the classpath exception. > > This is a huge and autogenerated, but content-wise trivial, PR, and I know such are hard to review. I recommend looking at the entire diff file instead of checking this file-by-file in the Github web GUI. (That's bound to be a painful experience) Magnus Ihse Bursie has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains three commits: - Merge branch 'master' into remove-build-classpath-exception - Update build tools, data and IDE support - Update makefiles, autoconf, shell scripts, properties files and configuration files ------------- Changes: https://git.openjdk.org/jdk/pull/22104/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22104&range=01 Stats: 1994 lines in 555 files changed: 0 ins; 1120 del; 874 mod Patch: https://git.openjdk.org/jdk/pull/22104.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22104/head:pull/22104 PR: https://git.openjdk.org/jdk/pull/22104 From asemenyuk at openjdk.org Wed Dec 18 18:58:40 2024 From: asemenyuk at openjdk.org (Alexey Semenyuk) Date: Wed, 18 Dec 2024 18:58:40 GMT Subject: RFR: 8344191: Build code should not have classpath exception [v2] In-Reply-To: References: Message-ID: On Wed, 18 Dec 2024 17:06:02 GMT, Magnus Ihse Bursie wrote: >> In several (most? all?) of the build system files, the copyright header includes the classpath exception. This makes no sense, and should be removed. >> >> I have removed the classpath exception from makefiles, autoconf, shell scripts, properties files, configuration files, IDE support files, build tools and data. >> >> The only places where the classpath exception is still kept in the make directory is as text strings in some build tools, which generate source code that is bundled with `src.zip`, and thus *must* have the classpath exception. >> >> This is a huge and autogenerated, but content-wise trivial, PR, and I know such are hard to review. I recommend looking at the entire diff file instead of checking this file-by-file in the Github web GUI. (That's bound to be a painful experience) > > Magnus Ihse Bursie has updated the pull request with a new target base due to a merge or a rebase. The pull request now contains three commits: > > - Merge branch 'master' into remove-build-classpath-exception > - Update build tools, data and IDE support > - Update makefiles, autoconf, shell scripts, properties files and configuration files jpackage changes look good. $0.02 ------------- Marked as reviewed by asemenyuk (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/22104#pullrequestreview-2512625117 From hannesw at openjdk.org Thu Dec 19 15:37:39 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Thu, 19 Dec 2024 15:37:39 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v4] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Sun, 15 Dec 2024 21:26:50 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with two additional commits since the last revision: > > - Rename method and usage to be more concise > - make regex more rebust in case of single quote in legacy doctype test/docs/jdk/javadoc/doccheck/ExtLinksJdk.txt line 1: > 1: http://cldr.unicode.org/ One thing that would be nice to have (and easy to implement) is to treat lines starting with `#` as comments and add a few lines at the top of the file describing the purpose of this file and how to add new links. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1892513087 From hannesw at openjdk.org Thu Dec 19 15:55:50 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Thu, 19 Dec 2024 15:55:50 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v3] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 13 Dec 2024 17:07:23 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains eight additional commits since the last revision: > > - Add a test for external links > separate checks into different jtreg tests > fix typos > - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit > - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit > - add file with all vetted links > - improve some parts based on review comments > - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit > - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit > - Convert parts of doccheck into tests test/docs/jdk/javadoc/doccheck/ExtLinksJdk.txt line 266: > 264: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/math/BigDecimal.html > 265: https://docs.oracle.com/en/java/javase/23/docs/specs/man/java.html > 266: https://docs.oracle.com/en/java/javase/24/docs/specs/man/java.html Is this right that some links are left pointing to version 23 and 24 resources, while most are updated to 25? I'm afraid it will be unpractical to manually update these links twice a year, so we should use some placeholder/macro to insert the current feature release. But that will only work if the links are also generated uniformly with the current feature release (for example by the `@extLink` taglet). ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1892568276 From nbenalla at openjdk.org Thu Dec 19 16:19:46 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Thu, 19 Dec 2024 16:19:46 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v3] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Thu, 19 Dec 2024 15:52:52 GMT, Hannes Walln?fer wrote: >> Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains eight additional commits since the last revision: >> >> - Add a test for external links >> separate checks into different jtreg tests >> fix typos >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - add file with all vetted links >> - improve some parts based on review comments >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit >> - Convert parts of doccheck into tests > > test/docs/jdk/javadoc/doccheck/ExtLinksJdk.txt line 266: > >> 264: https://docs.oracle.com/en/java/javase/23/docs/api/java.base/java/math/BigDecimal.html >> 265: https://docs.oracle.com/en/java/javase/23/docs/specs/man/java.html >> 266: https://docs.oracle.com/en/java/javase/24/docs/specs/man/java.html > > Is this right that some links are left pointing to version 23 and 24 resources, while most are updated to 25? > I'm afraid it will be unpractical to manually update these links twice a year, so we should use some placeholder/macro to insert the current feature release. But that will only work if the links are also generated uniformly with the current feature release (for example by the `@extLink` taglet). The [java man page ](https://docs.oracle.com/en/java/javase/21/docs/specs/man/java.html#removed-java-options) has links to previous releases (I think these are added manually). `SourceVersion.java` and `ClassFileFormatVersion.java` have hardcoded links to jls24 and jvms24 links, as in: * @see * The Java Language Specification, Java SE 24 Edition */ RELEASE_24, Not 100% sure but I think anything that isn't pointing to `se25` is hardcoded to point to a different link, I could use a special macro for the current `se25` links (something like `@VERSION@` and then substitute it when reading from the file). ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1892633966 From jlu at openjdk.org Thu Dec 19 22:11:42 2024 From: jlu at openjdk.org (Justin Lu) Date: Thu, 19 Dec 2024 22:11:42 GMT Subject: [jdk24] Integrated: 8345327: JDK 24 RDP1 L10n resource files update In-Reply-To: References: Message-ID: On Mon, 16 Dec 2024 23:15:11 GMT, Justin Lu wrote: > Hi all, > > This pull request contains a backport of commit [fd0207d5](https://github.com/openjdk/jdk/commit/fd0207d59309ae1af9539580f5bfcbc7627789cb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > The commit being backported was authored by Justin Lu on 16 Dec 2024 and was reviewed by Naoto Sato, Damon Nguyen, Joe Wang, Alexander Matveev, Severin Gehwolf, Jan Lahoda, Pavel Rappo and Alexey Semenyuk. > > Thanks! This pull request has now been integrated. Changeset: f0ada9f3 Author: Justin Lu URL: https://git.openjdk.org/jdk/commit/f0ada9f34e2a768c0dbcb2ed4ff0fe4019fdee9c Stats: 402 lines in 46 files changed: 169 ins; 123 del; 110 mod 8345327: JDK 24 RDP1 L10n resource files update Reviewed-by: naoto, dnguyen Backport-of: fd0207d59309ae1af9539580f5bfcbc7627789cb ------------- PR: https://git.openjdk.org/jdk/pull/22775 From nbenalla at openjdk.org Fri Dec 20 11:53:37 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 11:53:37 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v4] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: <8IzwyD0MjbLmh8k0P0rmVLld1QXUZ95QXVIK_2cBZ9g=.17c3fe35-d76d-42ff-a7fc-33ebdfbc09b9@github.com> On Sun, 15 Dec 2024 21:26:50 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with two additional commits since the last revision: > > - Rename method and usage to be more concise > - make regex more rebust in case of single quote in legacy doctype I forgot to link this issue. ------------- PR Comment: https://git.openjdk.org/jdk/pull/21879#issuecomment-2556849935 From nbenalla at openjdk.org Fri Dec 20 14:55:54 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 14:55:54 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v5] In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Nizar Benalla has updated the pull request with a new target base due to a merge or a rebase. The incremental webrev excludes the unrelated changes brought in by the merge/rebase. The pull request contains 12 additional commits since the last revision: - Improve external link checker, swapping the number of the latest release using a regex - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Rename method and usage to be more concise - make regex more rebust in case of single quote in legacy doctype - Add a test for external links separate checks into different jtreg tests fix typos - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - add file with all vetted links - improve some parts based on review comments - Merge remote-tracking branch 'upstream/master' into new-docs-tests-suit - ... and 2 more: https://git.openjdk.org/jdk/compare/71ced4ac...0857f83a ------------- Changes: - all: https://git.openjdk.org/jdk/pull/21879/files - new: https://git.openjdk.org/jdk/pull/21879/files/964ca5e2..0857f83a Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=04 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=03-04 Stats: 15981 lines in 564 files changed: 11526 ins; 2508 del; 1947 mod Patch: https://git.openjdk.org/jdk/pull/21879.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/21879/head:pull/21879 PR: https://git.openjdk.org/jdk/pull/21879 From nbenalla at openjdk.org Fri Dec 20 15:02:17 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 15:02:17 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: fix whitespace ------------- Changes: - all: https://git.openjdk.org/jdk/pull/21879/files - new: https://git.openjdk.org/jdk/pull/21879/files/0857f83a..1cf57156 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=05 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=04-05 Stats: 2 lines in 1 file changed: 0 ins; 1 del; 1 mod Patch: https://git.openjdk.org/jdk/pull/21879.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/21879/head:pull/21879 PR: https://git.openjdk.org/jdk/pull/21879 From nbenalla at openjdk.org Fri Dec 20 15:02:17 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 15:02:17 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v4] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Thu, 19 Dec 2024 15:35:14 GMT, Hannes Walln?fer wrote: >> Nizar Benalla has updated the pull request incrementally with two additional commits since the last revision: >> >> - Rename method and usage to be more concise >> - make regex more rebust in case of single quote in legacy doctype > > test/docs/jdk/javadoc/doccheck/ExtLinksJdk.txt line 1: > >> 1: http://cldr.unicode.org/ > > One thing that would be nice to have (and easy to implement) is to treat lines starting with `#` as comments and add a few lines at the top of the file describing the purpose of this file and how to add new links. Fixed, thanks! ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894041781 From nbenalla at openjdk.org Fri Dec 20 15:06:41 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 15:06:41 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 20 Dec 2024 15:02:17 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: > > fix whitespace I've added a small message at beginning on the whitelist file, and copied part of `Linkchecker#foundReference` to `ExternalLinkChecker#foundReference` to make it a bit more robust. Lines starting with `#` are ignored and I use a special string `@@JAVASE_VERSION@@` to denote the current release. Additionally, I'd like to backport this to JDK 24, what do you think? ------------- PR Comment: https://git.openjdk.org/jdk/pull/21879#issuecomment-2557176885 From hannesw at openjdk.org Fri Dec 20 15:57:38 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Fri, 20 Dec 2024 15:57:38 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 20 Dec 2024 15:02:17 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: > > fix whitespace test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/ExtLinkChecker.java line 55: > 53: extLinks.addAll(input.lines() > 54: .map(line -> line.replaceAll("\\@\\@JAVASE_VERSION\\@\\@", String.valueOf(Runtime.version().feature()))) > 55: .filter(line -> !line.startsWith("#")) Nitpicking for mostly aesthetic reasons, but it would be nice to do the filter before the map, and pull the `String.valueof(...)` out into a variable. test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/ExtLinkChecker.java line 110: > 108: > 109: // The checker runs into a problem with links that have more than one hash character. > 110: // You cannot create a URI unless you convert the second hash character into Unfinished sentence, you could say "... unless the second hash is escaped." test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/LinkChecker.java line 367: > 365: } > 366: > 367: static class URIComparator implements Comparator { It looks like this class is unused, is there a need for it given that `URI` implements `Comparable`? ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894101103 PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894102493 PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894091269 From hannesw at openjdk.org Fri Dec 20 16:04:39 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Fri, 20 Dec 2024 16:04:39 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: <7vqtJxJAftVcYGf-ut58L1byZuwSgHlvdfAAekRcneI=.a7397daf-742a-48c9-8545-321356e7536d@github.com> On Fri, 20 Dec 2024 15:02:17 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: > > fix whitespace test/docs/jdk/javadoc/doccheck/doccheckutils/FileProcessor.java line 61: > 59: }); > 60: } catch (IOException e) { > 61: e.printStackTrace(); What's the reason to swallow exceptions here? ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894111262 From nbenalla at openjdk.org Fri Dec 20 17:37:37 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 17:37:37 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: <7vqtJxJAftVcYGf-ut58L1byZuwSgHlvdfAAekRcneI=.a7397daf-742a-48c9-8545-321356e7536d@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> <7vqtJxJAftVcYGf-ut58L1byZuwSgHlvdfAAekRcneI=.a7397daf-742a-48c9-8545-321356e7536d@github.com> Message-ID: On Fri, 20 Dec 2024 16:01:53 GMT, Hannes Walln?fer wrote: >> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: >> >> fix whitespace > > test/docs/jdk/javadoc/doccheck/doccheckutils/FileProcessor.java line 61: > >> 59: }); >> 60: } catch (IOException e) { >> 61: e.printStackTrace(); > > What's the reason to swallow exceptions here? I could let the exception propagate, I just didn't think it was interesting. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894209487 From nbenalla at openjdk.org Fri Dec 20 18:13:41 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 18:13:41 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: <0tLHjhPv3uhv8qucmp4nJXhePAwdzm1y4aVcI2WdCms=.2a553418-cdb1-483d-a533-5dddf52f558a@github.com> On Fri, 20 Dec 2024 15:43:31 GMT, Hannes Walln?fer wrote: >> Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: >> >> fix whitespace > > test/docs/jdk/javadoc/doccheck/doccheckutils/checkers/LinkChecker.java line 367: > >> 365: } >> 366: >> 367: static class URIComparator implements Comparator { > > It looks like this class is unused, is there a need for it given that `URI` implements `Comparable`? Will remove it, it could be used to print out links in the same order everytime but it doesn't seem important now. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894244899 From nbenalla at openjdk.org Fri Dec 20 19:34:21 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 19:34:21 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v7] In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: Changes based on Hannes suggestions and running a linter. ------------- Changes: - all: https://git.openjdk.org/jdk/pull/21879/files - new: https://git.openjdk.org/jdk/pull/21879/files/1cf57156..95f61e68 Webrevs: - full: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=06 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=21879&range=05-06 Stats: 51 lines in 7 files changed: 3 ins; 30 del; 18 mod Patch: https://git.openjdk.org/jdk/pull/21879.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/21879/head:pull/21879 PR: https://git.openjdk.org/jdk/pull/21879 From nbenalla at openjdk.org Fri Dec 20 19:34:21 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Fri, 20 Dec 2024 19:34:21 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v6] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> <7vqtJxJAftVcYGf-ut58L1byZuwSgHlvdfAAekRcneI=.a7397daf-742a-48c9-8545-321356e7536d@github.com> Message-ID: <-c67X_wVaJHFvPjpwBCxqD5iSP3VrngXxjff04ivj6E=.5c593b45-ee39-4164-8185-994854f5a7dc@github.com> On Fri, 20 Dec 2024 17:35:28 GMT, Nizar Benalla wrote: >> test/docs/jdk/javadoc/doccheck/doccheckutils/FileProcessor.java line 61: >> >>> 59: }); >>> 60: } catch (IOException e) { >>> 61: e.printStackTrace(); >> >> What's the reason to swallow exceptions here? > > I could let the exception propagate, I just didn't think it was interesting. I think I fixed this in [95f61e6](https://github.com/openjdk/jdk/pull/21879/commits/95f61e688eb19b3696c5b342f34f3ff58d733037) (alongside a couple other things that popped up when I ran a linter on the code). I know those files exist, so it should really never be thrown. ------------- PR Review Comment: https://git.openjdk.org/jdk/pull/21879#discussion_r1894315556 From hannesw at openjdk.org Mon Dec 23 10:54:37 2024 From: hannesw at openjdk.org (Hannes =?UTF-8?B?V2FsbG7DtmZlcg==?=) Date: Mon, 23 Dec 2024 10:54:37 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v7] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 20 Dec 2024 19:34:21 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: > > Changes based on Hannes suggestions and running a linter. I think this new suite of doc dtests looks good and is ready to be integrated. Kudos for the substantial contribution! One concern I still have is the potential of breakage in vetted links when rolling over to a new release. But I guess we can still come up with a more version macro in case that is a problem (for example accepting both latest release and latest - 1). ------------- Marked as reviewed by hannesw (Reviewer). PR Review: https://git.openjdk.org/jdk/pull/21879#pullrequestreview-2520361628 From nbenalla at openjdk.org Mon Dec 23 13:55:47 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Mon, 23 Dec 2024 13:55:47 GMT Subject: RFR: 8337111: Bad HTML checker for generated documentation [v7] In-Reply-To: References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Fri, 20 Dec 2024 19:34:21 GMT, Nizar Benalla wrote: >> Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. >> >> This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. >> >> Here is an example of the output after running all tests on `api/java.base` >> >> Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. >> >> >> >> STDOUT: >> STDERR: >> test: test >> Tidy found errors in the generated HTML >> /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined >> Tidy output end. >> >> >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure >> api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure >> api/java.base/java/lang/Class.html:323: name already declared: nest >> api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted >> >> Link Checker Report >> Checked 3446 files. >> Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. >> 1 duplicate ids >> 3 missing ids >> >> Hosts >> 20 docs.oracle.com >> 1 tools.ietf.org >> 1 www.ietf.org >> 1 jcp.org >> 4 www.rfc-editor.org >> 7 unicode.org >> 10 www.unicode.org >> 20 www.w3.org >> Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] >> java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.Ru... > > Nizar Benalla has updated the pull request incrementally with one additional commit since the last revision: > > Changes based on Hannes suggestions and running a linter. Thanks for all the reviews Hannes! here goes. ------------- PR Comment: https://git.openjdk.org/jdk/pull/21879#issuecomment-2559744505 From nbenalla at openjdk.org Mon Dec 23 13:55:48 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Mon, 23 Dec 2024 13:55:48 GMT Subject: Integrated: 8337111: Bad HTML checker for generated documentation In-Reply-To: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> References: <7evTTkWDt4lHJGN1N_BLMkj22f79Z0ottKQomgnjvhE=.499ad591-e118-4a74-8d8e-8d913c25a72f@github.com> Message-ID: On Mon, 4 Nov 2024 15:43:40 GMT, Nizar Benalla wrote: > Doccheck's human-generated reports are great at previewing a "chessboard" of results. Giving reader a quick glimpse at the quality/health of the documentation. But these tests needed to be automated and they didn't easily translate to something that can be integrated into a CI. > > This PR includes an HTML and internal link test on `api/java.base` and a BadChars and Doctype test on the entire generated documentation bundle. > > Here is an example of the output after running all tests on `api/java.base` > > Note: There is an active PR to fix the broken anchors left in `java.base` so this is not a blocker. > > > > STDOUT: > STDERR: > test: test > Tidy found errors in the generated HTML > /Users/nizarbenalla/Work/jdk-repos/jdk1/build/macosx-aarch64/images/docs/api/java.base/java/lang/Class.html:323:87: Warning: anchor "nest" already defined > Tidy output end. > > > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html:245: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnFailure.html#TreeStructure > api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html:242: id not found: api/java.base/java/util/concurrent/StructuredTaskScope.ShutdownOnSuccess.html#TreeStructure > api/java.base/java/lang/Class.html:323: name already declared: nest > api/java.base/java/lang/Module.html:291: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/Module.html:434: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > api/java.base/java/lang/foreign/MemorySegment.html:725: id not found: api/java.base/java/lang/foreign/package-summary.html#restricted > > Link Checker Report > Checked 3446 files. > Found 445059 references to 48205 anchors in 5770 files and 64 other URIs. > 1 duplicate ids > 3 missing ids > > Hosts > 20 docs.oracle.com > 1 tools.ietf.org > 1 www.ietf.org > 1 jcp.org > 4 www.rfc-editor.org > 7 unicode.org > 10 www.unicode.org > 20 www.w3.org > Exception running test test: java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Missing Files: 0, Bad Schemes: 0] > java.lang.Exception: One or more HTML checkers failed: [java.lang.RuntimeException: Tidy found errors in the generated HTML, java.lang.RuntimeException: LinkChecker encountered errors. Duplicate IDs: 1, Missing IDs: 3, Mi... This pull request has now been integrated. Changeset: ed292318 Author: Nizar Benalla URL: https://git.openjdk.org/jdk/commit/ed292318a98163b3226aa05d06825b48c3d97dbb Stats: 3082 lines in 18 files changed: 3038 ins; 44 del; 0 mod 8337111: Bad HTML checker for generated documentation 8337113: Bad character checker for generated documentation 8337116: Internal links checker for generated documentation 8337114: DocType checker for generated documentation Reviewed-by: hannesw ------------- PR: https://git.openjdk.org/jdk/pull/21879 From nbenalla at openjdk.org Wed Dec 25 16:25:38 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Wed, 25 Dec 2024 16:25:38 GMT Subject: [jdk24] RFR: 8337111: Bad HTML checker for generated documentation Message-ID: Hi all, This pull request contains a backport of commit [ed292318](https://github.com/openjdk/jdk/commit/ed292318a98163b3226aa05d06825b48c3d97dbb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. The commit being backported was authored by Nizar Benalla on 23 Dec 2024 and was reviewed by Hannes Walln?fer. Thanks! Note: https://github.com/openjdk/jdk/pull/22844 needs to be integrated before this change. ------------- Commit messages: - Backport ed292318a98163b3226aa05d06825b48c3d97dbb Changes: https://git.openjdk.org/jdk/pull/22866/files Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=22866&range=00 Issue: https://bugs.openjdk.org/browse/JDK-8337111 Stats: 3082 lines in 18 files changed: 3038 ins; 44 del; 0 mod Patch: https://git.openjdk.org/jdk/pull/22866.diff Fetch: git fetch https://git.openjdk.org/jdk.git pull/22866/head:pull/22866 PR: https://git.openjdk.org/jdk/pull/22866 From prappo at openjdk.org Wed Dec 25 16:25:38 2024 From: prappo at openjdk.org (Pavel Rappo) Date: Wed, 25 Dec 2024 16:25:38 GMT Subject: [jdk24] RFR: 8337111: Bad HTML checker for generated documentation In-Reply-To: References: Message-ID: On Mon, 23 Dec 2024 14:21:24 GMT, Nizar Benalla wrote: > Hi all, > > This pull request contains a backport of commit [ed292318](https://github.com/openjdk/jdk/commit/ed292318a98163b3226aa05d06825b48c3d97dbb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > The commit being backported was authored by Nizar Benalla on 23 Dec 2024 and was reviewed by Hannes Walln?fer. > > Thanks! > > Note: https://github.com/openjdk/jdk/pull/22844 needs to be integrated before this change. Marked as reviewed by prappo (Reviewer). ------------- PR Review: https://git.openjdk.org/jdk/pull/22866#pullrequestreview-2522631422 From nbenalla at openjdk.org Mon Dec 30 11:28:44 2024 From: nbenalla at openjdk.org (Nizar Benalla) Date: Mon, 30 Dec 2024 11:28:44 GMT Subject: [jdk24] Integrated: 8337111: Bad HTML checker for generated documentation In-Reply-To: References: Message-ID: On Mon, 23 Dec 2024 14:21:24 GMT, Nizar Benalla wrote: > Hi all, > > This pull request contains a backport of commit [ed292318](https://github.com/openjdk/jdk/commit/ed292318a98163b3226aa05d06825b48c3d97dbb) from the [openjdk/jdk](https://git.openjdk.org/jdk) repository. > > The commit being backported was authored by Nizar Benalla on 23 Dec 2024 and was reviewed by Hannes Walln?fer. > > Thanks! > > Note: https://github.com/openjdk/jdk/pull/22844 needs to be integrated before this change. This pull request has now been integrated. Changeset: 05c37699 Author: Nizar Benalla URL: https://git.openjdk.org/jdk/commit/05c376998652c11c90dc4b0b9c7c40c4dab5b9d5 Stats: 3082 lines in 18 files changed: 3038 ins; 44 del; 0 mod 8337111: Bad HTML checker for generated documentation 8337113: Bad character checker for generated documentation 8337116: Internal links checker for generated documentation 8337114: DocType checker for generated documentation 8337117: External links checker for generated documentation Reviewed-by: prappo Backport-of: ed292318a98163b3226aa05d06825b48c3d97dbb ------------- PR: https://git.openjdk.org/jdk/pull/22866