Skip to content

Conversation

@hns
Copy link
Member

@hns hns commented Nov 11, 2022

Please review a patch to complete the conversion of the javadoc style sheet to use CSS custom properties for all colors and fonts.

A few notes for changes that may not be self-explanatory:

  • I renamed the --highlight property prefix used for the active navigation/menu/tab item to --selected as the term "highlight" is used for other things such as snippet highlights and active search item targets.
  • I unified the active color of copy-to-clipboard buttons to one single value even though they appear on different backgrounds. The value works reasonably well for all uses, and can be changed with a single custom property.
  • The stylesheet contains a rule for green line numbers in source pages created with the -linksource option. This is a very rarely used option so I chose to use a custom property with no defined value but a default value. This means the custom property is not contained in the list of custom property definitions in the style sheet, but it can be defined by a theme if needed.
  • I removed CSS selectors that are either illegal under HTML 5 such as a[name] or unused.

This change does not affect the appearance of the generated documentation in the browser. I can provide before/after output including different themes if needed.


Progress

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

Issue

  • JDK-8292594: Use CSS custom properties for all fonts and colors

Reviewers

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 11109

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

Using diff file

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

@hns hns changed the title Jdk 8292594 JDK-8292594: Use CSS custom properties for all fonts and colors Nov 11, 2022
@bridgekeeper
Copy link

bridgekeeper bot commented Nov 11, 2022

👋 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 openjdk bot added the rfr Pull request is ready for review label Nov 11, 2022
@openjdk
Copy link

openjdk bot commented Nov 11, 2022

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

  • javadoc

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

@openjdk openjdk bot added the javadoc javadoc-dev@openjdk.org label Nov 11, 2022
@mlbridge
Copy link

mlbridge bot commented Nov 11, 2022

Webrevs

Copy link
Contributor

@jonathan-gibbons jonathan-gibbons left a comment

Choose a reason for hiding this comment

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

It's really nice to see those hex constants disappearing from being spread out through the stylesheet.

@openjdk
Copy link

openjdk bot commented Nov 29, 2022

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

8292594: Use CSS custom properties for all fonts and colors

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

  • 05128c2: 8286185: The Java manpage can be more platform inclusive
  • d450314: 8297276: Remove thread text from Subject.current
  • cdf9ed0: 8297528: java/io/File/TempDirDoesNotExist.java test failing on windows-x64
  • 105d9d7: 8295351: java/lang/Float/Binary16Conversion.java fails with "Unexpected result of converting"
  • a80552e: 8236919: Refactor com.sun.tools.javac.main.CommandLine into a reusable module for other JDK tools
  • a249a52: 8296754: AutoCreateSharedArchive in JDK 20 is not compatible with JDK 19
  • 405b188: 8297570: jdk/jfr/threading/TestDeepVirtualStackTrace.java fails with -XX:-UseTLAB
  • ba0a252: 8297717: Remove jdk/internal/misc/TerminatingThreadLocal/TestTerminatingThreadLocal.java from ProblemList
  • c05dc80: 8297660: x86: Redundant test+jump in C1 allocateArray
  • eff4c03: 8297343: TestStress*.java fail with "got different traces for the same seed"
  • ... and 241 more: https://git.openjdk.org/jdk/compare/4a300818fe7a47932c5b762ccd3b948815a31974...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.

@openjdk openjdk bot added the ready Pull request is ready to be integrated label Nov 29, 2022
@hns
Copy link
Member Author

hns commented Nov 29, 2022

/integrate

@openjdk
Copy link

openjdk bot commented Nov 29, 2022

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

Your commit was automatically rebased without conflicts.

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

openjdk bot commented Nov 29, 2022

@hns Pushed as commit 361b50e.

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

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

integrated Pull request has been integrated javadoc javadoc-dev@openjdk.org

Development

Successfully merging this pull request may close these issues.

2 participants