JDK-8324774: Add DejaVu web fonts #17633

hns · 2024-01-30T16:13:42Z

This change adds the DejaVu web fonts that were previously maintained externally to the open repository so they are available both in JDK API documentation and any API documentation generated with the javadoc tool. All files added in this PR are the same as the ones previously maintained externally, with the exception of added license and name/version comments in dejavu.css.

Copying of font files to the generated documentation is done by looking for font file names in dejavu.css, so font file names can be changed without changing the code. However, the font file list is hard-coded in APITest.java. CheckLibraryVersions.java is updated to make sure the name and version in the legal file matches the one in the stylesheet. Of course I also performed manual tests to make sure the font and legal files are copied to the output tree and used correctly in browsers.

Once #17411 is integrated, dejavu.css should also be added to the list of files checked by the new "pass-through" test.

Progress

Change must not contain extraneous whitespace
Commit message must refer to an issue
Change must be properly reviewed (2 reviews required, with at least 1 Reviewer, 1 Author)
Change requires CSR request JDK-8326683 to be approved

Issues

JDK-8324774: Add DejaVu web fonts (Enhancement - P3)
JDK-8327385: Add JavaDoc option to exclude web fonts from generated documentation (Enhancement - P3)
JDK-8326683: Add JavaDoc option to exclude web fonts from generated documentation (CSR)

Reviewers

Magnus Ihse Bursie (@magicus - Reviewer) ⚠️ Review applies to 2c6e2163
Jonathan Gibbons (@jonathan-gibbons - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 17633

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

Using diff file

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

Webrev

Link to Webrev Comment

bridgekeeper · 2024-01-30T16:17:24Z

👋 Welcome back hannesw! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

openjdk · 2024-01-30T16:20:55Z

@hns The following labels will be automatically applied to this pull request:

build
javadoc

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

mlbridge · 2024-01-30T16:24:48Z

Webrevs

01: Full - Incremental (9f77de97)
00: Full (2c6e2163)

magicus

Build changes look trivially fine

openjdk · 2024-01-30T19:07:21Z

@hns This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

8324774: Add DejaVu web fonts
8327385: Add JavaDoc option to exclude web fonts from generated documentation

Reviewed-by: ihse, jjg

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 783 new commits pushed to the master branch:

8fc9097: 8315575: Retransform of record class with record component annotation fails with CFE
2725405: 8327991: Improve HttpClient documentation with regard to reclaiming resources
db01fcd: 8328827: Convert java/awt/print/PrinterJob/PrinterDialogsModalityTest/PrinterDialogsModalityTest.html applet test to main
89e0889: 8328858: More runtime/stack tests fail intermittently on libgraal
153410f: 8328930: [AIX] remove pase related coding
da8a095: 8328928: Serial: Use IsGCActiveMark instead of AutoModifyRestore in SerialHeap::do_collection
472fcb6: 8328508: Unify the signatures of the methods address_for_index() and index_for() in BOT implementations
cc1800f: 8327998: Enable java/lang/ProcessBuilder/JspawnhelperProtocol.java on Mac
b9c76de: 8329074: AIX build fails after JDK-8328824
7b1f2c8: 8327493: Update minimum Xcode version in docs
... and 773 more: https://git.openjdk.org/jdk/compare/3066d49cc1910bb9ed01558582fdeb2385c484c3...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

hns · 2024-01-31T16:23:33Z

/reviewers 2

openjdk · 2024-01-31T16:24:51Z

@hns
The total number of required reviews for this PR (including the jcheck configuration and the last /reviewers command) is now set to 2 (with at least 1 Reviewer, 1 Author).

jonathan-gibbons

Some suggestions.

I think there should be an option to opt-out of using these fonts.

jonathan-gibbons · 2024-02-20T19:07:22Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java

+        try {
+            // Extract font file names from CSS file
+            URL cssURL = HtmlConfiguration.class.getResource(DocPaths.RESOURCES.resolve(cssPath).getPath());
+            InputStream in = cssURL.openStream();


Put this in try-with-resources

jonathan-gibbons · 2024-02-20T19:09:19Z

src/jdk.javadoc/share/classes/jdk/javadoc/internal/doclets/formats/html/HtmlDoclet.java

+            try (in) {
+                try (BufferedReader reader = new BufferedReader(new InputStreamReader(in))) {
+                    String line;
+                    while ((line = reader.readLine()) != null) {


Consider using BufferedReader.lines

https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/BufferedReader.html#lines()

bridgekeeper · 2024-03-19T22:38:05Z

@hns This pull request has been inactive for more than 4 weeks and will be automatically closed if another 4 weeks passes without any activity. To avoid this, simply add a new comment to the pull request. Feel free to ask for assistance if you need help with progressing this pull request towards integration!

…ocumentation

hns · 2024-03-20T15:49:04Z

/issue add JDK-8327385

openjdk · 2024-03-20T15:49:56Z

@hns
Adding additional issue to issue list: 8327385: Add JavaDoc option to exclude web fonts from generated documentation.

jonathan-gibbons · 2024-03-27T00:43:57Z

I like the new stuff for JavadocTester wrapped up in this work.

hns · 2024-03-27T12:20:18Z

/integrate

openjdk · 2024-03-27T12:20:57Z

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

37a5a08: 8329102: Clean up jdk.jpackage native compilation
788d2bc: 8329169: Parallel: Remove unused local variable in MutableSpace::print_on
4dfcc6d: 8329115: Crash involving return from inner switch
9e566d7: 8327971: Multiple ASAN errors reported for metaspace
8fc9097: 8315575: Retransform of record class with record component annotation fails with CFE
2725405: 8327991: Improve HttpClient documentation with regard to reclaiming resources
db01fcd: 8328827: Convert java/awt/print/PrinterJob/PrinterDialogsModalityTest/PrinterDialogsModalityTest.html applet test to main
89e0889: 8328858: More runtime/stack tests fail intermittently on libgraal
153410f: 8328930: [AIX] remove pase related coding
da8a095: 8328928: Serial: Use IsGCActiveMark instead of AutoModifyRestore in SerialHeap::do_collection
... and 777 more: https://git.openjdk.org/jdk/compare/3066d49cc1910bb9ed01558582fdeb2385c484c3...master

Your commit was automatically rebased without conflicts.

openjdk · 2024-03-27T12:21:06Z

@hns Pushed as commit d0a2650.

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

hns added 2 commits January 29, 2024 13:40

JDK-8324774: Add DejaVu web fonts

5123b33

Add license comment

2c6e216

openjdk bot added the rfr Pull request is ready for review label Jan 30, 2024

openjdk bot added javadoc javadoc-dev@openjdk.org build build-dev@openjdk.org labels Jan 30, 2024

magicus approved these changes Jan 30, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Jan 30, 2024

openjdk bot removed the ready Pull request is ready to be integrated label Jan 31, 2024

jonathan-gibbons reviewed Feb 20, 2024

View reviewed changes

Merge try-with-resource statements

ba560ea

openjdk bot added the csr Pull request needs approved CSR before integration label Feb 26, 2024

JDK-8327385: Add JavaDoc option to exclude web fonts from generated d…

9f77de9

…ocumentation

openjdk bot removed the csr Pull request needs approved CSR before integration label Mar 20, 2024

jonathan-gibbons approved these changes Mar 27, 2024

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Mar 27, 2024

openjdk bot added the integrated Pull request has been integrated label Mar 27, 2024

openjdk bot closed this Mar 27, 2024

openjdk bot removed the ready Pull request is ready to be integrated label Mar 27, 2024

openjdk bot removed the rfr Pull request is ready for review label Mar 27, 2024

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

JDK-8324774: Add DejaVu web fonts #17633

JDK-8324774: Add DejaVu web fonts #17633

hns commented Jan 30, 2024 •

edited by openjdk bot

Loading

bridgekeeper bot commented Jan 30, 2024

openjdk bot commented Jan 30, 2024

mlbridge bot commented Jan 30, 2024 •

edited

Loading

magicus left a comment

openjdk bot commented Jan 30, 2024 •

edited

Loading

hns commented Jan 31, 2024

openjdk bot commented Jan 31, 2024

jonathan-gibbons left a comment

jonathan-gibbons Feb 20, 2024

jonathan-gibbons Feb 20, 2024

bridgekeeper bot commented Mar 19, 2024

hns commented Mar 20, 2024

openjdk bot commented Mar 20, 2024

jonathan-gibbons commented Mar 27, 2024

hns commented Mar 27, 2024

openjdk bot commented Mar 27, 2024

openjdk bot commented Mar 27, 2024

JDK-8324774: Add DejaVu web fonts #17633

JDK-8324774: Add DejaVu web fonts #17633

Conversation

hns commented Jan 30, 2024 • edited by openjdk bot Loading

Progress

Issues

Reviewers

Reviewing

Webrev

bridgekeeper bot commented Jan 30, 2024

openjdk bot commented Jan 30, 2024

mlbridge bot commented Jan 30, 2024 • edited Loading

Webrevs

magicus left a comment

Choose a reason for hiding this comment

openjdk bot commented Jan 30, 2024 • edited Loading

hns commented Jan 31, 2024

openjdk bot commented Jan 31, 2024

jonathan-gibbons left a comment

Choose a reason for hiding this comment

jonathan-gibbons Feb 20, 2024

Choose a reason for hiding this comment

jonathan-gibbons Feb 20, 2024

Choose a reason for hiding this comment

bridgekeeper bot commented Mar 19, 2024

hns commented Mar 20, 2024

openjdk bot commented Mar 20, 2024

jonathan-gibbons commented Mar 27, 2024

hns commented Mar 27, 2024

openjdk bot commented Mar 27, 2024

openjdk bot commented Mar 27, 2024

hns commented Jan 30, 2024 •

edited by openjdk bot

Loading

mlbridge bot commented Jan 30, 2024 •

edited

Loading

openjdk bot commented Jan 30, 2024 •

edited

Loading